ListChangeSets - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries the details of the created change sets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ros:ListChangeSets

get

*stack

acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

None

Request syntax

POST /V2/ListChangeSets HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
StackId	string	Yes	The ID of the stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
PageSize	integer	No	The number of entries to return on each 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	integer	No	The page number of the change set list. Start value: 1. Default value: 1.	1
ChangeSetId	string	No	The ID of the change set. If you do not need the details of the change set, you can use this parameter instead of the GetChangeSet operation.	1f6521a4-05af-4975-afe9-bc4b45ad****
Status	array	No	The status of the change set. The value of N can be up to 5. Valid values: CREATE_PENDING CREATE_IN_PROGRESS CREATE_COMPLETE CREATE_FAILED DELETE_FAILED DELETE_COMPLETE	CREATE_COMPLETE
	string	No	The status of the change set.	CREATE_COMPLETE
ChangeSetName	array	No	The name of the change set. The value of N can be up to 5. Fuzzy search with an asterisk (*) is supported.	MyChangeSet
	string	No	The name of the change set.	MyChangeSet
ExecutionStatus	array	No	The execution status of the change set. The value of N can be up to 5. Valid values: UNAVAILABLE AVAILABLE EXECUTE_IN_PROGRESS EXECUTE_COMPLETE EXECUTE_FAILED OBSOLETE	AVAILABLE
	string	No	The execution status of the change set.	AVAILABLE

Response parameters

Parameter	Type	Description	Example
	object	The returned parameters.
TotalCount	integer	The total number of change sets.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	B288A0BE-D927-4888-B0F7-B35EF84B6E6F
PageNumber	integer	The page number of the returned page.	1
ChangeSets	array<object>	The list of change sets.
	object
Status	string	The status of the change set.	CREATE_COMPLETE
StackId	string	The ID of the stack to which the change set belongs.	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 for the abnormal status of the change set.	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 to which the change set belongs.	MyStack
ExecutionStatus	string	The execution status of the change set.	AVAILABLE
RegionId	string	The region ID.	cn-hangzhou
ResourceGroupId	string	The ID of the resource group. For more information about resource groups, refer to What is a resource group?.	rg-acfmxazb4ph6aiy****
Tags	array<object>	The tags of the change set.
	object	The tags of the change set.
Key	string	The tag key.	usage
Value	string	The tag value.	test

Examples

Success response

JSON format

{
  "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",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "Tags": [
        {
          "Key": "usage",
          "Value": "test"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.