Import Stacks into a Stack Group via API - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Import stacks from multiple different accounts into a stack group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ros:ImportStacksToStackGroup

create

*StackGroup

acs:ros:{#regionId}:{#accountId}:stackgroup/{#StackGroupName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the stack group. You can call DescribeRegions to view the latest list of Alibaba Cloud regions.	cn-hangzhou
StackGroupName	string	Yes	The name of the stack group. The name must be unique within a single region. It cannot exceed 255 characters and must start with a letter or number, and can include letters, numbers, hyphens (-), and underscores (_).	MyStackGroup
StackArns	array	Yes	A list of ARNs for the stacks to be imported into the stack group, in the format `acs:ros:${RegionId}:${AccountId}:stack/${StackId}`. A maximum of 10 stacks can be added.
	string	No	The ARN of the stack to be imported into the stack group, in the format acs:ros:${RegionId}:${AccountId}:stack/${StackId}. A maximum of 10 stacks can be added.	acs:ros:cn-hangzhou:175458000000**:stack/4a65f506-c3cc-43b6-af06-3f000000**
ResourceDirectoryFolderIds	array	No	A list of resource directory folder IDs for the stacks to be imported. A maximum of 10 folders can be added.
	string	No	The resource directory folder ID for the stacks to be imported. A maximum of 10 folders can be added.	["fd-1111VL****"]
ClientToken	string	No	Ensures the idempotence of the request. This value is generated by the client and must be globally unique. It cannot exceed 64 characters and can include letters, numbers, hyphens (-), and underscores (_). For more information, see How to Ensure Idempotence.	123e4567-e89b-12d3-a456-42665544****
OperationDescription	string	No	Description of the operation.	Import ops stacks to stack group
OperationPreferences	object	No	Operation settings for importing stacks into the stack group. Includes the following parameters: {"FailureToleranceCount": N} Failure tolerance count. The number of accounts in which the stack can fail in each region. If this number is exceeded, the operation in that region will stop. If the operation in one region stops, it will not continue in other regions. The range of N: 0~20. If FailureToleranceCount is not specified, the default value is 0. {"FailureTolerancePercentage": N} Failure tolerance percentage. The percentage of total accounts in which the stack can fail in each region. If this percentage is exceeded, the operation in that region will stop. The range of N: 0~100. If the percentage is not an integer, ROS will round down. If FailureTolerancePercentage is not specified, the default value is 0. {"MaxConcurrentCount": N} Maximum concurrent account count. The number of accounts in which the stack can be deployed simultaneously in each region. The range of N: 1~20. If MaxConcurrentCount is not specified, the default value is 1. {"MaxConcurrentPercentage": N} Maximum concurrent account percentage. The percentage of total accounts in which the stack can be deployed simultaneously in each region. The range of N: 1~100. If the percentage is not an integer, ROS will round down. If MaxConcurrentPercentage is not specified, the default value is 1. {"RegionConcurrencyType": N} Region-level concurrency type for deploying stack instances, values: SEQUENTIAL (default): Deploy sequentially in each specified region, only one region at a time. PARALLEL: Deploy in parallel across all specified regions. Multiple parameters are separated by commas (,). Note Do not specify both MaxConcurrentCount and MaxConcurrentPercentage. Do not specify both FailureToleranceCount and FailureTolerancePercentage.	{"FailureToleranceCount": 1,"MaxConcurrentCount": 2}

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	14A07460-EBE7-47CA-9757-12CC4761D47A
OperationId	string	Operation ID.	6da106ca-1784-4a6f-a7e1-e723863d****

Examples

Success response

JSON format

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.