Creates a stack group.
You can use a stack group as a unit to manage stacks in Resource Orchestration Service (ROS). You can use an ROS template of a stack group to create stacks within Alibaba Cloud accounts in multiple regions.
You can create a stack group that is granted self-managed or service-managed permissions:
- If you use an Alibaba Cloud account to create a self-managed stack group, the administrator account and the execution account are Alibaba Cloud accounts.
- If you use a management account or delegated administrator account in a resource directory to create a service-managed stack group, the administrator account is the management account or delegated administrator account, and the execution account is the member account in the resource directory.
For more information about stack groups, see Overview.
In this example, the template ID 5ecd1e10-b0e9-4389-a565-e4c15efc∗∗∗∗
is specified to create a stack group named MyStackGroup
. The stack group is granted self-managed permissions and created in the cn-hangzhou
region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateStackGroup |
The operation that you want to perform. Set the value to CreateStackGroup. |
RegionId | String | Yes | cn-hangzhou |
The region ID of the stack group. 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 within 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 template body. The template body must be 1 to 524,288 bytes in length. If the required length exceeds the maximum value, we recommend that you specify parameters in the HTTP POST request body to prevent request failures due to excessive length of URLs. Note You must specify one of the TemplateBody, TemplateURL, and TemplateId parameters.
|
TemplateURL | String | No | oss://ros-template/demo |
The URL of the file that contains the template body. The URL must point to a template that is located in an HTTP or HTTPS web server or an Alibaba Cloud Object Storage Service (OSS) bucket. The template must be 1 to 524,288 bytes in length. Sample value for a template that is located in an OSS bucket: oss://ros/template/demo or oss://ros/template/demo?RegionId=cn-hangzhou. If you do not specify RegionId in the URL, the region ID of the stack group is used. Note You must specify one of the TemplateBody, TemplateURL, and TemplateId parameters.
|
ClientToken | String | No | 123e4567-e89b-12d3-a456-42665544**** |
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 make sure that it is unique among different requests. The token can be up to 64 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). For more information, see Ensure idempotence. |
AdministrationRoleName | String | No | AliyunROSStackGroupAdministrationRole |
The name of the RAM role that you specify for the administrator account in ROS when you create the self-managed stack group. If you do not specify this parameter, the default value AliyunROSStackGroupAdministrationRole is used. You can use the administrator role in ROS to assume the execution role AliyunROSStackGroupExecutionRole to perform operations on the stacks that correspond to stack instances in the stack group. 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 role that you specify for the execution account when you create the self-managed stack group. You can use the administrator role AliyunROSStackGroupAdministrationRole to assume the execution role. If you do not specify this parameter, the default value AliyunROSStackGroupExecutionRole is used. You can use this role in ROS to perform operations on the stacks that correspond to stack instances in the stack group. The name must be 1 to 64 characters in length, and can contain letters, digits, and hyphens (-). |
TemplateId | String | No | 5ecd1e10-b0e9-4389-a565-e4c15efc**** |
The ID of the template. This parameter applies to shared and private templates. Note You must specify one of the TemplateBody, TemplateURL, and TemplateId parameters.
|
TemplateVersion | String | No | v1 |
The version of the template. If you do not specify a version, the latest version is used. Note This parameter takes effect only when the TemplateId parameter is specified.
|
ResourceGroupId | String | No | rg-acfmxazb4ph6aiy**** |
The ID of the resource group. If you do not specify this parameter, the stack group is added to the default resource group. For more information about resource groups, see What is Resource Management? |
PermissionModel | String | No | SELF_MANAGED |
The permission model. Valid values:
Note When you use the service-managed permission model to deploy stacks, your account must
be a management account or delegated administrator account in the resource directory
and the trusted access feature is enabled for the account.
|
AutoDeployment | Object | No |
The information about automatic deployment settings. Note You must specify this parameter only when the PermissionModel parameter is set to
SERVICE_MANAGED.
|
|
Enabled | Boolean | Yes | true |
Specifies whether to enable automatic deployment. Valid values:
|
RetainStacksOnAccountRemoval | Boolean | No | true |
Specifies whether to retain stacks in a member account when you delete the member account from the folder. Valid values:
Note You must specify this parameter when the Enabled parameter is set to true.
|
Parameters.N.ParameterKey | String | Yes | Amount |
The key of parameter N. If you do not specify the key and value of the parameter, ROS uses the default key and value in the template. Maximum value of N: 200. Note Parameters in Parameters.N.ParameterKey is optional. You must specify Parameters.N.ParameterKey
if you specify Parameters.
|
Parameters.N.ParameterValue | String | Yes | 12 |
The value of parameter N. Maximum value of N: 200. Note Parameters in Parameters.N.ParameterValue is optional. You must specify Parameters.N.ParameterValue
if you specify Parameters.
|
For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 14A07460-EBE7-47CA-9757-12CC4761D47A |
The ID of the request. |
StackGroupId | String | 2c036e78-9e82-428e-afd6-177f5d04**** |
The ID of the stack group. |
Examples
Sample requests
http(s)://ros.aliyuncs.com/?Action=CreateStackGroup
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&TemplateId=5ecd1e10-b0e9-4389-a565-e4c15efc****
&PermissionModel=SELF_MANAGED
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateStackGroupResponse>
<RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
<StackGroupId>2c036e78-9e82-428e-afd6-177f5d04****</StackGroupId>
</CreateStackGroupResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
"StackGroupId" : "2c036e78-9e82-428e-afd6-177f5d04****"
}
Error codes
For a list of error codes, visit the API Error Center.
Error code |
Error message |
HTTP status code |
Description |
---|---|---|---|
CircularDependency |
Circular Dependency Found: {reason}. |
400 |
The error message returned because the template contains circular dependencies. reason indicates the specific reason. |
InvalidSchema |
{reason}. |
400 |
The error message returned because the template format is invalid. reason indicates the specific reason. |
InvalidTemplateAttribute |
The Referenced Attribute ({resource} {name}) is incorrect. |
400 |
The error message returned because the resource attribute referenced in the template is invalid. resource indicates the resource name. name indicates the attribute name. |
InvalidTemplatePropertyType |
The specified value type of ({resource} {section}) is incorrect. |
400 |
The error message returned because the type of the specified resource section that is defined in the template is invalid. resource indicates the resource name. section indicates the section name. |
InvalidTemplateReference |
The specified reference "{name}" (in {referencer}) is incorrect. |
400 |
The error message returned because the template contains an invalid reference. name indicates the reference name. referencer indicates the referencer name. |
InvalidTemplateSection |
The template section is invalid: {section}. |
400 |
The error message returned because the template contains an invalid section. section indicates the section name. |
InvalidTemplateVersion |
The template version is invalid: {reason}. |
400 |
The error message returned because the template version is invalid. reason indicates the specific reason. |
UnknownUserParameter |
The Parameter ({name}) was not defined in template. |
400 |
The error message returned because the specified parameter is not defined in the template. name indicates the parameter name. |
UserParameterMissing |
The Parameter {name} was not provided. |
400 |
The error message returned because no value is set for the specified parameter that is defined in the template. name indicates the parameter name. |
StackGroupExists |
The StackGroup ({name}) already exists. |
409 |
The error message returned because a stack group whose name is the same as the specified stack group exists. name indicates the name of the stack group. |
TemplateNotFound |
The Tempalte ({ ID }) could not be found. |
404 |
The error message returned because the specified template does not exist. ID indicates the template ID. |
TemplateNotFound |
The Template { ID } with version { version } could not be found. |
404 |
The error message returned because the specified template or template version does not exist. ID indicates the template ID. version indicates the template version. |