# 创建环境
接口应在服务器端调用,详细说明参见服务端API。
# 接口说明
# 接口英文名
createTcbEnv
# 功能描述
通过本接口可以创建环境,使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/componenttcb/createenv?access_token=ACCESS_TOKEN
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用component_access_token |
alias | string | 是 | 环境别名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符 |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 返回码 |
errmsg | string | 错误信息 |
tranid | string | 后付费订单号 |
env | string | 环境ID |
# 其他说明
- 说明:请求成功返回后,必须先手动调用“getTcbEnvList获取环境信息接口”进行初始化操作,并确认新环境的 status 为NORMAL后,才可以对环境进行创建集合、插入数据等操作。
# 调用示例
示例说明: HTTPS请求
# 请求数据示例
{
"alias": "mytestenv"
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"tranid": "20201030189770",
"env": "mytestenv-7gfwxe92efb3aa38"
}
# 错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
0 | ok | ok |
-1 | system error | 系统繁忙,此时请开发者稍候再试 |
-1000 | system error | 系统错误 |
40014 | invalid access_token | 不合法的 access_token ,请开发者认真比对 access_token 的有效性(如是否过期),或查看是否正在为恰当的公众号调用接口 |
40097 | invalid args | 参数错误 |
40101 | missing parameter | 缺少必填参数 |
41001 | access_token missing | 缺少 access_token 参数 |
42001 | access_token expired | access_token 超时,请检查 access_token 的有效期,请参考基础支持 - 获取 access_token 中,对 access_token 的详细机制说明 |
43002 | require POST method | 需要 POST 请求 |
44002 | empty post data | POST 的数据包为空 |
47001 | data format error | 解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。 |
85088 | no qbase privilege | 该APP未开通云开发 |