# 环境共享

调试诊断

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

接口英文名:shareCloudbaseEnv

通过本接口可以将环境共享给小程序(也称将小程序与环境绑定),使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

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

# 请求体 Request Payload

参数名类型必填说明
dataobjarray共享信息
source_typenumber请求环境源,填 1,表示云托管环境

# Body.data(Array) Object Payload

共享信息

参数名类型必填说明
envstring环境ID
appidsarrayappid列表

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber返回码
errmsgstring错误信息
err_listobjarray错误信息
msg_info_listobjarray确认信息

# Res.err_list(Array) Object Payload

错误信息

参数名类型说明
envstring环境ID
appidstringappid
errmsgstring错误信息

# Res.msg_info_list(Array) Object Payload

确认信息

参数名类型说明
appidstringappid
urlstring确认信息 url

# 4. 注意事项

  • 在调用该接口之前,小程序需将权限集id为 18 的「开发与数据分析」权限集授权给服务商

# 其他说明

服务商需将 msg_info_list 中的确认链接发送给小程序管理员,经小程序管理员确认允许绑定后,绑定正式生效。

# 5. 代码示例

请求示例

{
  "data": [
    {
      "env": "test-env-6gni9ity244a6ea3",
      "appids": [
        "wx5fe6bb43205e9e07",
        "wx075cf85bf347b6df"
      ]
    }
  ]
}

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "err_list": [
    {
      "env": "mytestenv-7gfwxe92efb3aa38",
      "appid": "wx5fe6bb43205e9e7",
      "errmsg": "invalid appid"
    }
  ]
}

# 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. 适用范围

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