ListChangeOrders - 获取变更单列表

获取变更单列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:ListChangeOrdersget
  • 全部资源
    *

请求语法

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

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。

145341c-9708-4967-b3ec-24933767****
CurrentPageinteger

当前分页。

1
PageSizeinteger

分页大小。

20
Keystring

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

test
CoTypestring

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

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

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

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

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

65E1F-43BA-4D0C-8E61-E4D1337F****
Messagestring

调用结果的附加信息。

success
TraceIdstring

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

0bb6f815638568884597879d****
Dataobject

变更单列表信息。

CurrentPageinteger

当前分页。

1
TotalSizeinteger

变更单总数。

1
ChangeOrderListarray<object>

变更单列表。

ChangeOrderobject

变更单列表信息。

Statusinteger

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

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

结束时间。

2019-07-11 20:12:58
CreateTimestring

创建时间。

2019-07-11 15:54:49
UserIdstring

用户 ID。

sae-beta-test
Sourcestring

变更单操作入口来源。

console
BatchCountinteger

分批数。

1
CreateUserIdstring

创建用户 ID。

sae-beta-test
CoTypeCodestring

变更类型 Code。取值说明如下:

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

变更单 ID。

7fa5c0-9ebb-4bb4-b383-1f885447****
BatchTypestring

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

  • auto:自动。
  • manual:手动。
auto
GroupIdstring

分组 ID。

c9ecd2-cf6c-46c3-9f20-525de202****
Descriptionstring

描述信息。

版本:1.0 | 镜像名称:nginx
CoTypestring

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

创建应用
AppIdstring

应用 ID。

164341c-9708-4967-b3ec-24933767****
PageSizeinteger

分页大小。

20
ErrorCodestring

错误码。取值说明如下:

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

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

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

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

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

示例

正常返回示例

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
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.NotEmptyYou must specify the parameter %s.不合法的参数:%s不能为空。
400Resouce.no.permissionYou are not authorized to operate on the specified resources.没有权限操作资源。
404InvalidAppId.NotFoundThe specified AppId does not exist.指定的AppId不存在。

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

变更历史

变更时间变更内容概要操作
暂无变更历史