创建微信云托管

最近更新时间:2024-03-12 01:49:49

我的收藏

1. 接口描述

接口请求域名: tcb.tencentcloudapi.com 。

创建微信云托管

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateWxCloudBaseRunEnv。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
WxAppId String wx应用Id
示例值:wxappid
Alias String 环境别名,要以a-z开头,不能包含 a-z,0-9,- 以外的字符
示例值:env-alias
FreeQuota String 用户享有的免费额度级别,目前只能为“basic”,不传该字段或该字段为空,标识不享受免费额度。
Flag String 订单标记。建议使用方统一转大小写之后再判断。
QuickStart:快速启动来源
Activity:活动来源
VpcId String 私有网络Id
SubNetIds.N Array of String 子网列表
IsOpenCloudInvoke Boolean 是否打开云调用
示例值:true
Source String 创建来源:wechat | cloud
示例值:wechat
Channel String 渠道:wechat | cloud
示例值:wechat

3. 输出参数

参数名称 类型 描述
EnvId String 环境Id
TranId String 后付费订单号
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 CreateWxCloudBaseRunEnv

创建云托管环境

输入示例

POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWxCloudBaseRunEnv
<公共请求参数>

{
    "WxAppId": "xx"
}

输出示例

{
    "Response": {
        "EnvId": "xx",
        "TranId": "xx",
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.SystemFail 系统失败。
InternalError.Timeout 服务超时。
InvalidParameter 参数错误。
InvalidParameter.Action 接口名非法。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
MissingParameter.Param 缺少必要参数。
UnknownParameter 未知参数错误。