调用CreateChangeSet接口创建更改集。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateChangeSet

系统规定参数。取值:CreateChangeSet

ChangeSetName String MyChangeSet

更改集的名称。更改集名称在与指定资源栈关联的所有更改集中必须是唯一的。更改集名称可以包含数字、字母(大小写敏感)、连字符和下划线,必须以数字或字母开头,长度不超过255个字符。

Parameters.N.ParameterKey String Amount

参数的名称。如果未指定特定参数的名称和值,则ROS将使用模板中指定的默认值。N的最大值为200。

Parameters.N.ParameterValue String 12

参数的值。N的最大值为200。

RegionId String cn-hangzhou

更改集所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

StackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf691****

创建更改集的资源栈的ID。ROS通过将此资源栈的信息与您提交的信息(例如修改的模板或不同的参数输入值)进行比较来生成更改集。当且仅当更改集类型为UPDATE时,此参数生效且为必选参数。

StackPolicyURL String oss://ros/stack-policy/demo

资源栈策略的文件的位置。资源栈策略的文件最大为16384个字节。URL必须指向位于Web服务器(http、https)或阿里云OSS存储空间(例如oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou。OSS地域如未指定,默认与接口参数RegionId相同。)中的策略。您可以指定StackPolicyBodyStackPolicyURL参数,但不能同时指定两者。URL的最大长度为1350个字节。

当更改集类型为CREATE时,您可以指定StackPolicyBodyStackPolicyURL参数,但不能同时指定;当更改集类型为UPDATE时,您只能指定以下参数之一:

  • StackPolicyBody
  • StackPolicyURL
  • StackPolicyDuringUpdateBody
  • StackPolicyDuringUpdateURL
StackPolicyBody String {"Statement":[{"Effect":"Allow","Action":"Update:*","Principal":"*","Resource":"*"}]}

资源栈策略的结构,长度为1~16384个字节。当更改集类型为CREATE时,您可以指定StackPolicyBodyStackPolicyURL参数,但不能同时指定两者;当更改集类型为UPDATE时,您只能指定以下参数之一:

  • StackPolicyBody
  • StackPolicyURL
  • StackPolicyDuringUpdateBody
  • StackPolicyDuringUpdateURL
StackName String MyStack

创建更改集的资源栈的名称。资源栈名称可以包含数字、字母(大小写敏感)、连字符、下划线,必须以数字或字母开头,长度不超过255个字符。当且仅当更改集类型为CREATE时,此参数生效且为必选参数。

UsePreviousParameters Boolean true

对于未传递的参数,是否使用上次传递的值。当且仅当更改集类型为UPDATE时,此参数生效。取值:

  • true
  • false

默认值:false

ChangeSetType String UPDATE

更改集的类型。当为新资源栈创建更改集时,ROS会创建具有唯一资源栈ID的资源栈,资源栈将处于REVIEW_IN_PROGRESS状态,直到您执行更改集。禁止使用UPDATE类型为新资源栈创建更改集,或使用CREATE类型为现有资源栈创建更改集。取值范围:

  • CREATE:为新资源栈创建更改集。
  • UPDATE:为现有资源栈创建更改集。

默认值:UPDATE

Description String It is a demo.

更改集的描述。最大长度为1024字节。

ClientToken String 123e4567-e89b-12d3-a456-426655440000

保证请求的幂等性。此参数值由客户端生成,并且必须是全局唯一的。仅允许ASCII字符,最多可包含64个字符。更多详情,请参见如何保证幂等性

TemplateURL String oss://ros/template/demo

模板文件的位置。模板文件最大为524288个字节。URL必须指向位于Web服务器(http、https)或阿里云OSS存储空间(例如oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou。OSS地域如未指定,默认与接口参数RegionId相同。)中的模板。您必须指定TemplateBodyTemplateURL参数,但不能同时指定。URL的最大长度为1024个字节。

StackPolicyDuringUpdateURL String oss://ros/stack-policy/demo

更新资源栈策略的文件的位置。资源栈策略的文件最大为16384个字节。URL必须指向位于Web服务器(http、https)或阿里云OSS存储空间(例如oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou。OSS地域如未指定,默认与接口参数RegionId相同。)中的策略。URL的最大长度为1350个字节。

如需更新受保护资源,请在此更新期间指定临时覆盖资源栈策略,如未指定,则将使用与资源栈关联的当前策略。当且仅当更改集类型为UPDATE时,此参数生效,您只能指定以下参数之一:

  • StackPolicyBody
  • StackPolicyURL
  • StackPolicyDuringUpdateBody
  • StackPolicyDuringUpdateURL
TemplateBody String {"ROSTemplateFormatVersion":"2015-09-01"}

模板主体的结构。长度为1~524288个字节。如果长度较大,则建议通过HTTP POST+Body Param的方式,将参数放在请求体中进行传递,避免URL过长而导致请求失败。您必须指定参数TemplateBodyTemplateURL,但不能同时指定。

TimeoutInMinutes Long 12

资源栈状态变为CREATE_FAILEDUPDATE_FAILED之前可以经过的时间量。当更改集类型为CREATE时,此参数为必选参数;当更改集类型为UPDATE时,此参数为可选参数。

单位:分钟。

取值范围:10~1440。

默认值:60。

DisableRollback Boolean false

当且仅当更改集类型为CREATE时,此参数生效。取值范围:

  • true
  • false

默认值:false

如果取值为true,则当资源栈创建失败时,不进行回滚删除。

StackPolicyDuringUpdateBody String {"Statement":[{"Effect":"Allow","Action":"Update:*","Principal":"*","Resource":"*"}]}

临时覆盖资源栈策略的结构。长度为1~16384个字节。如果要更新受保护资源,请在此更新期间指定临时覆盖资源栈策略,如未指定,则将使用与资源栈关联的当前策略。当且仅当更改集类型为UPDATE时,此参数生效,您只能指定以下参数之一:

  • StackPolicyBody
  • StackPolicyURL
  • StackPolicyDuringUpdateBody
  • StackPolicyDuringUpdateURL
NotificationURLs.N RepeatList http://my-site.com/ros-notify

接收资源栈事件的URL回调地址。仅支持HTTP POST。N的最大值为5。每个URL的最大长度为1024个字节。

返回数据

名称 类型 示例值 描述
ChangeSetId String e85abe0c-6528-43fb-ae93-fdf8de22****

更改集ID。

StackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf691****

资源栈ID。

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6F

请求ID。

示例

请求示例

http(s)://ros.aliyuncs.com/?Action=CreateChangeSet
&ChangeSetName=MyChangeSet
&ChangeSetType=CREATE
&Description=It%20is%20a%20demo.
&StackName=MyStack
&TemplateURL=oss%3A//ros/template/demo
&Parameters.1.ParameterKey=Amount
&Parameters.1.ParameterValue=12
&TimeoutInMinutes=12
&DisableRollback=false
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&<公共请求参数>

正常返回示例

XML 格式

<CreateChangeSetResponse>
      <ChangeSetId>e85abe0c-6528-43fb-ae93-fdf8de22****</ChangeSetId>
      <StackId>4a6c9851-3b0f-4f5f-b4ca-a14bf691****</StackId>
      <RequestId>B288A0BE-D927-4888-B0F7-B35EF84B6E6F</RequestId>
</CreateChangeSetResponse>

JSON 格式

{
    "ChangeSetId": "e85abe0c-6528-43fb-ae93-fdf8de22****",
    "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
    "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F"
}

错误码

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

访问公共错误码查看更多错误码。

HttpCode

错误码

错误信息

描述

400

CircularDependency

Circular Dependency Found: {reason}.

模板包含循环引用。reason为具体原因。

400

InvalidSchema

{reason}.

模板格式不正确。reason为具体原因。

400

InvalidTemplateAttribute

The Referenced Attribute ({resource} {name}) is incorrect.

模板包含不正确的资源属性(输出)引用。resource为资源名,name为属性名。

400

InvalidTemplatePropertyType

The specified value type of ({resource} {section}) is incorrect.

模板资源定义中的字段类型不正确。resource为资源名,section为字段名。

400

InvalidTemplateReference

The specified reference "{name}" (in {referencer}) is incorrect.

模板包含不正确的引用。name为引用名,referencer为引用者。

400

InvalidTemplateSection

The template section is invalid: {section}.

模板包含无效的字段。section为字段名。

400

InvalidTemplateVersion

The template version is invalid: {reason}.

模板版本不正确。reason为具体原因。

400

StackPolicyValidationFailed

Action denied by stack policy: {reason}.

未通过资源栈策略校验。reason为具体原因。

400

StackValidationFailed

{reason}.

资源栈校验失败。reason为具体原因。

400

UnknownUserParameter

The Parameter ({name}) was not defined in template.

传递的参数在模板中未定义。name为参数名。

400

UserParameterMissing

The Parameter {name} was not provided.

参数在模板中已定义,但未传递值。name为参数名。

404

StackNotFound

The Stack ({name}) could not be found.

资源栈不存在。name为资源栈名称或ID。

409

ActionInProgress

Stack {name} already has an action ({action}) in progress.

资源栈在变更中。name为资源栈名称或ID,action为具体的变更操作。

409

ChangeSetExists

The ChangeSet ({name}) of Stack ({stack}) already exists.

同名更改集已存在。name为更改集名,stack为关联的资源栈名称或ID。

409

StackExists

The Stack ({name}) already exists.

同名资源栈已存在。name为资源栈名称。