All Products
Search
Document Center

Resource Orchestration Service:ListChangeSets

Last Updated:Feb 22, 2024

Queries change sets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ros:ListChangeSetsLIST
  • stack
    acs:ros:{#regionId}:{#accountId}:stack/{#stackId}
    none
none

Request syntax

POST /V2/ListChangeSets

GET /V2/ListChangeSets

Request parameters

ParameterTypeRequiredDescriptionExample
StackIdstringYes

The ID of the stack.

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

The number of entries per page.
Valid values: 1 to 50.
Default value: 10.

10
RegionIdstringYes

The region ID of the change set. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
PageNumberlongNo

The page number.
Pages start from page 1.
Default value: 1.

1
ChangeSetIdstringNo

The ID of the change set. If detailed information about the change set is not required, you can use this parameter to replace the GetChangeSet operation.

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

The status of change set N. Maximum value of N: 5. Valid values:

  • CREATE_PENDING
  • CREATE_IN_PROGRESS
  • CREATE_COMPLETE
  • CREATE_FAILED
  • DELETE_FAILED
  • DELETE_COMPLETE
stringNo

The status of change set N.

CREATE_COMPLETE
ChangeSetNamearrayNo

The name of change set N. Maximum value of N: 5. You can use an asterisk (*) as a wildcard for fuzzy search.

stringNo

The name of change set N.

MyChangeSet
ExecutionStatusarrayNo

The execution status of change set N. Maximum value of N: 5. Valid values:

  • UNAVAILABLE
  • AVAILABLE
  • EXECUTE_IN_PROGRESS
  • EXECUTE_COMPLETE
  • EXECUTE_FAILED
  • OBSOLETE
stringNo

The execution status of change set N.

AVAILABLE

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountinteger

The total number of change sets returned.

1
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The ID of the request.

B288A0BE-D927-4888-B0F7-B35EF84B6E6F
PageNumberinteger

The page number.

1
ChangeSetsobject []

The change sets.

Statusstring

The status of the change set.

CREATE_COMPLETE
StackIdstring

The ID of the stack with which the change set is associated.

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

The name of the change set.

MyChangeSet
Descriptionstring

The description of the change set.

It is a demo.
ChangeSetTypestring

The type of the change set.

UPDATE
StatusReasonstring

The reason why the change set is in its current state.

too many changes
CreateTimestring

The time when the change set was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2019-08-01T05:16:31
ChangeSetIdstring

The ID of the change set.

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

The name of the stack with which the change set is associated.

MyStack
ExecutionStatusstring

The execution status of the change set.

AVAILABLE
RegionIdstring

The region ID of the change set.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history