调用DescribeChangeOrder接口查询变更单信息-Serverless 应用引擎-阿里云-Serverless 应用引擎(SAE)-阿里云帮助中心

调用DescribeChangeOrder接口查询变更单信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sae:DescribeChangeOrder

get

*全部资源

*

无

请求语法

GET /pop/v1/sam/changeorder/DescribeChangeOrder HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ChangeOrderId	string	是	变更单 ID。通过调用 ListChangeOrders 接口获取。	76fa5c0-9ebb-4bb4-b383-1f885447****

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	调用结果的附加信息。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	0a98a02315955564772843261e****
Data	object	变更单信息。
Status	integer	批次状态。取值说明如下： 0：准备。 1：执行中。 2：执行成功。 3：执行失败。 6：终止。 8：等待手工确认分批。 9：等待自动确认分批。 10：系统异常执行失败。 11：等待审批。 12：审批通过，等待执行。	2
SubStatus	integer	发布单子状态，用于判断发布单是否在发布过程中存在异常。取值说明如下： 0：发布正常。 1：发布异常。例如分批发布时出错，需要您手动回滚，此时发布单虽然出错，但因不能完结而依然处于执行中。	0
ApprovalId	string	操作审批 ID。	67de0b39-a9d4-4c09-a170-cf438208****
ErrorMessage	string	错误信息。	success
BatchWaitTime	integer	自动分批方式时，开始下一批次前的等待时间。单位：分钟。	0
CreateTime	string	创建时间。	2020-12-17 21:06:45
BatchCount	integer	分批数。	1
CoTypeCode	string	变更类型 Code。取值说明如下： CoBindSlb：绑定 SLB。 CoUnbindSlb：解绑 SLB。 CoCreateApp：创建应用。 CoDeleteApp：删除应用。 CoDeploy：部署应用。 CoRestartApplication：重启应用。 CoRollback：回滚应用。 CoScaleIn：应用缩容。 CoScaleOut：应用扩容。 CoStart：启动应用。 CoStop：停止应用。 CoRescaleApplicationVertically：修改实例规格。 CoDeployHistroy：回退历史版本。 CoBindNas：绑定 NAS。 CoUnbindNas：解绑 NAS。 CoBatchStartApplication：批量启动应用。 CoBatchStopApplication：批量停止应用。 CoRestartInstances：重启实例。 CoDeleteInstances：删除实例。 CoScaleInAppWithInstances：指定实例缩容。	CoRestartInstances
SupportRollback	boolean	是否支持回滚。取值说明如下： true：支持回滚。 false：不支持回滚。	false
ChangeOrderId	string	变更单 ID。	765fa5c0-9ebb-4bb4-b383-1f885447**
AppName	string	应用名称。	app-test
BatchType	string	分批类型。取值说明如下： auto：自动。 manual：手动。	auto
Description	string	变更单描述信息。	description
CoType	string	变更类型，是对 CoTypeCode 的描述。	Batch Restart Instances
Auto	boolean	是否为自动分批。取值说明如下： true：自动分批变更。 false：不是自动分批变更。	true
CurrentPipelineId	string	当前批次 ID。	0e4acf82-c9b1-4c1e-ac28-55776338****
Pipelines	array<object>	批次信息。
	object	批次信息。
Status	integer	批次状态。取值说明如下： 0：准备。 1：执行中。 2：执行成功。 3：执行失败。 6：终止。 8：等待手工确认分批。 9：等待自动确认分批。 10：系统异常执行失败。 11：等待审批。 12：审批通过，等待执行。	2
StartTime	integer	开始时间。	1562831689704
UpdateTime	integer	最近更新时间。	1562847178007
BatchType	integer	分批类型。	0
ParallelCount	integer	分批内并行任务数。	0
PipelineName	string	批次名称。	Batch 1 Change
PipelineId	string	批次 ID。	0e4acf82-c9b1-4c1e-ac28-55776338****
AppId	string	应用 ID。	bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****
ApplicationUpdateStrategy	string	应用更新策略。
ApplicationEnableGreyTagRoute	boolean	是否启用灰度标签路由。
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	是否成功查询变更单信息。取值说明如下： true：查询成功。 false：查询失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Status": 2,
    "SubStatus": 0,
    "ApprovalId": "67de0b39-a9d4-4c09-a170-cf438208****",
    "ErrorMessage": "success",
    "BatchWaitTime": 0,
    "CreateTime": "2020-12-17 21:06:45",
    "BatchCount": 1,
    "CoTypeCode": "CoRestartInstances",
    "SupportRollback": false,
    "ChangeOrderId": "765fa5c0-9ebb-4bb4-b383-1f885447**",
    "AppName": "app-test",
    "BatchType": "auto",
    "Description": "description",
    "CoType": "Batch Restart Instances",
    "Auto": true,
    "CurrentPipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****",
    "Pipelines": [
      {
        "Status": 2,
        "StartTime": 1562831689704,
        "UpdateTime": 1562847178007,
        "BatchType": 0,
        "ParallelCount": 0,
        "PipelineName": "Batch 1 Change",
        "PipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****"
      }
    ],
    "AppId": "bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****",
    "ApplicationUpdateStrategy": "",
    "ApplicationEnableGreyTagRoute": true
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的参数：%s不能为空。
400	Resouce.no.permission	You are not authorized to operate on the specified resources.	没有权限操作资源。
400	InvalidChangeOrder.NotFound	The current change order does not exist.	变更单不存在。
404	InvalidAppId.NotFound	The specified AppId does not exist.	指定的AppId不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。