# 查询微信云托管环境信息
通过本接口可以查询微信云托管环境信息,使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 请求地址
POST https://api.weixin.qq.com/componenttcb/describecloudbaserunenvs?access_token=ACCESS_TOKEN
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 第三方接口调用令牌component_access_token |
# 返回值
# Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
env_list | Array.<EnvInfo> | env列表 |
errcode 的合法值
值 | 说明 |
---|---|
0 | 请求成功 |
-1 | 系统错误 |
-1000 | 系统错误 |
40014 | AccessToken 不合法 |
40097 | 请求参数错误 |
40101 | 缺少必填参数 |
41001 | 缺少AccessToken |
42001 | AccessToken过期 |
43002 | HTTP METHOD 错误 |
44002 | POST BODY 为空 |
47001 | POST BODY 格式错误 |
85088 | 该APP未开通云开发 |
其他错误码 | 云开发错误码 |
EnvInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
env_id | string | 账户下该环境唯一标识 |
source | string | 环境来源。包含以下取值:miniapp:微信小程序qcloud :腾讯云 |
alias | string | 环境别名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符 |
create_time | string | 创建时间 |
update_time | string | 最后修改时间 |
status | string | 环境状态。包含以下取值:NORMAL:正常可用UNAVAILABLE:服务不可用,可能是尚未初始化或者初始化过程中 |
databases | Array.<DatabasesInfo> | 数据库列表 |
storages | Array.<StorageInfo> | 存储列表 |
functions | Array.<FunctionInfo> | 函数列表 |
package_id | string | tcb产品套餐ID,参考DescribePackages接口的返回值。 |
package_name | string | 套餐中文名称,参考DescribePackages接口的返回值。 |
log_services | Array.<LogServiceInfo> | 云日志服务列表 |
static_storages | Array.<StaticStorageInfo> | 静态资源信息 |
is_auto_degrade | bool | 是否到期自动降为免费版 |
env_channel | string | 环境渠道 |
pay_mode | string | 支付方式。包含以下取值: prepayment:预付费 postpaid:后付费 |
is_default | bool | 是否为默认环境 |
region | string | 环境所属地域 |
tags | Array.<Tag> | 环境标签列表 |
custom_log_services | Array.<ClsInfo> | 自定义日志服务 |
DatabasesInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
instance_id | string | 数据库唯一标识 |
status | string | 状态。包含以下取值:INITIALIZING:资源初始化中RUNNING:运行中,可正常使用的状态UNUSABLE:禁用,不可用OVERDUE:资源过期 |
region | string | 所属地域。当前支持ap-shanghai |
StorageInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
region | string | 资源所属地域。当前支持ap-shanghai |
bucket | string | 桶名,存储资源的唯一标识 |
cdn_domain | string | cdn 域名 |
app_id | string | 资源所属用户的腾讯云appId |
FunctionInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
namespace | string | 命名空间 |
region | string | 所属地域。当前支持ap-shanghai |
LogServiceInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
logset_name | string | log名 |
logset_id | string | log-id |
topic_name | string | topic名 |
topic_id | string | topic-id |
region | string | cls日志所属地域 |
StaticStorageInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
static_domain | string | 静态CDN域名 |
default_dir_name | string | 静态CDN默认文件夹,当前为根目录 |
status | string | 资源状态(process/online/offline/init) |
region | string | cos所属区域 |
bucket | string | bucket信息 |
Tag 的结构
属性 | 类型 | 说明 |
---|---|---|
key | string | 标签键 |
value | string | 标签值 |
ClsInfo 的结构
属性 | 类型 | 说明 |
---|---|---|
cls_region | string | cls所属地域 |
cls_logset_id | string | cls日志集ID |
cls_topic_id | string | cls日志主题ID |
create_time | string | 创建时间 |
# 请求数据示例
{}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"env_list": [
{
"env_id": "wxc47dec912cf1b447-qd-5a17787412",
"source": "miniapp",
"alias": "wxc47dec912cf1b447-qd",
"create_time": "2021-12-16 15:06:52",
"update_time": "2021-12-16 15:06:58",
"status": "NORMAL",
"databases": [],
"storages": [
{
"region": "ap-shanghai",
"bucket": "7778-wxc47dec912cf1b447-qd-5a17787412-1308820263",
"cdn_domain": "7778-wxc47dec912cf1b447-qd-5a17787412-1308820263.tcb.qcloud.la",
"app_id": "1308820263"
}
],
"functions": [],
"package_id": "",
"package_name": "",
"log_services": [
{
"logset_name": "tcb-logset-wxc47dec912cf1b447-qd-5a17787412",
"logset_id": "af0676b8-4c88-445f-90b4-3ba6cd93a74a",
"topic_name": "tcb-topic-wxc47dec912cf1b447-qd-5a17787412",
"topic_id": "6cffd67f-5700-4238-8523-bba514e2b2bf",
"region": "ap-shanghai"
}
],
"static_storages": [],
"is_auto_degrade": false,
"env_channel": "wxrun",
"pay_mode": "postpaid",
"is_default": true,
"region": "ap-shanghai",
"tags": [],
"custom_log_services": []
}
]
}