GetStackGroup - 查询指定资源栈组的信息 - 资源编排

在一个阿里云地域下根据资源栈组名称查询资源栈组详情。

接口说明

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

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	资源栈组所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
StackGroupName	string	否	资源栈组名称。名称在单个地域内唯一。长度不超过 255 个字符，必须以数字或英文字母开头，可包含数字、英文字母、短划线（-）和下划线（_）。说明您必须且仅能指定 StackGroupName 或 StackGroupId 其中一个参数。	MyStackGroup
StackGroupId	string	否	资源栈组 ID。说明您必须且仅能指定 StackGroupName 或 StackGroupId 其中一个参数。	fd0ddef9-9540-4b42-a464-94f77835****

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	14A07460-EBE7-47CA-9757-12CC4761D47A
StackGroup	object	资源栈组详情。
StackGroupId	string	资源栈组 ID。	fd0ddef9-9540-4b42-a464-94f77835****
Status	string	资源栈组状态。取值： ACTIVE：激活。 DELETED：已删除。	ACTIVE
AdministrationRoleName	string	创建自助管理权限模式的资源栈组时，指定的供 ROS 扮演的 RAM 管理员角色名称。若不指定，则默认返回 AliyunROSStackGroupAdministrationRole。	AliyunROSStackGroupAdministrationRole
Parameters	array<object>	资源栈组参数列表。
	object
ParameterKey	string	参数的名称。	Amount
ParameterValue	string	参数的值。	12
Description	string	资源栈组描述。	StackGroup Description
StackGroupName	string	资源栈组名称。	MyStackGroup
ExecutionRoleName	string	创建自助管理权限模式的资源栈组时，需指定的供管理员角色（AliyunROSStackGroupAdministrationRole）扮演的 RAM 执行角色名称。若不指定，则默认返回 AliyunROSStackGroupExecutionRole。	AliyunROSStackGroupExecutionRole
TemplateBody	string	模板主体的结构。说明不建议使用该返回参数，建议使用 TemplateContent 代替。	{"ROSTemplateFormatVersion": "2015-09-01"}
StackGroupDriftDetectionDetail	object	资源栈组最近一次成功完成偏差检测的详情。
DriftDetectionTime	string	资源栈组偏差检测时间。	2020-02-27T07:47:47
TotalStackInstancesCount	integer	资源栈实例的数量。	2
FailedStackInstancesCount	integer	偏差检测失败的资源栈实例的数量。	0
DriftDetectionStatus	string	资源栈组偏差检测状态。取值： COMPLETED：资源栈组偏差检测结束，所有资源栈实例均成功完成了偏差检测。 FAILED：资源栈组偏差检测结束，失败的资源栈实例偏差检测数量超过了设定的阈值。 PARTIAL_SUCCESS：资源栈组偏差检测结束，部分资源栈实例偏差检测失败，但失败数量没有超过阈值。 IN_PROGRESS：资源栈组偏差检测进行中。 STOPPED：用户取消了资源栈组的偏差检测。	COMPLETED
StackGroupDriftStatus	string	资源栈组偏差状态。取值： DRIFTED：至少一个资源栈实例处于偏差状态。 NOT_CHECKED：资源栈组未进行过成功的偏差检测。 IN_SYNC：所有资源栈实例均处于同步状态。	DRIFTED
InProgressStackInstancesCount	integer	偏差检测中的资源栈实例的数量。	0
InSyncStackInstancesCount	integer	处于同步状态的资源栈实例的数量。	1
CancelledStackInstancesCount	integer	取消偏差检测的资源栈实例的数量。	0
DriftedStackInstancesCount	integer	处于偏差状态的资源栈实例的数量。	1
ResourceGroupId	string	资源组 ID。取决于创建资源栈组时，指定的资源组 ID。	rg-acfmxazb4ph6aiy****
PermissionModel	string	授权模式。取值： SELF_MANAGED：自助管理权限模式。 SERVICE_MANAGED：服务管理权限模式。说明关于资源栈组的授权模式，请参见概览。	SELF_MANAGED
AutoDeployment	object	自动部署设置信息。说明仅当 PermissionModel 为 SERVICE_MANAGED 时，才会返回此参数。
Enabled	boolean	启用或者禁用自动部署。取值： true：启用自动部署。启用自动部署后，如果目标资源夹中新增了成员账号，资源栈组会自动将资源栈实例部署到目标资源夹中新增账户的指定地域下。如果从目标资源夹中删除账户，资源栈组将从此账户的指定地域中删除资源栈实例。 false：禁用自动部署。禁用自动部署后，目标资源夹中成员账号变动时资源栈实例不会发生变化。	true
RetainStacksOnAccountRemoval	boolean	目标资源夹中删除成员账号时，是否保留成员账号中的资源栈。取值： true：保留资源栈。 false：删除资源栈。说明仅当 Enabled 返回 true 时，才会返回此参数。	true
RdFolderIds	array	资源目录中的目标资源夹 ID 列表。用于将资源栈实例部署在此资源夹中的所有账号中。说明仅当 PermissionModel 为 SERVICE_MANAGED 时，才会返回此参数。
	string	资源目录中的目标资源夹 ID 列表。用于将资源栈实例部署在此资源夹中的所有账号中。说明仅当 PermissionModel 为 SERVICE_MANAGED 时，才会返回此参数。	["fd-4PvlVLOL8v"]
TemplateContent	string	模板主体的结构，JSON 格式。更多信息，请参见模板语法。	{ "ROSTemplateFormatVersion": "2015-09-01" }
CreateTime	string	资源栈组创建时间。	2024-06-14T02:13:50
UpdateTime	string	资源栈组更新时间。	2024-06-15T02:01:00

示例

正常返回示例

JSON格式

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroup": {
    "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
    "Status": "ACTIVE",
    "AdministrationRoleName": "AliyunROSStackGroupAdministrationRole",
    "Parameters": [
      {
        "ParameterKey": "Amount",
        "ParameterValue": "12"
      }
    ],
    "Description": "StackGroup Description",
    "StackGroupName": "MyStackGroup",
    "ExecutionRoleName": "AliyunROSStackGroupExecutionRole",
    "TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
    "StackGroupDriftDetectionDetail": {
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "TotalStackInstancesCount": 2,
      "FailedStackInstancesCount": 0,
      "DriftDetectionStatus": "COMPLETED",
      "StackGroupDriftStatus": "DRIFTED",
      "InProgressStackInstancesCount": 0,
      "InSyncStackInstancesCount": 1,
      "CancelledStackInstancesCount": 0,
      "DriftedStackInstancesCount": 1
    },
    "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
    "PermissionModel": "SELF_MANAGED",
    "AutoDeployment": {
      "Enabled": true,
      "RetainStacksOnAccountRemoval": true
    },
    "RdFolderIds": [
      "[\"fd-4PvlVLOL8v\"]"
    ],
    "TemplateContent": "{\n      \"ROSTemplateFormatVersion\": \"2015-09-01\"\n}",
    "CreateTime": "2024-06-14T02:13:50",
    "UpdateTime": "2024-06-15T02:01:00"
  }
}

错误码

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

变更历史

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

错误代码	错误信息	HTTP 状态码	描述
StackGroupNotFound	The StackGroup ({name}) could not be found.	404	资源栈组不存在。name 为资源栈组名称。