全部产品
Search

搜索本产品

    资源编排：ListChangeSets - 查询更改集列表

    文档中心

    资源编排：ListChangeSets - 查询更改集列表

    更新时间：Sep 12, 2024

    查询已创建的更改集列表详情。

    调试

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

    授权信息

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

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

    请求语法

    POST /V2/ListChangeSets
    GET /V2/ListChangeSets

    请求参数

    名称类型必填描述示例值
    StackIdstring是

    资源栈 ID。

    		4a6c9851-3b0f-4f5f-b4ca-a14bf691****
    PageSizelong否

    分页查询时设置的每页行数。
    取值范围：1~50。
    默认值：10。

    		10
    RegionIdstring是

    更改集所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

    		cn-hangzhou
    PageNumberlong否

    更改集列表的页码。
    起始值：1。
    默认值：1。

    		1
    ChangeSetIdstring否

    更改集 ID。如果不需要更改集详细信息，可使用此参数代替 GetChangeSet 接口。

    		1f6521a4-05af-4975-afe9-bc4b45ad****
    Statusarray否

    更改集的状态。N 的最大值为 5。取值：

    • CREATE_PENDING
    • CREATE_IN_PROGRESS
    • CREATE_COMPLETE
    • CREATE_FAILED
    • DELETE_FAILED
    • DELETE_COMPLETE
    string否

    更改集的状态。

    		CREATE_COMPLETE
    ChangeSetNamearray否

    更改集的名称。N 的最大值为 5。支持使用通配符星号（*）进行模糊搜索。

    string否

    更改集的名称。

    		MyChangeSet
    ExecutionStatusarray否

    更改集的执行状态。N 的最大值为 5。取值：

    • UNAVAILABLE
    • AVAILABLE
    • EXECUTE_IN_PROGRESS
    • EXECUTE_COMPLETE
    • EXECUTE_FAILED
    • OBSOLETE
    string否

    更改集的执行状态。

    		AVAILABLE

    返回参数

    名称类型描述示例值
    object

    返回参数。

    TotalCountinteger

    查询到的总数。

    		1
    PageSizeinteger

    分页查询时设置的每页行数。

    		10
    RequestIdstring

    请求 ID。

    		B288A0BE-D927-4888-B0F7-B35EF84B6E6F
    PageNumberinteger

    分页查询的页码。

    		1
    ChangeSetsarray<object>

    更改集列表。

    object
    Statusstring

    更改集状态。

    		CREATE_COMPLETE
    StackIdstring

    更改集所属资源栈 ID。

    		4a6c9851-3b0f-4f5f-b4ca-a14bf691****
    ChangeSetNamestring

    更改集名称。

    		MyChangeSet
    Descriptionstring

    更改集描述。

    		It is a demo.
    ChangeSetTypestring

    更改集类型。

    		UPDATE
    StatusReasonstring

    更改集异常状态原因。

    		too many changes
    CreateTimestring

    创建时间。按照 ISO8601 标准表示，需使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ss。

    		2019-08-01T05:16:31
    ChangeSetIdstring

    更改集 ID。

    		1f6521a4-05af-4975-afe9-bc4b45ad****
    StackNamestring

    更改集所属资源栈名称。

    		MyStack
    ExecutionStatusstring

    更改集执行状态。

    		AVAILABLE
    RegionIdstring

    地域 ID。

    		cn-hangzhou

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "PageNumber": 1,
  "ChangeSets": [
    {
      "Status": "CREATE_COMPLETE",
      "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
      "ChangeSetName": "MyChangeSet",
      "Description": "It is a demo.",
      "ChangeSetType": "UPDATE",
      "StatusReason": "too many changes",
      "CreateTime": "2019-08-01T05:16:31",
      "ChangeSetId": "1f6521a4-05af-4975-afe9-bc4b45ad****",
      "StackName": "MyStack",
      "ExecutionStatus": "AVAILABLE",
      "RegionId": "cn-hangzhou"
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    HttpCode错误码错误信息描述
    404StackNotFoundThe Stack ({name}) could not be found.资源栈不存在。name 为资源栈名称或 ID。