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

调试

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

请求头

该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
ChangeOrderId String Query 76fa5c0-9ebb-4bb4-b383-1f885447****

变更单ID。通过调用ListChangeOrders接口获取。

返回数据

名称 类型 示例值 描述
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

请求ID。

Message String success

调用结果的附加信息。

TraceId String 0a98a02315955564772843261e****

调用链ID,用于精确查询调用信息。

Data Object

变更单信息。

Status Integer 2

批次状态。取值说明如下:

  • 0:准备。
  • 1:执行中。
  • 2:执行成功。
  • 3:执行失败。
  • 6:终止。
  • 8:等待手工确认分批。
  • 9:等待自动确认分批。
  • 10:系统异常执行失败。
  • 11:等待审批。
  • 12:审批通过,等待执行。
SubStatus Integer 0

发布单子状态,用于判断发布单是否在发布过程中存在异常。取值说明如下:

  • 0:发布正常。
  • 1:发布异常。例如分批发布时出错,需要您手动回滚,此时发布单虽然出错,但因不能完结而依然处于执行中。
ApprovalId String 67de0b39-a9d4-4c09-a170-cf438208****

操作审批ID。

ErrorMessage String success

错误信息。

BatchWaitTime Integer 0

自动分批方式时,开始下一批次前的等待时间。单位:分钟。

CreateTime String 2020-12-17 21:06:45

创建时间。

BatchCount Integer 1

分批数。

CoTypeCode String CoRestartInstances

变更类型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:指定实例缩容。
SupportRollback Boolean false

是否支持回滚。取值说明如下:

  • true:支持回滚。
  • false:不支持回滚。
ChangeOrderId String 765fa5c0-9ebb-4bb4-b383-1f885447**

变更单ID。

AppName String app-test

应用名称。

BatchType String auto

分批类型。取值说明如下:

  • auto:自动。
  • manual:手动。
Description String description

变更单描述信息。

CoType String 批量重启实例

变更类型,是对CoTypeCode的描述。

Auto Boolean true

是否为自动分批。取值说明如下:

  • true:自动分批变更。
  • false:不是自动分批变更。
CurrentPipelineId String 0e4acf82-c9b1-4c1e-ac28-55776338****

当前批次ID。

Pipelines Array of Pipeline

批次信息。

Status Integer 2

批次状态。取值说明如下:

  • 0:准备。
  • 1:执行中。
  • 2:执行成功。
  • 3:执行失败。
  • 6:终止。
  • 8:等待手工确认分批。
  • 9:等待自动确认分批。
  • 10:系统异常执行失败。
  • 11:等待审批。
  • 12:审批通过,等待执行。
StartTime Long 1562831689704

开始时间。

UpdateTime Long 1562847178007

最近更新时间。

BatchType Integer 0

分批类型。

ParallelCount Integer 0

分批内并行任务数。

PipelineName String Batch 1 Change

批次名称。

PipelineId String 0e4acf82-c9b1-4c1e-ac28-55776338****

批次ID。

AppId String bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****

应用ID。

ErrorCode String

错误码。取值说明如下:

  • 请求成功:不返回ErrorCode字段。
  • 请求失败:返回ErrorCode字段。具体信息,请参见本文的错误码列表。
Code String 200

接口状态或POP错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
Success Boolean true

是否成功查询变更单信息。取值说明如下:

  • true:查询成功。
  • false:查询失败。

示例

请求示例

GET /pop/v1/sam/changeorder/DescribeChangeOrder?ChangeOrderId=76fa5c0-9ebb-4bb4-b383-1f885447**** HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "批量重启实例",
    "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-*****"
  },
  "Code" : "200",
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
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不存在。

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