调用ListStackGroups接口查询资源栈组列表。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListStackGroups

要执行的操作。取值:ListStackGroups。

RegionId String cn-hangzhou

资源栈组所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

Status String ACTIVE

资源栈组状态。如果未指定,则查询该地域下所有状态的资源栈组。

取值:

  • ACTIVE:已激活。
  • DELETED:已删除。
PageSize Long 10

分页查询时设置的每页行数。

  • 取值范围:1~50。
  • 默认值:10。
PageNumber Long 1

分页查询时设置的页码。

  • 起始值:1。
  • 默认值:1。
ResourceGroupId String rg-acfmzawhxxcj****

资源组ID。如果未指定,则查询所有资源组中的资源栈组。

说明 资源组ID可以从资源管理控制台的资源组页面下获取。具体操作,请参见查看资源组基本信息

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

返回数据

名称 类型 示例值 描述
StackGroups Array of StackGroup

资源栈组列表。

StackGroupId String fd0ddef9-9540-4b42-a464-94f77835****

资源栈组ID。

Status String ACTIVE

资源栈组状态。

取值:

  • ACTIVE:已激活。
  • DELETED:已删除。
DriftDetectionTime String 2020-02-27T07:47:47

资源栈组最近一次成功执行偏差检测的时间。

Description String My Stack Group

资源栈组描述。

StackGroupDriftStatus String IN_SYNC

资源栈组在最近一次成功执行的偏差检测中的偏差状态。

取值:

  • DRIFTED:存在偏差。
  • NOT_CHECKED:未检测偏差。
  • IN_SYNC:不存在偏差。
StackGroupName String MyStackGroup

资源栈组名称。

ResourceGroupId String rg-acfmzawhxxcj****

资源组ID。

PermissionModel String SELF_MANAGED

授权模式。

取值:

  • SELF_MANAGED:自助管理权限模式。
  • SERVICE_MANAGED:服务管理权限模式。
说明 关于资源栈组的授权模式,请参见概览
AutoDeployment Object

自动部署设置信息。

Enabled Boolean true

启用或者禁用自动部署。

取值:

  • true:启用自动部署。启用自动部署后,如果目标资源夹中新增了成员账号,资源栈组会自动将资源栈实例部署到目标资源夹中新增账户的指定地域下。如果从目标资源夹中删除账户,资源栈组将从此账户的指定地域中删除资源栈实例。
  • false:禁用自动部署。禁用自动部署后,目标资源夹中成员账号变动时资源栈实例不会发生变化。
RetainStacksOnAccountRemoval Boolean true

目标资源夹中删除成员账号时,是否保留成员账号中的资源栈。

取值:

  • true:保留资源栈。
  • false:删除资源栈。
说明 仅当Enabled返回true时,才会返回RetainStacksOnAccountRemoval。
TotalCount Integer 1

资源栈组总数。

RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A

请求ID。

PageSize Integer 10

分页查询时设置的每页行数。

PageNumber Integer 1

分页查询时设置的页码。

示例

请求示例

http(s)://ros.aliyuncs.com/?Action=ListStackGroups
&RegionId=cn-hangzhou
&Status=ACTIVE
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListStackGroupsResponse>
    <StackGroups>
        <Status>ACTIVE</Status>
        <StackGroupDriftStatus>NOT_CHECKED</StackGroupDriftStatus>
        <AutoDeployment/>
        <ResourceGroupId>rg-acfmzawhxxcj****</ResourceGroupId>
        <PermissionModel>SELF_MANAGED</PermissionModel>
        <StackGroupName>MyStackGroup</StackGroupName>
        <StackGroupId>fd0ddef9-9540-4b42-a464-94f77835****</StackGroupId>
    </StackGroups>
    <TotalCount>1</TotalCount>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
</ListStackGroupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "StackGroups" : [ {
    "Status" : "ACTIVE",
    "StackGroupDriftStatus" : "NOT_CHECKED",
    "AutoDeployment" : { },
    "ResourceGroupId" : "rg-acfmzawhxxcj****",
    "PermissionModel" : "SELF_MANAGED",
    "StackGroupName" : "MyStackGroup",
    "StackGroupId" : "fd0ddef9-9540-4b42-a464-94f77835****"
  } ],
  "TotalCount" : 1,
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "PageSize" : 10,
  "PageNumber" : 1
}

错误码

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

错误代码

错误信息

HTTP状态码

描述

InvalidParameter

The specified parameter {name} is invalid, {reason}.

400

无效参数,name为参数名,reason为原因。