调用GetStackGroup接口查询指定资源栈组的信息。

本文将提供一个示例,查询杭州地域已有的自助管理权限模式的资源栈组MyStackGroup的信息。

调试

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

请求参数

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

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

RegionId String cn-hangzhou

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

StackGroupName String MyStackGroup

资源栈组名称。名称在单个地域内唯一。

长度不超过255个字符,必须以数字或英文字母开头,可包含数字、英文字母、短划线(-)和下划线(_)。

说明 您必须且仅能指定StackGroupName或StackGroupId其中一个参数。
StackGroupId String fd0ddef9-9540-4b42-a464-94f77835****

资源栈组ID。

说明 您必须且仅能指定StackGroupName或StackGroupId其中一个参数。

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

返回数据

名称 类型 示例值 描述
RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A

请求ID。

StackGroup Object

资源栈组详情。

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

资源栈组ID。

Status String ACTIVE

资源栈组状态。

取值:

  • ACTIVE:激活。
  • DELETED:已删除。
AdministrationRoleName String AliyunROSStackGroupAdministrationRole

创建自助管理权限模式的资源栈组时,指定的供ROS扮演的RAM管理员角色名称。若不指定,则默认返回AliyunROSStackGroupAdministrationRole。

Parameters Array of Parameter

资源栈组参数列表。

ParameterKey String Amount

参数的名称。

ParameterValue String 12

参数的值。

Description String StackGroup Description

资源栈组描述。

StackGroupName String MyStackGroup

资源栈组名称。

ExecutionRoleName String AliyunROSStackGroupExecutionRole

创建自助管理权限模式的资源栈组时,需指定的供管理员角色(AliyunROSStackGroupAdministrationRole)扮演的RAM执行角色名称。若不指定,则默认返回AliyunROSStackGroupExecutionRole。

TemplateBody String {"ROSTemplateFormatVersion": "2015-09-01"}

模板主体的结构。

StackGroupDriftDetectionDetail Object

资源栈组最近一次成功完成偏差检测的详情。

DriftDetectionTime String 2020-02-27T07:47:47

资源栈组偏差检测时间。

TotalStackInstancesCount Integer 2

资源栈实例的数量。

FailedStackInstancesCount Integer 0

偏差检测失败的资源栈实例的数量。

DriftDetectionStatus String COMPLETED

资源栈组偏差检测状态。

取值:

  • COMPLETED:资源栈组偏差检测结束,所有资源栈实例均成功完成了偏差检测。
  • FAILED:资源栈组偏差检测结束,失败的资源栈实例偏差检测数量超过了设定的阈值。
  • PARTIAL_SUCCESS:资源栈组偏差检测结束,部分资源栈实例偏差检测失败,但失败数量没有超过阈值。
  • IN_PROGRESS:资源栈组偏差检测进行中。
  • STOPPED:用户取消了资源栈组的偏差检测。
StackGroupDriftStatus String DRIFTED

资源栈组偏差状态。

取值:

  • DRIFTED:至少一个资源栈实例处于偏差状态。
  • NOT_CHECKED:资源栈组未进行过成功的偏差检测。
  • IN_SYNC:所有资源栈实例均处于同步状态。
InProgressStackInstancesCount Integer 0

偏差检测中的资源栈实例的数量。

InSyncStackInstancesCount Integer 1

处于同步状态的资源栈实例的数量。

CancelledStackInstancesCount Integer 0

取消偏差检测的资源栈实例的数量。

DriftedStackInstancesCount Integer 1

处于偏差状态的资源栈实例的数量。

ResourceGroupId String rg-acfmxazb4ph6aiy****

资源组ID。取决于创建资源栈组时,指定的资源组ID。

PermissionModel String SELF_MANAGED

授权模式。

取值:

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

自动部署设置信息。

说明 仅当PermissionModel为SERVICE_MANAGED时,才会返回此参数。
Enabled Boolean true

启用或者禁用自动部署。

取值:

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

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

取值:

  • true:保留资源栈。
  • false:删除资源栈。
说明 仅当Enabled返回true时,才会返回此参数。
RdFolderIds Array of String ["fd-4PvlVLOL8v"]

资源目录中的目标资源夹ID列表。用于将资源栈实例部署在此资源夹中的所有账号中。

说明 仅当PermissionModel为SERVICE_MANAGED时,才会返回此参数。

示例

请求示例

http(s)://ros.aliyuncs.com/?Action=GetStackGroup
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&<公共请求参数>

正常返回示例

XML格式

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

<GetStackGroupResponse>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <StackGroup>
        <Status>ACTIVE</Status>
        <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
        <StackGroupName>MyStackGroup</StackGroupName>
        <StackGroupId>fd0ddef9-9540-4b42-a464-94f77835****</StackGroupId>
        <AdministrationRoleName>AliyunROSStackGroupAdministrationRole</AdministrationRoleName>
        <TemplateBody>
            <ROSTemplateFormatVersion>2015-09-01</ROSTemplateFormatVersion>
        </TemplateBody>
        <PermissionModel>SELF_MANAGED</PermissionModel>
        <ExecutionRoleName>AliyunROSStackGroupExecutionRole</ExecutionRoleName>
    </StackGroup>
</GetStackGroupResponse>

JSON格式

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

{
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroup" : {
    "Status" : "ACTIVE",
    "Parameters" : [ ],
    "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
    "StackGroupName" : "MyStackGroup",
    "StackGroupId" : "fd0ddef9-9540-4b42-a464-94f77835****",
    "AdministrationRoleName" : "AliyunROSStackGroupAdministrationRole",
    "TemplateBody" : {
      "ROSTemplateFormatVersion" : "2015-09-01"
    },
    "PermissionModel" : "SELF_MANAGED",
    "ExecutionRoleName" : "AliyunROSStackGroupExecutionRole"
  }
}

错误码

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

错误代码

错误信息

HTTP状态码

描述

StackGroupNotFound

The StackGroup ({name}) could not be found.

404

资源栈组不存在。name为资源栈组名称。