调用ListNamespaceChangeOrders接口获取命名空间发布单列表。

调试

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

请求头

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

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
NamespaceId String Query cn-shanghai:test

命名空间ID。

CoStatus String Query 2

发布单状态。取值说明如下:

  • 0:准备。
  • 1:执行中。
  • 2:执行成功。
  • 3:执行失败。
  • 6:终止。
  • 10:系统异常执行失败。
CoType String Query CoBatchStartApplication

发布单类型。取值说明如下:

  • CoBatchStartApplication:批量启动应用。
  • CoBatchStopApplication:批量停止应用。
Key String Query test

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

CurrentPage Integer Query 1

当前页。

PageSize Integer Query 20

分页大小。

返回数据

名称 类型 示例值 描述
RequestId String 0bc3915638507554994370d****

请求ID。

ErrorCode String

错误码。取值说明如下:

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

获取发布单列表是否成功。取值说明如下:

  • true:获取成功。
  • false:获取失败。
Code String 200

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

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
Message String success

调用结果的附加信息。

TraceId String 0bc3915638507554994370d****

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

Data Object

返回结果。

CurrentPage Integer 1

当前分页。

PageSize Integer 20

分页大小。

TotalSize Integer 32

变更单总数。

ChangeOrderList Array of ChangeOrder

发布单列表。

Status Integer 2

发布单状态。取值说明如下:

  • 0:准备。
  • 1:执行中。
  • 2:执行成功。
  • 3:执行失败。
  • 6:终止。
  • 10:系统异常执行失败。
FinishTime String 2019-07-11 20:12:58

结束时间。

NamespaceId String cn-shanghai:test

命名空间ID。

CreateTime String 2019-07-11 15:54:49

创建时间。

UserId String test_sae

用户ID。

Source String console

变更单操作入口来源。

CreateUserId String test@aliyun.com

创建用户ID。

BatchCount Integer 1

分批数。

CoTypeCode String CoBatchStartApplication

发布单类型Code。取值说明如下:

  • CoBatchStartApplication:批量启动应用。
  • CoBatchStopApplication:批量停止应用。
ChangeOrderId String 7fa5c0-9ebb-4bb4-b383-1f885447****

发布单ID。

BatchType String 自动

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

  • 自动:分批间处理方式为自动。
  • 手动:分批间处理方式为手动。
Description String 批量启动应用

发布单描述信息。

GroupId String c9ecd2-cf6c-46c3-9f20-525de202****

分组ID。

CoType String msg.docker.app.actions.CoBatchStartApplication

发布单类型,是对CoTypeCode的描述。

Pipelines String xxxx

变更流水线。

示例

请求示例

GET /pop/v1/sam/changeorder/listNamespaceChangeOrders?NamespaceId=cn-shanghai:test&CoStatus=2&CoType=CoBatchStartApplication&Key=test&CurrentPage=20&PageSize=1 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

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

<ListNamespaceChangeOrdersResponse>
    <RequestId>0bc3915638507554994370d****</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <Message>success</Message>
    <TraceId>0bc3915638507554994370d****</TraceId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <PageSize>20</PageSize>
        <TotalSize>32</TotalSize>
        <ChangeOrderList>
            <Status>2</Status>
            <FinishTime>2019-07-11 20:12:58</FinishTime>
            <NamespaceId>cn-shanghai:test</NamespaceId>
            <CreateTime>2019-07-11 15:54:49</CreateTime>
            <UserId>test_sae</UserId>
            <Source>console</Source>
            <CreateUserId>test@aliyun.com</CreateUserId>
            <BatchCount>1</BatchCount>
            <CoTypeCode>CoBatchStartApplication</CoTypeCode>
            <ChangeOrderId>7fa5c0-9ebb-4bb4-b383-1f885447****</ChangeOrderId>
            <BatchType>自动</BatchType>
            <Description>批量启动应用</Description>
            <GroupId>c9ecd2-cf6c-46c3-9f20-525de202****</GroupId>
            <CoType>msg.docker.app.actions.CoBatchStartApplication</CoType>
            <Pipelines>xxxx</Pipelines>
        </ChangeOrderList>
    </Data>
</ListNamespaceChangeOrdersResponse>

JSON格式

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

{
  "RequestId" : "0bc3915638507554994370d****",
  "Success" : true,
  "Code" : "200",
  "Message" : "success",
  "TraceId" : "0bc3915638507554994370d****",
  "Data" : {
    "CurrentPage" : 1,
    "PageSize" : 20,
    "TotalSize" : 32,
    "ChangeOrderList" : [ {
      "Status" : 2,
      "FinishTime" : "2019-07-11 20:12:58",
      "NamespaceId" : "cn-shanghai:test",
      "CreateTime" : "2019-07-11 15:54:49",
      "UserId" : "test_sae",
      "Source" : "console",
      "CreateUserId" : "test@aliyun.com",
      "BatchCount" : 1,
      "CoTypeCode" : "CoBatchStartApplication",
      "ChangeOrderId" : "7fa5c0-9ebb-4bb4-b383-1f885447****",
      "BatchType" : "自动",
      "Description" : "批量启动应用",
      "GroupId" : "c9ecd2-cf6c-46c3-9f20-525de202****",
      "CoType" : "msg.docker.app.actions.CoBatchStartApplication",
      "Pipelines" : "xxxx"
    } ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 Resouce.no.permission You are not authorized to operate on the specified resources. 没有权限操作资源。
400 InvalidParameter.NotEmpty You must specify the parameter %s. 不合法的参数:%s不能为空。

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