You can call this operation to create a stack group.

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 CreateStackGroup

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

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 stack. You can call the DescribeRegions operation to query the most recent region list.

StackGroupName String Yes MyStackGroup

The name of the stack group. The name must be unique in a region. 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.

Description String No StackGroup Description

The description of the stack group. The description must be 1 to 256 characters in length.

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.
TemplateURL String No oss://ros-template/demo

The URL for the file that contains the template body. 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. The template can be up to 524,288 bytes in length.

You must specify either the TemplateBody parameter or the TemplateURL parameter. But you cannot specify both of them.

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 contain only letters, digits, hyphens (-), and underscores(_) and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

AdministrationRoleName String No AliyunROSStackGroupAdministrationRole

The name of the RAM administrator role assumed by ROS. ROS assumes this role to play the execution role to operate on the stack corresponding to the stack instance in the stack group.

The RAM role is specified only when the custom administrator role is used to control the users or groups that can manage specified stack groups under the same administrator account. Default value: AliyunROSStackGroupAdministrationRole.

The name must be 1 to 64 characters in length and can contain letters, digits, and hyphens (-).

ExecutionRoleName String No AliyunROSStackGroupExecutionRole

The name of the RAM execution role assumed by the administrator role. ROS plays this role to operate on the stack corresponding to the stack instance in the stack group.

Default value: AliyunROSStackGroupExecutionRole.

The name must be 1 to 64 characters in length and can contain letters, digits, and hyphens (-).

Response parameters

Parameter Type Example Description
RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A

The ID of the request.

StackGroupId String 2c036e78-9e82-428e-afd6-177f5d04db9d

The ID of the stack group.

Examples

Sample requests

http(s)://[Endpoint]/? Action=CreateStackGroup
&Parameters.1.ParameterKey=Amount
&Parameters.1.ParameterValue=12
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&<Common request parameters>

Sample success responses

XML format

<StackGroupId>fd0ddef9-9540-4b42-a464-94f7783501d0</StackGroupId>
<RequestId>FEA9B039-1062-4C7F-8659-CB02B9C68017</RequestId>

JSON format

{
	"StackGroupId": "fd0ddef9-9540-4b42-a464-94f7783501d0",
	"RequestId": "FEA9B039-1062-4C7F-8659-CB02B9C68017"
}

Error codes

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