Updates a stack group.
In this example, the template content {"ROSTemplateFormatVersion": "2015-09-01"}
is specified to update a stack group named MyStackGroup
. The stack group is granted self-managed permissions and deployed in the China (Hangzhou)
region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | UpdateStackGroup |
The operation that you want to perform. Set the value to UpdateStackGroup. |
RegionId | String | Yes | cn-hangzhou |
The region ID of the stack group. You can call the DescribeRegions operation to query the latest list of Alibaba Cloud regions. |
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 (_). The name must start with a digit or a letter. |
Description | String | No | My Stack Group |
The description of the stack group. The description must be 1 to 256 characters in length. |
AccountIds | Array of String | No | ["151266687691****","141261387191****"] |
The IDs of the accounts within which you want to use self-managed permissions to deploy stacks. You can specify a maximum of 20 account IDs. |
RegionIds | Array of String | No | ["cn-hangzhou","cn-beijing"] |
The region IDs of stack instances. You can specify a maximum of 20 region IDs. |
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 exceeds the upper limit, we recommend that you add parameters to the HTTP POST request body to prevent request failures caused by excessively long URLs. Note You must specify only 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 on an HTTP or HTTPS web server or in an Alibaba Cloud Object Storage Service (OSS) bucket. The template body must be 1 to 524,288 bytes in length. Examples: oss://ros/template/demo and oss://ros/template/demo?RegionId=cn-hangzhou. If you do not specify the region ID of the OSS bucket, the value of the RegionId parameter is used. Note You must specify only 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 the token 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. |
OperationDescription | String | No | Update stack instances in hangzhou |
The description of the operation to update the stack group. |
OperationPreferences | Map | No | {"FailureToleranceCount": 1,"MaxConcurrentCount": 2} |
The preferences of the operation to update the stack group. The following parameters are available:
Separate multiple parameters with commas (,). Note
|
AdministrationRoleName | String | No | AliyunROSStackGroupAdministrationRole |
The name of the RAM role to be assumed by the administrator account in ROS. This parameter is required if you want to grant self-managed permissions to the stack group. If you do not specify a value for 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 to be assumed by the administrator role AliyunROSStackGroupAdministrationRole. This parameter is required if you want to grant self-managed permissions to the stack group. If you do not specify a value for 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 only 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 if the TemplateId parameter is set.
|
PermissionModel | String | No | SELF_MANAGED |
The permission model. Valid values:
Note
|
AutoDeployment | Object | No |
The information about automatic deployment settings. Note This parameter is required only if 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 when you remove the member from the folder. Valid values:
Note This parameter is required if the Enabled parameter is set to true.
|
DeploymentTargets | Object | No |
The folders in which you want to use service-managed permissions to update stacks. |
|
RdFolderIds | Array of String | No | ["fd-4PvlVLOL8v"] |
The folder IDs in the resource directory. You can specify a maximum of five folder IDs. You must set at least one of the RdFolderIds and AccountIds parameters. The parameters are subject to the following items:
Note To view the folder IDs, go to the Overview page in the Resource Management console. For more information, see View the basic information of a folder.
|
AccountIds | Array of String | No | ["151266687691****","141261387191****"] |
The IDs of the members in the resource directory. You can specify a maximum of 20 member IDs. Note To view the member IDs, go to the Overview page in the Resource Management console. For more information, see View the detailed information of a member.
|
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 The Parameters parameter is optional. If you set the Parameters parameter, you must
set the Parameters.N.ParameterKey parameter.
|
Parameters.N.ParameterValue | String | Yes | 1 |
The value of parameter N. Maximum value of N: 200. Note The Parameters parameter is optional. If you set the Parameters parameter, you must
set the Parameters.N.ParameterValue parameter.
|
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. |
OperationId | String | 6da106ca-1784-4a6f-a7e1-e723863d**** |
The ID of the operation. |
Examples
Sample requests
http(s)://ros.aliyuncs.com/?Action=UpdateStackGroup
&TemplateBody={"ROSTemplateFormatVersion": "2015-09-01"}
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateStackGroupResponse>
<RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
<OperationId>6da106ca-1784-4a6f-a7e1-e723863d****</OperationId>
</UpdateStackGroupResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
"OperationId" : "6da106ca-1784-4a6f-a7e1-e723863d****"
}
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 cause of the error. |
InvalidSchema |
{reason}. |
400 |
The error message returned because the template format is invalid. reason indicates the specific cause of the error. |
InvalidTemplateAttribute |
The Referenced Attribute ({resource} {name}) is incorrect. |
400 |
The error message returned because the resource attribute that is 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 cause of the error. |
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 specified for the parameter that is defined in the template. name indicates the parameter name. |
StackGroupOperationInProgress |
Another Operation on StackGroup ({name})s is in progress. |
409 |
The error message returned because an operation is being performed on the stack group. 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. |