GetChangeSet - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries change sets. You can determine whether to query the templates of change sets.

Operation description

In this example, the details of a change set whose ID is 4c11658d-bd47-4dd0-ba64-727edc62**** is queried. The change set is created in the China (Hangzhou) region.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ShowTemplate	boolean	No	Specifies whether to obtain the template. Valid values: true false (default)	false
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
ChangeSetId	string	Yes	The ID of the change set.	4c11658d-bd47-4dd0-ba64-727edc62****

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Status	string	The status of the change set.	CREATE_COMPLETE
Changes	array<object>	The changes of the change set.
	object	The change of the change set. For more information, see Data structure.
Description	string	The description of the change set.	It is a demo.
Parameters	array<object>	The parameters of the stack.
	object	The parameter of the stack.
ParameterKey	string	The key of the parameter.	ALIYUN::Region
ParameterValue	string	The value of the parameter.	cn-hangzhou
RequestId	string	The ID of the request.	3766EE04-76DD-50F9-9C23-3AF136CD5708
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.	2021-12-01T02:20:56
TemplateBody	string	The template body of the change set. Note This parameter takes effect only if you set ShowTemplate 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 of the change set.	cn-hangzhou
DisableRollback	boolean	Indicates whether rollback was performed when the stack failed to be created or updated.	false
StackName	string	The name of the stack with which the change set is associated.	stack_2021-10-13
TimeoutInMinutes	integer	The timeout period that is specified for the stack creation or update operation.	60
StackId	string	The ID of the stack with which the change set is associated.	a486fc19-ebb7-4ce9-a70b-554a7c3d****
Log	object	The output logs of the change set.
TerraformLogs	array<object>	The Terraform logs. This parameter is returned only for change sets of Terraform stacks. Note This parameter is not returned for change sets that are in the Creating state. This parameter indicates the logs of the change set creation operation for Terraform stacks.
	object	The output log.
Command	string	The name of the Terraform command that is run. Valid values: apply plan destroy version For more information about Terraform commands, see Command .	apply
Stream	string	The output stream. Valid values: stdout: standard output stream stderr: standard error stream	stdout
Content	string	The content of the output stream that is returned after the command is run.	Apply complete! Resources: 42 added, 0 changed, 0 destroyed.

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history