调用ListChangeOrders接口获取变更单列表。

调试

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

请求头

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

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
AppId String Query 是 145341c-9708-4967-b3ec-24933767****

应用ID。
CurrentPage Integer Query 否 1

当前分页。
PageSize Integer Query 否 20

分页大小。
Key String Query 否 test

发布单描述信息模糊查询（包含这此key的都会返回）。

CoType String Query 否 CoCreateApp

变更单类型。取值说明如下：

  • CoBindSlb：绑定SLB。
  • CoUnbindSlb：解绑SLB。
  • CoCreateApp：创建应用。
  • CoDeleteApp：删除应用。
  • CoDeploy：部署应用。
  • CoRestartApplication：重启应用。
  • CoRollback：回滚应用。
  • CoScaleIn：应用缩容。
  • CoScaleOut：应用扩容。
  • CoStart：启动应用。
  • CoStop：停止应用。
  • CoRescaleApplicationVertically：修改实例规格。
  • CoDeployHistroy：回退历史版本。
  • CoBindNas：绑定NAS。
  • CoUnbindNas：解绑NAS。
  • CoBatchStartApplication：批量启动应用。
  • CoBatchStopApplication：批量停止应用。
  • CoRestartInstances：重启实例。
  • CoDeleteInstances：删除实例。
  • CoScaleInAppWithInstances：指定实例缩容。
CoStatus String Query 否 2

变更单状态。取值说明如下：

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

返回数据

名称 类型 示例值 描述
RequestId String 65E1F-43BA-4D0C-8E61-E4D1337F****

请求ID。
Message String success

调用结果的附加信息。
TraceId String 0bb6f815638568884597879d****

调用链ID，用于精确查询调用信息。
Data Object

变更单列表信息。
CurrentPage Integer 1

当前分页。
TotalSize Integer 1

变更单总数。
ChangeOrderList Array of ChangeOrder

变更单列表。
Status Integer 2

变更单状态。取值说明如下：

  • 0：准备。
  • 1：执行中。
  • 2：执行成功。
  • 3：执行失败。
  • 6：终止。
  • 8：等待手工确认分批。
  • 9：等待自动确认分批。
  • 10：系统异常执行失败。
  • 11：等待审批。
  • 12：审批通过，等待执行。
FinishTime String 2019-07-11 20:12:58

结束时间。
CreateTime String 2019-07-11 15:54:49

创建时间。
UserId String sae-beta-test

用户ID。
Source String console

变更单操作入口来源。
BatchCount Integer 1

分批数。
CreateUserId String sae-beta-test

创建用户ID。
CoTypeCode String CoCreateApp

变更类型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：指定实例缩容。
ChangeOrderId String 7fa5c0-9ebb-4bb4-b383-1f885447****

变更单ID。
BatchType String auto

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

  • auto：自动。
  • manual：手动。
GroupId String c9ecd2-cf6c-46c3-9f20-525de202****

分组ID。
Description String 版本：1.0 | 镜像名称：nginx

描述信息。
CoType String 创建应用

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

AppId String 164341c-9708-4967-b3ec-24933767****

应用ID。
PageSize Integer 20

分页大小。
ErrorCode String 空

错误码。取值说明如下：

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

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

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

获取变更单列表是否成功。取值说明如下：

  • true：获取成功。
  • false：获取失败。

示例

请求示例

GET /pop/v1/sam/changeorder/ListChangeOrders?AppId=145341c-9708-4967-b3ec-24933767****&CurrentPage=1&PageSize=20&Key=test&CoType=CoCreateApp&CoStatus=2 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式 

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

<ListChangeOrdersResponse>
    <RequestId>65E1F-43BA-4D0C-8E61-E4D1337F****</RequestId>
    <Message>success</Message>
    <TraceId>0bb6f815638568884597879d****</TraceId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <TotalSize>1</TotalSize>
        <ChangeOrderList>
            <Status>2</Status>
            <FinishTime>2019-07-11 20:12:58</FinishTime>
            <CreateTime>2019-07-11 15:54:49</CreateTime>
            <UserId>sae-beta-test</UserId>
            <Source>console</Source>
            <BatchCount>1</BatchCount>
            <CreateUserId>sae-beta-test</CreateUserId>
            <CoTypeCode>CoCreateApp</CoTypeCode>
            <ChangeOrderId>7fa5c0-9ebb-4bb4-b383-1f885447****</ChangeOrderId>
            <BatchType>auto</BatchType>
            <GroupId>c9ecd2-cf6c-46c3-9f20-525de202****</GroupId>
            <Description>版本：1.0 | 镜像名称：nginx</Description>
            <CoType>创建应用</CoType>
            <AppId>164341c-9708-4967-b3ec-24933767****</AppId>
        </ChangeOrderList>
        <PageSize>20</PageSize>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</ListChangeOrdersResponse>

JSON格式 

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

{
  "RequestId" : "65E1F-43BA-4D0C-8E61-E4D1337F****",
  "Message" : "success",
  "TraceId" : "0bb6f815638568884597879d****",
  "Data" : {
    "CurrentPage" : 1,
    "TotalSize" : 1,
    "ChangeOrderList" : [ {
      "Status" : 2,
      "FinishTime" : "2019-07-11 20:12:58",
      "CreateTime" : "2019-07-11 15:54:49",
      "UserId" : "sae-beta-test",
      "Source" : "console",
      "BatchCount" : 1,
      "CreateUserId" : "sae-beta-test",
      "CoTypeCode" : "CoCreateApp",
      "ChangeOrderId" : "7fa5c0-9ebb-4bb4-b383-1f885447****",
      "BatchType" : "auto",
      "GroupId" : "c9ecd2-cf6c-46c3-9f20-525de202****",
      "Description" : "版本：1.0 | 镜像名称：nginx",
      "CoType" : "创建应用",
      "AppId" : "164341c-9708-4967-b3ec-24933767****"
    } ],
    "PageSize" : 20
  },
  "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. 没有权限操作资源。
404 InvalidAppId.NotFound The specified AppId does not exist. 指定的AppId不存在。

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