GetChangeSet - 查询更改集信息 - 资源编排

查询指定更改集信息，可以选择是否获取对应模板详情。

接口说明

本文将提供一个示例，为您查询杭州地域 ID 为4c11658d-bd47-4dd0-ba64-727edc62****的更改集信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ros:GetChangeSet	get	stack acs:ros:{#regionId}:{#accountId}:stack/{#stackId}	无	无

请求参数

名称	类型	必填	描述	示例值
ShowTemplate	boolean	否	是否获取模板，取值： true：获取模板。 false（默认值）：不获取模板。	false
RegionId	string	是	更改集所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
ChangeSetId	string	是	更改集 ID。	4c11658d-bd47-4dd0-ba64-727edc62****

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object	返回参数。
Status	string	更改集状态。	CREATE_COMPLETE
Changes	array<object>	更改集变更内容列表。
	object	更改集变更内容列表。更多信息，请参见更改集数据结构。	参见示例
Description	string	更改集描述。	It is a demo.
Parameters	array<object>	资源栈参数列表。
	object	资源栈参数列表。
ParameterKey	string	参数名称。	ALIYUN::Region
ParameterValue	string	参数值。	cn-hangzhou
RequestId	string	请求 ID。	3766EE04-76DD-50F9-9C23-3AF136CD5708
StatusReason	string	更改集异常状态原因。	too many changes.
CreateTime	string	创建时间，按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ss。	2021-12-01T02:20:56
TemplateBody	string	更改集对应的模板。说明当 ShowTemplate 为 true 时该参数有效。	{"ROSTemplateFormatVersion": "2015-09-01"}
ChangeSetName	string	更改集名称。	ChangeSet_template
ChangeSetId	string	更改集 ID。	4c11658d-bd47-4dd0-ba64-727edc62****
ExecutionStatus	string	更改集执行状态。	AVAILABLE
ChangeSetType	string	更改集类型。	UPDATE
RegionId	string	地域 ID。	cn-hangzhou
DisableRollback	boolean	资源栈在创建或更新失败时是否回滚。	false
StackName	string	更改集所属资源栈名。	stack_2021-10-13
TimeoutInMinutes	integer	资源栈创建或更新超时时间。	60
StackId	string	更改集所属资源栈 ID。	a486fc19-ebb7-4ce9-a70b-554a7c3d****
Log	object	更改集相关输出日志。
TerraformLogs	array<object>	Terraform 输出日志。仅 Terraform 类型资源栈的更改集返回该参数。说明创建中的更改集不返回该参数。该参数表示创建更改集的日志。
	object	输出日志。
Command	string	执行的 Terraform 命令名称。取值： apply plan destroy version 关于命令含义的更多信息，请参见 Command 。	apply
Stream	string	输出流。取值： stdout：标准输出。 stderr：标准错误。	stdout
Content	string	当前命令在当前输出流中输出的内容。	Apply complete! Resources: 42 added, 0 changed, 0 destroyed.

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史

错误代码	错误信息	HTTP 状态码	描述
ChangeSetNotFound	The ChangeSet ({name}) of Stack ({stack}) could not be found.	404	更改集不存在，name 为更改集名称或 ID，stack 为资源栈名称或 ID。
ChangeSetNotFound	The ChangeSet {ID} could not be found.	404	更改集不存在，ID 为更改集 ID。
StackNotFound	The Stack ({name}) could not be found.	404	资源栈不存在，name 为资源栈名称或 ID。