GetChangeSet - Resource Orchestration Service - Alibaba Cloud Documentation Center

Returns details for a specified change set, optionally including the details of its associated template.

Operation description

This topic demonstrates how to query a change set with the ID 4c11658d-bd47-4dd0-ba64-727edc62**** in the China (Hangzhou) region.

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:GetChangeSet

get

*stack

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

None

Request parameters

Parameter	Type	Required	Description	Example
ShowTemplate	boolean	No	Specifies whether to return the template. Valid values: true: The template is returned. false (default): The template is not returned.	false
RegionId	string	Yes	The ID of the region to which the change set belongs. You can call the DescribeRegions operation to query the latest list of Alibaba Cloud regions.	cn-hangzhou
ChangeSetId	string	Yes	The ID of the change set.	4c11658d-bd47-4dd0-ba64-727edc62****

For details about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	The data returned.
Status	string	The status of the change set.	CREATE_COMPLETE
Changes	array<object>	The changes in the change set.	See examples.
	object	A change in the change set. For more information, see change set data structure.	See examples.
Description	string	The description of the change set.	It is a demo.
Parameters	array<object>	The parameters of the stack.
	object	A parameter for the stack.
ParameterKey	string	The name of the parameter.	ALIYUN::Region
ParameterValue	string	The value of the parameter.	cn-hangzhou
RequestId	string	The request ID.	3766EE04-76DD-50F9-9C23-3AF136CD5708
StatusReason	string	The reason for the change set's abnormal status.	too many changes.
CreateTime	string	The time when the change set was created. The time is in UTC and uses the `YYYY-MM-DDThh:mm:ss` format.	2021-12-01T02:20:56
TemplateBody	string	The template body of the change set. Note This parameter is returned only when `ShowTemplate` is set to `true`.	{"ROSTemplateFormatVersion": "2015-09-01"}
ChangeSetName	string	The name of the change set.	ChangeSet_template
ChangeSetId	string	The ID of the change set.	4c11658d-bd47-4dd0-ba64-727edc62****
ExecutionStatus	string	The execution status of the change set.	AVAILABLE
ChangeSetType	string	The type of the change set.	UPDATE
RegionId	string	The region ID.	cn-hangzhou
DisableRollback	boolean	Indicates whether to disable rollback when a stack creation or update fails.	false
StackName	string	The name of the stack to which the change set belongs.	stack_2021-10-13
TimeoutInMinutes	integer	The timeout period for creating or updating the stack.	60
StackId	string	The ID of the stack to which the change set belongs.	a486fc19-ebb7-4ce9-a70b-554a7c3d****
Log	object	Logs for the change set.
TerraformLogs	array<object>	The Terraform output logs. This parameter is returned only for change sets of Terraform-based stacks. Note This parameter is unavailable while a change set is being created because the logs are generated only after the creation is complete.
	object	A Terraform log entry.
Command	string	The name of the Terraform command that was executed. Valid values: apply plan destroy version For more information about the commands, see Command.	apply
Stream	string	The output stream. Valid values: `stdout`: standard output `stderr`: standard error	stdout
Content	string	The content that the command wrote to the specified stream.	Apply complete! Resources: 42 added, 0 changed, 0 destroyed.
Tags	array<object>	The tags of the change set.
	object	A tag applied to the change set.
Key	string	The key of the tag.	usage
Value	string	The value of the tag.	test
ResourceGroupId	string	The ID of the resource group. For more information about resource groups, see What is a resource group?.	rg-acfmxazb4ph6aiy****

Examples

Success response

JSON format

{
  "Status": "CREATE_COMPLETE",
  "Changes": [
    {
      "test": "test",
      "test2": 1
    }
  ],
  "Description": "It is a demo.",
  "Parameters": [
    {
      "ParameterKey": "ALIYUN::Region",
      "ParameterValue": "cn-hangzhou"
    }
  ],
  "RequestId": "3766EE04-76DD-50F9-9C23-3AF136CD5708",
  "StatusReason": "too many changes.",
  "CreateTime": "2021-12-01T02:20:56",
  "TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
  "ChangeSetName": "ChangeSet_template",
  "ChangeSetId": "4c11658d-bd47-4dd0-ba64-727edc62****",
  "ExecutionStatus": "AVAILABLE",
  "ChangeSetType": "UPDATE",
  "RegionId": "cn-hangzhou",
  "DisableRollback": false,
  "StackName": "stack_2021-10-13",
  "TimeoutInMinutes": 60,
  "StackId": "a486fc19-ebb7-4ce9-a70b-554a7c3d****",
  "Log": {
    "TerraformLogs": [
      {
        "Command": "apply",
        "Stream": "stdout",
        "Content": "Apply complete! Resources: 42 added, 0 changed, 0 destroyed."
      }
    ]
  },
  "Tags": [
    {
      "Key": "usage",
      "Value": "test"
    }
  ],
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.