CreateStackGroup_资源编排_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

资源栈组是针对 ROS 资源栈的管理单元。

授权模式

资源编排为您提供自助管理权限和服务管理权限两种模式创建资源栈组, 您可以使用管理员账号在不同地域下创建资源栈组,实现跨账号、跨地域的创建资源栈。更多信息,请参见概览

自助管理权限模式

请先为管理员账号和目标账号分别创建 RAM 角色并建立二者之间的联系。具体操作,请参见授权自助管理权限

当管理员账号(账号 A)在杭州地域下创建一个自助管理权限模式的资源栈组,可以在杭州地域和北京地域分别为目标账号(账号 B 和账号 C)创建对应的资源栈。其中管理员账号和目标账号均为阿里云账号。更多信息,请参见概览

当您选择该模式时,请输入 PermissionModel 参数为 SELF_MANAGED,并配置 AdministrationRoleName 和 ExecutionRoleName 等相关参数。

服务管理权限模式

您可以使用企业管理账号或委派管理员账号创建服务管理权限模式的资源栈组。更多信息,请参见设置委派管理员账号

管理员账号(账号 A)在杭州地域创建一个服务管理权限模式的资源栈组,在杭州地域和北京地域分别为资源目录中指定的资源夹创建资源栈,此时 ROS 会自动获取资源夹中的所有成员账号(账号 B 和账号 C)为目标账号。其中管理员账号是资源目录的企业管理账号或委派管理员账号,目标账号是资源目录的成员账号。更多信息,请参见概览

当您选择该模式时,请输入 PermissionModel 参数为 SERVICE_MANAGED,并完成相关参数配置。

您可以在创建服务管理权限模式的资源栈组时,开启自动部署。当对应资源夹中有新账号加入或账号移除时,ROS 将会自动对资源栈实例进行创建或删除。

本文将提供一个示例,在杭州地域cn-hangzhou使用 ID 为5ecd1e10-b0e9-4389-a565-e4c15efc****的模板创建一个名为MyStackGroup的资源栈组,其使用自助管理权限模式。

流控信息

请求速率为100/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ros:CreateStackGroup
Create
StackGroup
acs:ros:{#regionId}:{#accountId}:stackgroup/{#StackGroupName}

请求参数

字段名称字段详情
RegionIdstring

资源栈组所属的地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
StackGroupNamestring

资源栈组名称。名称在单个地域内唯一。 展开详情

示例值:MyStackGroup参考取值来源:
    GetStackGroup
    ListStackGroups
    ImportStacksToStackGroup
    CreateStackInstances
Descriptionstring

资源栈组描述。 展开详情

示例值:StackGroup Description
TemplateBodystring

模板主体的结构。长度为 1~524,288 个字节。如果长度较大,则建议通过 HTTP POST+Body Param 的方式,将参数放在请求体中进行传递,避免因 URL 过长而导致请求失败。 展开详情

示例值:{"ROSTemplateFormatVersion":"2015-09-01"}参考取值来源:
    GetTemplate
    UpdateStackTemplateByResources
    GenerateTemplateByScratch
TemplateURLstring

包含模板主体的文件的位置。URL 必须指向位于 HTTP Web 服务器(HTTP 或 HTTPS)或阿里云 OSS 存储桶中的模板(1~524,288 个字节)。OSS 存储桶的 URL,例如 oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou。如未指定 OSS 地域,默认与接口参数 RegionId 相同。展开详情

示例值:oss://ros-template/demo
ClientTokenstring

保证请求的幂等性。该值由客户端生成,并且必须是全局唯一的。 展开详情

示例值:123e4567-e89b-12d3-a456-42665544****
AdministrationRoleNamestring

创建自助管理权限模式的资源栈组时,需指定的供 ROS 扮演的 RAM 管理员角色名称。若不指定,则使用 AliyunROSStackGroupAdministrationRole 作为默认值。ROS 以该角色身份进一步扮演执行角色(AliyunROSStackGroupExecutionRole)来操作资源栈组中资源栈实例所对应的资源栈。展开详情

示例值:AliyunROSStackGroupAdministrationRole
ExecutionRoleNamestring

创建自助管理权限模式的资源栈组时,需指定的供管理员角色(AliyunROSStackGroupAdministrationRole)扮演的 RAM 执行角色名称。若不指定,则使用 AliyunROSStackGroupExecutionRole 作为默认值。ROS 以该角色身份来操作资源栈组中资源栈实例所对应的资源栈。展开详情

示例值:AliyunROSStackGroupExecutionRole
TemplateIdstring

模板 ID。支持共享模板和私有模板。展开详情

示例值:5ecd1e10-b0e9-4389-a565-e4c15efc****参考取值来源:
    GetTemplate
    UpdateTemplate
    ListTemplates
    CreateTemplate
TemplateVersionstring

模板版本。如果不指定,默认取最新版本。展开详情

示例值:v1参考取值来源:
    ListTemplateVersions
    GetTemplate
    UpdateTemplate
Parametersarray<object>

资源栈组参数列表。

子级条数 <= 200
ResourceGroupIdstring

资源组 ID。如果不指定该参数,资源栈组将加入默认资源组。 展开详情

示例值:rg-acfmxazb4ph6aiy****参考取值来源:
    GetStackGroup
    ListStackGroups
PermissionModelstring

授权模式。展开详情

示例值:SELF_MANAGED
Tagsarray<object>

资源栈组的标签。

子级条数 <= 20
AutoDeploymentobject

自动部署设置信息。展开详情

示例值:{"Enabled": true, "RetainStacksOnAccountRemoval": true}
Capabilitiesarray<string>

资源栈组选项列表,最大长度为 1。

子级条数 <= 1
StackArnstring

资源栈的 ARN,形如 acs:ros:${RegionId}:${AccountId}:stack/${StackId}。资源栈组将根据此资源栈的模板和参数进行创建。展开详情

示例值:acs:ros:cn-hangzhou:175458000000****:stack/4a65f506-c3cc-43b6-af06-3f000000****

请求说明

关于公共请求参数的详情,请参见公共参数

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:14A07460-EBE7-47CA-9757-12CC4761D47A
StackGroupIdstring

资源栈组 ID。

示例值:2c036e78-9e82-428e-afd6-177f5d04****

返回示例

变更历史

变更时间变更内容概要操作
2024-09-12
新增请求参数StackArn
2024-01-11
变更请求参数TemplateBody
2023-05-10
新增请求参数Capabilities
2022-10-27
新增请求参数Tags
  • 1
  • 2
  • 10 条/页

相关示例

调用CreateStackGroup接口创建资源栈组。
2022-09-19