调用ListStackInstances接口查询指定资源栈组关联的资源栈列表。

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

调试

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

请求参数

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

要执行的操作。取值：ListStackInstances。
RegionId String 是 cn-hangzhou

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

StackGroupName String 是 MyStackGroup

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

长度不超过255个字符，必须以数字或英文字母开头，可以包含数字、英文字母、短划线（-）和下划线（_）。
StackInstanceAccountId String 否 156552876021****

资源栈所属目标账号ID。

  • 自助管理权限模式下，该账号是阿里云账号。
  • 服务管理权限模式下，该账号是资源目录的成员账号。
    说明 关于目标账号的更多信息，请参见概览。
StackInstanceRegionId String 否 cn-beijing

资源栈所属地域。
PageSize Long 否 10

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

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

分页查询时设置的页码。

  • 起始值：1。
  • 默认值：1。

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

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

资源栈总数。
RequestId String 85DE34BD-7FF9-480F-8C21-556E9DA93ACD

请求ID。
PageSize Integer 1

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

分页查询时设置的页码。
StackInstances Array of StackInstance

资源栈列表。
Status String CURRENT

资源栈的状态。

取值：

  • CURRENT：资源栈是最新的。
  • OUTDATED：资源栈不是资源栈组最新的。可能存在如下原因：
    • 在创建资源栈（CreateStackInstances）操作期间，创建对应的资源栈失败。
    • 在更新资源栈（UpdateStackInstances或UpdateStackGroup）操作期间，更新对应的资源栈失败，或只更新了部分资源栈。
    • 创建或更新操作未完成。
StackGroupId String fd0ddef9-9540-4b42-a464-94f77835****

资源栈组ID。
StackId String 35ad60e3-6a92-42d8-8812-f0700d45****

资源栈所对应的资源栈ID。

说明 仅当资源栈状态为CURRENT时，才会返回该参数。
DriftDetectionTime String 2020-02-27T07:47:47

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

说明 仅当资源栈组做过偏差检测，才会返回该参数。
StackDriftStatus String IN_SYNC

最近一次成功完成偏差检测的资源栈的状态。

取值：

  • DRIFTED：资源栈处于偏差状态。
  • NOT_CHECKED：资源栈未进行过成功的偏差检测。
  • IN_SYNC：资源栈处于同步状态。
说明 仅当资源栈组做过偏差检测，才会返回该参数。
StatusReason String User initiated stop

状态原因描述。

说明 仅当资源栈的实例状态为OUTDATED时，才会返回该参数。
StackGroupName String MyStackGroup

资源栈组名称。
AccountId String 156552876021****

资源栈所属目标账号ID。
RegionId String cn-beijing

资源栈所属地域。
RdFolderId String fd-4PvlVLOL8v

资源目录的资源夹ID。

说明 仅限使用服务管理权限模式的资源栈组，才会返回该参数。

示例

请求示例

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

正常返回示例

XML格式 

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

<ListStackInstancesResponse>
    <TotalCount>1</TotalCount>
    <RequestId>85DE34BD-7FF9-480F-8C21-556E9DA93ACD</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <StackInstances>
        <Status>OUTDATED</Status>
        <AccountId>156552876021****</AccountId>
        <StatusReason>User initiated stop.</StatusReason>
        <StackGroupName>MyStackGroup</StackGroupName>
        <StackGroupId>fd0ddef9-9540-4b42-a464-94f77835****</StackGroupId>
        <RegionId>cn-beijing</RegionId>
    </StackInstances>
</ListStackInstancesResponse>

JSON格式 

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

{
  "TotalCount" : 1,
  "RequestId" : "85DE34BD-7FF9-480F-8C21-556E9DA93ACD",
  "PageSize" : 10,
  "PageNumber" : 1,
  "StackInstances" : [ {
    "Status" : "OUTDATED",
    "AccountId" : "156552876021****",
    "StatusReason" : "User initiated stop.",
    "StackGroupName" : "MyStackGroup",
    "StackGroupId" : "fd0ddef9-9540-4b42-a464-94f77835****",
    "RegionId" : "cn-beijing"
  } ]
}

错误码

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

错误代码

错误信息

HTTP状态码

描述

InvalidParameter

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

400

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

StackGroupNotFound

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

404

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