operationGrayReleasePlan.md

运维中心 /getGrayReleasePlan

operation.getGrayReleasePlan

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

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

查询当前分阶段发布详情

调用方式：

• HTTPS 调用
• 云调用

HTTPS 调用

请求地址

GET https://api.weixin.qq.com/wxa/getgrayreleaseplan?access_token=ACCESS_TOKEN

请求参数

属性	类型	默认值	必填	说明
access_token / cloudbase_access_token	string		是	接口调用凭证

返回值

Object

属性	类型	说明
errcode	number	错误码
errmsg	number	错误信息
gray_release_plan	Object	分阶段发布计划详情

errcode 的合法值

值	说明	最低版本
0	成功
-1	系统失败
其他错误码	请查看全局错误码

gray_release_plan 的结构

属性	类型	说明
status	number	0:初始状态 1:执行中 2:暂停中 3:执行完毕 4:被删除
create_timestamp	number	分阶段发布计划的创建事件
gray_percentage	number	当前的灰度比例
default_finish_timestamp	number	预计全量时间

该接口用于查询当前分阶段发布详情。

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "gray_release_plan": {
     "status": 1,
     "create_timestamp": 1517553721,
     "default_finish_timestamp": 1517554721,
     "gray_percentage": 8
  }
}

云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。

接口方法

openapi.operation.getGrayReleasePlan

需在 config.json 中配置 operation.getGrayReleasePlan API 的权限，详情

返回值

Object

属性	类型	说明
errCode	number	错误码
errMsg	number	错误信息
grayReleasePlan	Object	分阶段发布计划详情

errCode 的合法值

值	说明	最低版本
0	成功

grayReleasePlan 的结构

属性	类型	说明
status	number	0:初始状态 1:执行中 2:暂停中 3:执行完毕 4:被删除
createTimestamp	number	分阶段发布计划的创建事件
grayPercentage	number	当前的灰度比例
defaultFinishTimestamp	number	预计全量时间

异常

Object

抛出的异常

属性	类型	说明
errCode	number	错误码
errMsg	number	错误信息

errCode 的合法值

值	说明	最低版本
-1	系统失败
其他错误码	请查看全局错误码

请求示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.operation.getGrayReleasePlan({})
    return result
  } catch (err) {
    return err
  }
}

返回示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.operation.getGrayReleasePlan({
        "errcode": 0,
        "errmsg": 'ok',
        "grayReleasePlan": {
          "status": 1,
          "createTimestamp": 1517553721,
          "defaultFinishTimestamp": 1517554721,
          "grayPercentage": 8
        }
      })
    return result
  } catch (err) {
    return err
  }
}