All Products
Search

This Product

    Resource Orchestration Service:CreateStackInstances

    Document Center

    Resource Orchestration Service:CreateStackInstances

    Last Updated:Sep 12, 2024

    Creates stack instances in the specified accounts and regions.

    Operation description

    Before you call this operation, make sure that a stack group is created. For more information, see CreateStackGroup .

    In this topic, the stack group named MyStackGroup is used. The stack group is created in the China (Hangzhou) region and granted the self-managed permissions. In this example, stacks are created by using Alibaba Cloud accounts whose IDs are 151266687691**** and 141261387191**** in the China (Hangzhou) region and China (Beijing) region.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ros:CreateStackInstancescreate
    • StackInstance
      acs:ros:{#regionId}:{#accountId}:stackinstance/{#StackGroupName}/{#StackInstanceAccountId}/{#StackInstanceRegionId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-hangzhou
    StackGroupNamestringYes

    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 a letter.

    		MyStackGroup
    AccountIdsarrayNo

    The IDs of the execution accounts within which you want to deploy stacks in self-managed mode. You can specify up to 20 execution account IDs.

    Note You must specify one of the following parameters: AccountIds and DeploymentTargets.
    stringNo

    The ID of the execution account within which you want to deploy stacks in self-managed mode. You can specify up to 20 execution account IDs.

    Note You must specify one of the following parameters: AccountIds and DeploymentTargets.
    		["151266687691****", "141261387191****"]
    RegionIdsarrayYes

    The IDs of the regions where you want to create the stacks. You can specify up to 20 region IDs.

    stringYes

    The ID of the region where you want to create the stacks. You can specify up to 20 region IDs.

    		["cn-hangzhou","cn-beijing"]
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.
    The token can contain letters, digits, hyphens (-), and underscores (_), and cannot exceed 64 characters in length.
    For more information, see How to ensure idempotence.

    		123e4567-e89b-12d3-a456-42665544****
    OperationDescriptionstringNo

    The description of the stack creation operation.

    The description must be 1 to 256 characters in length.

    		Create stack instances in hangzhou and beijing
    OperationPreferencesobjectNo

    The preference settings of the stack creation operation.

    The following parameters are available:

    • {"FailureToleranceCount": N}

      The number of accounts within which stack operation failures are allowed in each region. If the value of this parameter is exceeded in a region, Resource Orchestration Service (ROS) stops the operation in the region. If ROS stops the operation in one region, ROS stops the operation in other regions.

      Valid values of N: 0 to 20.

      If you do not specify FailureToleranceCount, 0 is used as the default value.

    • {"FailureTolerancePercentage": N}

      The percentage of the number of accounts within which stack operation failures are allowed to the total number of accounts in each region. If the value of this parameter is exceeded, ROS stops the operation in the region.

      Valid values of N: 0 to 100. If the numeric value in the percentage is not an integer, ROS rounds the value down to the nearest integer.

      If you do not specify FailureTolerancePercentage, 0 is used as the default value.

    • {"MaxConcurrentCount": N}

      The maximum number of accounts within which multiple stacks are deployed at the same time in each region.

      Valid values of N: 1 to 20.

      If you do not specify MaxConcurrentCount, 1 is used as the default value.

    • {"MaxConcurrentPercentage": N}

      The percentage of the maximum number of accounts within which multiple stacks are deployed at the same time to the total number of accounts in each region.

      Valid values: 1 to 100. If the numeric value in the percentage is not an integer, ROS rounds the number down to the nearest integer.

      If you do not specify MaxConcurrentPercentage, 1 is used as the default value.

    • {"RegionConcurrencyType": N}
      The mode that you want to use to deploy stacks across regions. Valid values:

      • SEQUENTIAL (default): deploys stacks in each specified region based on the specified sequence of regions. ROS deploys stacks in one region at a time.
      • PARALLEL: deploys stacks in parallel across all specified regions.

    Separate multiple parameters with commas (,).

    Note
  • You can specify only one of the following parameters: MaxConcurrentCount and MaxConcurrentPercentage.
  • You can specify only one of the following parameters: FailureToleranceCount and FailureTolerancePercentage.
    •
    		{"FailureToleranceCount": 1, "MaxConcurrentCount": 2}
    TimeoutInMinuteslongNo

    The timeout period within which you can create the stack.

    • Default value: 60.
    • Unit: minutes.
    		10
    DisableRollbackbooleanNo

    Specifies whether to disable rollback when the stack fails to be created.

    Valid values:

    • true
    • false (default)
    		false
    ParameterOverridesarray<object>No

    The parameters that are used to override specific parameters.

    objectNo
    ParameterKeystringYes

    The key of parameter N that you want to use to override a specific parameter. If you do not specify this parameter, ROS uses the name that you specified when you created the stack group.

    Maximum value of N: 200.

    Note
  • ParameterOverrides is optional.
  • If you specify ParameterOverrides, you must specify ParameterOverrides.N.ParameterKey and ParameterOverrides.N.ParameterValue.
    •
    		Amount
    ParameterValuestringYes

    The value of parameter N that you want to use to override a specific parameter. If you do not specify this parameter, ROS uses the value that you specify when you create the stack group.

    Maximum value of N: 200.

    Note
  • ParameterOverrides is optional.
  • If you specify ParameterOverrides, you must specify ParameterOverrides.N.ParameterKey and ParameterOverrides.N.ParameterValue.
    •
    		1
    DeploymentTargetsobjectNo

    The folders in which ROS deploy stacks in service-managed permission model.

    Note You must specify one of the following parameters: AccountIds and DeploymentTargets.
    RdFolderIdsarrayYes

    The folder IDs of the resource directory. You can add up to five folder IDs.

    You can create stacks within all the member accounts in the specified folders. If you create stacks in the Root folder, the stacks are created within all member accounts in the resource directory.

    Note To view the folder IDs, go to the Overview page in the Resource Management console. For more information, see View the basic information about a folder.
    stringNo

    The folder ID of the resource directory. You can add up to five folder IDs.

    You can create stacks within all the member accounts in the specified folders. If you create stacks in the Root folder, the stacks are created within all member accounts in the resource directory.

    Note To view the folder IDs, go to the Overview page in the Resource Management console. For more information, see View the basic information about a folder.
    		["fd-4PvlVLOL8v"]

    For more information about common request parameters, see Common parameters.

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		14A07460-EBE7-47CA-9757-12CC4761D47A
    OperationIdstring

    The ID of the operation.

    		6da106ca-1784-4a6f-a7e1-e723863d****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-06-17The internal configuration of the API is changed, but the call is not affectedView Change Details