You can call this operation to create a change set.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateChangeSet

The operation that you want to perform. Set the value to CreateChangeSet.

ChangeSetName String Yes MyChangeSet

The name of the change set. The name must be unique among all change sets associated with a specified stack. The change set name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.

Parameters.N.ParameterKey String Yes Amount

The name of parameter N. If the name and value of the parameter are not specified, the name and value specified in the template are used. Maximum value of N: 200.

Parameters.N.ParameterValue String Yes 12

The value of parameter N. Maximum value of N: 200.

RegionId String Yes cn-hangzhou

The region ID of the change set. You can call the DescribeRegions operation to query the most recent region list.

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

The ID of the stack for which the change set is created. ROS generates the change set by comparing the stack information with the information that you submit, such as a modified template or different input parameter values. This parameter takes effect and is required only when the ChangeSetType parameter is set to UPDATE.

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

The URL for the file that contains the stack policy. The stack policy can be up to 16,384 bytes in length. The URL must point to a policy located in an HTTP or HTTPS web server or an Alibaba Cloud OSS bucket. Examples: oss://ros/stack-policy/demo and oss://ros/stack-policy/demo?RegionId=cn-hangzhou. If the region of the OSS bucket is not specified, the RegionId parameter value is used by default. You can specify either the StackPolicyBody parameter or the StackPolicyURL parameter, but you cannot specify both of them. The URL can be up to 1,350 bytes in length.

When the ChangeSetType parameter is set to CREATE, you can specify either the StackPolicyBody parameter or the StackPolicyURL parameter, but you cannot specify both of them. When the ChangeSetType parameter is set to UPDATE, you can specify only one of the following parameters:

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

The structure that contains the stack policy body. The stack policy body must be 1 to 16,384 bytes in length. When the ChangeSetType parameter is set to CREATE, you can specify either the StackPolicyBody parameter or the StackPolicyURL parameter, but you cannot specify both of them. When the ChangeSetType parameter is set to UPDATE, you can specify only one of the following parameters:

  • StackPolicyBody
  • StackPolicyURL
  • StackPolicyDuringUpdateBody
  • StackPolicyDuringUpdateURL
StackName String No MyStack

The name of the stack for which you want to create the change set. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. This parameter takes effect and is required only when the ChangeSetType parameter is set to CREATE.

UsePreviousParameters Boolean No true

Specifies whether to use the values that were passed last time for the parameters that you do not specify in the current request. This parameter takes effect only when the ChangeSetType parameter is set to UPDATE. Valid values:

  • true
  • false

Default value: false.

ChangeSetType String No UPDATE

The type of the change set. If you create a change set for a new stack, ROS creates a stack with a unique stack ID. The stack is in the REVIEW_IN_PROGRESS state until you execute the change set. You cannot use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack. Valid values:

  • CREATE: creates a change set for a new stack.
  • UPDATE: creates a change set for an existing stack.

Default value: UPDATE.

Description String No It is a demo.

The description of the change set. The description can be up to 1,024 bytes in length.

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

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

TemplateURL String No oss://ros/template/demo

The URL for the file that contains the template. The template can be up to 524,288 bytes in length. The URL must point to a template located in an HTTP or HTTPS web server or an Alibaba Cloud OSS bucket. Examples: oss://ros/template/demo and oss://ros/template/demo?RegionId=cn-hangzhou. If the region of the OSS bucket is not specified, the RegionId parameter value is used by default. You must specify either the TemplateBody parameter or the TemplateURL parameter, but you cannot specify both of them. The URL can be up to 1,024 bytes in length.

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

The URL for the file that contains the temporary overriding stack policy. The stack policy can be up to 16,384 bytes in length. The URL must point to a policy located in an HTTP or HTTPS web server or an Alibaba Cloud OSS bucket. Examples: oss://ros/stack-policy/demo and oss://ros/stack-policy/demo?RegionId=cn-hangzhou. If the region of the OSS bucket is not specified, the RegionId parameter value is used by default. The URL can be up to 1,350 bytes in length.

To update protected resources, specify a temporary overriding stack policy to take effect during the update. If no stack policy is specified for this parameter, the current policy associated with the stack is used. This parameter takes effect only when the ChangeSetType parameter is set to UPDATE. You can specify only one of the following parameters:

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

The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body is longer than required, we recommend that you add parameters to the HTTP POST request body to avoid request failures due to excessive length of URLs. You must specify either the TemplateBody parameter or the TemplateURL parameter, but you cannot specify both of them.

TimeoutInMinutes Long No 12

The amount of time that can elapse before the stack status changes to CREATE_FAILED or UPDATE_FAILED. When the ChangeSetType parameter is set to CREATE, this parameter is required. When the ChangeSetType parameter is set to UPDATE, this parameter is optional.

Unit: minutes.

Valid values: 10 to 1440.

Default value: 60.

DisableRollback Boolean No false

This parameter takes effect only when the ChangeSetType parameter is set to CREATE. Valid values:

  • true
  • false

Default value: false.

If this parameter is set to true, the stack is not rolled back and deleted upon the stack creation failure.

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

The structure that contains the body of the temporary overriding stack policy. The stack policy body must be 1 to 16,384 bytes in length. To update protected resources, specify a temporary overriding stack policy to take effect during the update. If no stack policy is specified for this parameter, the current policy associated with the stack is used. This parameter takes effect only when the ChangeSetType parameter is set to UPDATE. You can specify only one of the following parameters:

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

The callback URL for receiving stack event N. Only the HTTP POST method is supported. Maximum value of N: 5. Each URL can be up to 1,024 bytes in length.

Response parameters

Parameter Type Example Description
ChangeSetId String e85abe0c-6528-43fb-ae93-fdf8de22****

The ID of the change set.

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

The ID of the stack.

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6F

The ID of the request.

Examples

Sample requests

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
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.

For more information about errors common to all operations, see Common error codes.

HTTP status code

Error code

Error message

Description

400

CircularDependency

Circular Dependency Found: {reason}.

The error message returned because the template contains a circular dependency. reason indicates the specific reason.

400

InvalidSchema

{reason}.

The error message returned because the specified template format is incorrect. reason indicates the specific reason.

400

InvalidTemplateAttribute

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

The error message returned because the resource attribute referenced in the template is incorrect. resource indicates the resource name, and name indicates the attribute name.

400

InvalidTemplatePropertyType

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

The error message returned because the type of the specified resource property defined in the template is incorrect. resource indicates the resource name, and section indicates the property name.

400

InvalidTemplateReference

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

The error message returned because the template contains an invalid reference. name indicates the reference name, and referencer indicates the referencer name.

400

InvalidTemplateSection

The template section is invalid: {section}.

The error message returned because the template contains an invalid property. section indicates the property name.

400

InvalidTemplateVersion

The template version is invalid: {reason}.

The error message returned because the template version is incorrect. reason indicates the specific reason.

400

StackPolicyValidationFailed

Action denied by stack policy: {reason}.

The error message returned because the stack policy validation failed. reason indicates the specific reason.

400

StackValidationFailed

{reason}.

The error message returned because the stack validation failed. reason indicates the specific reason.

400

UnknownUserParameter

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

The error message returned because the specified parameter is not defined in the template. name indicates the parameter name.

400

UserParameterMissing

The Parameter {name} was not provided.

The error message returned because no value is passed into the specified parameter defined in the template. name indicates the parameter name.

404

StackNotFound

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

The error message returned because the specified stack does not exist. name indicates the stack name or ID.

409

ActionInProgress

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

The error message returned because the specified stack has a change operation in progress. name indicates the stack name or ID, and action indicates the change operation.

409

ChangeSetExists

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

The error message returned because a change set with the same name already exists. name indicates the change set name, and stack indicates the name or ID of the associated stack.

409

StackExists

The Stack ({name}) already exists.

The error message returned because a stack with the same name already exists. name indicates the stack name.