调用ListStackGroups查询资源栈组列表_资源编排(ROS)-阿里云帮助中心

在一个阿里云地域下查询资源栈组列表详情。

接口说明

本文将提供一个示例，查询杭州地域处于激活状态的资源栈组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ros:ListStackGroups	get	StackGroup acs:ros:{#regionId}:{#accountId}:stackgroup/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	资源栈组所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
Status	string	否	资源栈组状态。如果未指定，则查询该地域下所有状态的资源栈组。取值： ACTIVE：已激活。 DELETED：已删除。	ACTIVE
PageSize	long	否	分页查询时设置的每页行数。取值范围：1~50。默认值：10。	10
PageNumber	long	否	分页查询时设置的页码。起始值：1。默认值：1。	1
ResourceGroupId	string	否	资源组 ID。如果未指定，则查询所有资源组中的资源栈组。说明资源组 ID 可以从资源管理控制台的资源组页面下获取。具体操作，请参见查看资源组基本信息。	rg-acfmzawhxxcj****
Tags	array<object>	否	资源栈组的标签。
	object	否
Key	string	是	资源栈组的标签键。说明 Tags 为可选参数。如果需要指定 Tags，则 Tags.N.Key 必须指定。	usage
Value	string	否	资源栈组的标签值。	test

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

返回参数

名称	类型	描述	示例值
	object
StackGroups	array<object>	资源栈组列表。
	object
StackGroupId	string	资源栈组 ID。	fd0ddef9-9540-4b42-a464-94f77835****
Status	string	资源栈组状态。取值： ACTIVE：已激活。 DELETED：已删除。	ACTIVE
DriftDetectionTime	string	资源栈组最近一次成功执行偏差检测的时间。	2020-02-27T07:47:47
Description	string	资源栈组描述。	My Stack Group
StackGroupDriftStatus	string	资源栈组在最近一次成功执行的偏差检测中的偏差状态。取值： DRIFTED：存在偏差。 NOT_CHECKED：未检测偏差。 IN_SYNC：不存在偏差。	IN_SYNC
StackGroupName	string	资源栈组名称。	MyStackGroup
Tags	array<object>	资源栈组的标签。
	object
Key	string	资源栈组的标签键。	usage1
Value	string	资源栈组的标签值。	test1
ResourceGroupId	string	资源组 ID。	rg-acfmzawhxxcj****
PermissionModel	string	授权模式。取值： SELF_MANAGED：自助管理权限模式。 SERVICE_MANAGED：服务管理权限模式。说明关于资源栈组的授权模式，请参见概览。	SELF_MANAGED
AutoDeployment	object	自动部署设置信息。
Enabled	boolean	启用或者禁用自动部署。取值： true：启用自动部署。启用自动部署后，如果目标资源夹中新增了成员账号，资源栈组会自动将资源栈实例部署到目标资源夹中新增账户的指定地域下。如果从目标资源夹中删除账户，资源栈组将从此账户的指定地域中删除资源栈实例。 false：禁用自动部署。禁用自动部署后，目标资源夹中成员账号变动时资源栈实例不会发生变化。	true
RetainStacksOnAccountRemoval	boolean	目标资源夹中删除成员账号时，是否保留成员账号中的资源栈。取值： true：保留资源栈。 false：删除资源栈。说明仅当 Enabled 返回 true 时，才会返回 RetainStacksOnAccountRemoval。	true
CreateTime	string	资源栈组创建时间。	2024-01-05T05:38:31
UpdateTime	string	资源栈组更新时间。	2024-02-15T16:40:25
TotalCount	integer	资源栈组总数。	1
RequestId	string	请求 ID。	14A07460-EBE7-47CA-9757-12CC4761D47A
PageSize	integer	分页查询时设置的每页行数。	10
PageNumber	integer	分页查询时设置的页码。	1

示例

正常返回示例

JSON格式

{
  "StackGroups": [
    {
      "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
      "Status": "ACTIVE",
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "Description": "My Stack Group",
      "StackGroupDriftStatus": "IN_SYNC",
      "StackGroupName": "MyStackGroup",
      "Tags": [
        {
          "Key": "usage1",
          "Value": "test1"
        }
      ],
      "ResourceGroupId": "rg-acfmzawhxxcj****",
      "PermissionModel": "SELF_MANAGED",
      "AutoDeployment": {
        "Enabled": true,
        "RetainStacksOnAccountRemoval": true
      },
      "CreateTime": "2024-01-05T05:38:31",
      "UpdateTime": "2024-02-15T16:40:25"
    }
  ],
  "TotalCount": 1,
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "PageSize": 10,
  "PageNumber": 1
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-10	OpenAPI 返回结构发生变更	查看变更详情

错误代码	错误信息	HTTP 状态码	描述
InvalidParameter	The specified parameter {name} is invalid, {reason}.	400	无效参数，name 为参数名，reason 为原因。