开放平台
取消
开放平台
中文
EN
取消
  • 第三方平台 API

    • # 获取环境信息

    调试诊断

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

    接口英文名：getWxCloudBaseRunEnvs

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

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填说明
    access_tokenstring是接口调用凭证，可使用 component_access_token

    # 请求体 Request Payload

    无

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    env_listobjarray环境列表

    # Res.env_list(Array) Object Payload

    环境列表

    参数名类型说明
    env_idstring账户下该环境唯一标识
    sourcestring环境来源。包含以下取值：miniapp：微信小程序qcloud ：腾讯云
    aliasstring环境别名，要以 a-z 开头，不能包含 a-zA-z0-9- 以外的字符
    create_timestring创建时间
    update_timestring最后修改时间
    statusstring环境状态。包含以下取值：NORMAL：正常可用UNAVAILABLE：服务不可用，可能是尚未初始化或者初始化过程中
    databasesobjarray数据库列表
    storagesobjarray存储列表
    functionsobjarray函数列表
    package_idstringtcb产品套餐ID
    package_namestring套餐中文名称
    log_servicesobjarray云日志服务列表
    static_storagesobjarray静态资源信息
    is_auto_degradeboolean是否到期自动降为免费版
    env_channelstring环境渠道
    pay_modestring支付方式。包含以下取值： prepayment：预付费 postpaid：后付费
    is_defaultboolean是否为默认环境
    regionstring环境所属地域
    tagsobjarray环境标签列表
    custom_log_servicesobjarray自定义日志服务

    # Res.env_list(Array).databasesObject Payload

    数据库列表

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

    # Res.env_list(Array).storagesObject Payload

    存储列表

    参数名类型说明
    regionstring所属地域。当前支持ap-shanghai
    bucketstring桶名，存储资源的唯一标识
    cdn_domainstringcdn 域名
    app_idstring资源所属用户的腾讯云appId

    # Res.env_list(Array).functionsObject Payload

    函数列表

    参数名类型说明
    namespacestring命名空间
    regionstring所属地域。当前支持ap-shanghai

    # Res.env_list(Array).log_servicesObject Payload

    云日志服务列表

    参数名类型说明
    logset_namestringlog名
    logset_idstringlog-id
    topic_namestringtopic名
    topic_idstringtopic-id
    regionstringcls日志所属地域

    # Res.env_list(Array).static_storagesObject Payload

    静态资源信息

    参数名类型说明
    static_domainstring静态 CDN 域名
    default_dir_namestring静态 CDN 默认文件夹，当前为根目录
    statusstring资源状态(process/online/offline/init)
    regionstringcos所属区域
    bucketstringbucket信息

    # Res.env_list(Array).tagsObject Payload

    环境标签列表

    参数名类型说明
    keystring标签键
    valuestring标签值

    # Res.env_list(Array).custom_log_servicesObject Payload

    自定义日志服务

    参数名类型说明
    cls_regionstringcls所属地域
    cls_logset_idstringcls日志集ID
    cls_topic_idstringcls日志主题ID
    create_timestring创建时间

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    请求示例

    {}

    返回示例

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

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述解决方案
    -1000system error系统错误
    -1system error系统繁忙，此时请开发者稍候再试
    0okok
    40014invalid access_token不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口
    40097invalid args参数错误
    40101missing parameter缺少必填参数
    41001access_token missing缺少 access_token 参数
    42001access_token expiredaccess_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明
    43002require POST method需要 POST 请求
    44002empty post dataPOST 的数据包为空
    47001data format error解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。
    85088no qbase privilege该APP未开通云开发

    # 7. 适用范围

    本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。