ListChangeSets - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries change sets.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ros:ListChangeSets	get	stack acs:ros:{#regionId}:{#accountId}:stack/{#stackId}	none	none

Request syntax

POST /V2/ListChangeSets
GET /V2/ListChangeSets

Request parameters

Parameter	Type	Required	Description	Example
StackId	string	Yes	The ID of the stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
PageSize	long	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10
RegionId	string	Yes	The region ID of the change set. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
PageNumber	long	No	The page number. Pages start from page 1. Default value: 1.	1
ChangeSetId	string	No	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****
Status	array	No	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
	string	No	The status of change set N.	CREATE_COMPLETE
ChangeSetName	array	No	The name of change set N. Maximum value of N: 5. You can use an asterisk (*) as a wildcard for fuzzy search.
	string	No	The name of change set N.	MyChangeSet
ExecutionStatus	array	No	The execution status of change set N. Maximum value of N: 5. Valid values: UNAVAILABLE AVAILABLE EXECUTE_IN_PROGRESS EXECUTE_COMPLETE EXECUTE_FAILED OBSOLETE
	string	No	The execution status of change set N.	AVAILABLE

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of change sets returned.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The ID of the request.	B288A0BE-D927-4888-B0F7-B35EF84B6E6F
PageNumber	integer	The page number.	1
ChangeSets	array<object>	The change sets.
	object
Status	string	The status of the change set.	CREATE_COMPLETE
StackId	string	The ID of the stack with which the change set is associated.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
ChangeSetName	string	The name of the change set.	MyChangeSet
Description	string	The description of the change set.	It is a demo.
ChangeSetType	string	The type of the change set.	UPDATE
StatusReason	string	The reason why the change set is in its current state.	too many changes
CreateTime	string	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
ChangeSetId	string	The ID of the change set.	1f6521a4-05af-4975-afe9-bc4b45ad****
StackName	string	The name of the stack with which the change set is associated.	MyStack
ExecutionStatus	string	The execution status of the change set.	AVAILABLE
RegionId	string	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 time	Summary of changes	Operation

No change history