# 获取云环境信息
通过本接口可以获取已有的云环境信息。使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 请求地址
POST https://api.weixin.qq.com/tcb/getenvinfo?access_token=ACCESS_TOKEN
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | String | 是 | 第三方平台接口调用令牌authorizer_access_token | |
env | string | 否 | 环境id,如果传了这个参数则只返回该环境的相关信息 |
# POST 数据示例
{
"env":"test-env-0001",
}
# 返回值
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
info_list | Array of EnvInfo | 环境信息 |
EnvInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
env | string | 环境ID |
alias | string | 环境别名 |
create_time | string | 开通时间 |
update_time | string | 最后修改时间 |
status | string | 环境状态 |
package_id | string | 产品套餐ID |
package_name | string | 产品套餐中文名 |
status 的合法值
值 | 说明 | 最低版本 |
---|---|---|
NORMAL | 正常可用 | |
HALTED | 停服,用量超限或后台封禁 | |
UNAVAILABLE | 服务不可用,可能是尚未初始化或者初始化过程中 |
errcode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
0 | 请求成功 | |
-1 | 系统错误 | |
-1000 | 系统错误 | |
40014 | AccessToken 不合法 | |
40101 | 缺少必填参数 | |
41001 | 缺少AccessToken | |
42001 | AccessToken过期 | |
43002 | HTTP METHOD 错误 | |
其他错误码 | 云开发错误码 |
# 示例代码
curl -d '{}' \
'https://api.weixin.qq.com/tcb/getenvinfo?access_token=ACCESS_TOKEN'
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"info_list": [
{
"env": "test2-4a89da",
"alias": "test2",
"create_time": "2019-04-04 14:10:28",
"update_time": "2019-04-04 14:10:36",
"status": "NORMAL",
"package_id": "basic",
"package_name": "基础版 1"
}]
}