# 获取环境信息

调试工具

接口应在服务器端调用，详细说明参见服务端API。

# 接口说明

# 接口英文名

getWxCloudBaseRunEnvs

# 功能描述

通过本接口可以查询微信云托管环境信息，使用过程中如遇到问题，可在开放平台服务商专区发帖交流。

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/componenttcb/describecloudbaserunenvs?access_token=ACCESS_TOKEN

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用component_access_token

# 返回参数

属性

类型

说明

errcode

number

错误码

errmsg

string

错误信息

env_list

array<object>

环境列表

属性

类型

说明

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<object>

数据库列表

属性	类型	说明
instance_id	string	数据库唯一标识
status	string	状态。包含以下取值：INITIALIZING：资源初始化中RUNNING：运行中，可正常使用的状态UNUSABLE：禁用，不可用OVERDUE：资源过期
region	string	所属地域。当前支持ap-shanghai

storages

array<object>

存储列表

属性	类型	说明
region	string	所属地域。当前支持ap-shanghai
bucket	string	桶名，存储资源的唯一标识
cdn_domain	string	cdn 域名
app_id	string	资源所属用户的腾讯云appId

functions

array<object>

函数列表

	属性	类型	说明
	namespace	string	命名空间
	region	string	所属地域。当前支持ap-shanghai

package_id

string

tcb产品套餐ID

package_name

string

套餐中文名称

log_services

array<object>

云日志服务列表

属性	类型	说明
logset_name	string	log名
logset_id	string	log-id
topic_name	string	topic名
topic_id	string	topic-id
region	string	cls日志所属地域

static_storages

array<object>

静态资源信息

属性	类型	说明
static_domain	string	静态 CDN 域名
default_dir_name	string	静态 CDN 默认文件夹，当前为根目录
status	string	资源状态(process/online/offline/init)
region	string	cos所属区域
bucket	string	bucket信息

is_auto_degrade

boolean

是否到期自动降为免费版

env_channel

string

环境渠道

pay_mode

string

支付方式。包含以下取值： prepayment：预付费 postpaid：后付费

is_default

boolean

是否为默认环境

region

string

环境所属地域

# 调用示例

示例说明: HTTPS请求

# 请求数据示例

{
}

# 返回数据示例


{
    "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": []
        }
    ]
}

# 错误码

错误码	错误码取值	解决方案
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未开通云开发