文档

ListStackInstances - 查询指定资源栈组关联的资源栈实例列表

更新时间:

在一个阿里云地域下查询指定资源栈组关联的资源栈实例列表详情。

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
StackGroupNamestring

资源栈组名称。名称在单个地域内唯一。
长度不超过 255 个字符,必须以数字或英文字母开头,可以包含数字、英文字母、短划线(-)和下划线(_)。

MyStackGroup
StackInstanceAccountIdstring

资源栈所属目标账号 ID。

  • 自助管理权限模式下,该账号是阿里云账号。

  • 服务管理权限模式下,该账号是资源目录的成员账号。

说明 关于目标账号的更多信息,请参见概览
156552876021****
StackInstanceRegionIdstring

资源栈所属地域。

cn-beijing
PageSizelong

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

  • 取值范围:1~50。

  • 默认值:10。

10
PageNumberlong

分页查询时设置的页码。

  • 起始值:1。

  • 默认值:1。

1

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

返回参数

名称类型描述示例值
object
TotalCountinteger

资源栈总数。

1
RequestIdstring

请求 ID。

85DE34BD-7FF9-480F-8C21-556E9DA93ACD
PageSizeinteger

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

1
PageNumberinteger

分页查询时设置的页码。

1
StackInstancesobject []

资源栈列表。

Statusstring

资源栈的状态。

取值:

  • CURRENT:资源栈是最新的。

  • OUTDATED:资源栈不是资源栈组最新的。可能存在如下原因:

    • 在创建资源栈(CreateStackInstances)操作期间,创建对应的资源栈失败。
    • 在更新资源栈(UpdateStackInstances 或 UpdateStackGroup)操作期间,更新对应的资源栈失败,或只更新了部分资源栈。
    • 创建或更新操作未完成。
CURRENT
StackGroupIdstring

资源栈组 ID。

fd0ddef9-9540-4b42-a464-94f77835****
StackIdstring

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

说明 仅当资源栈状态为 CURRENT 时,才会返回该参数。
35ad60e3-6a92-42d8-8812-f0700d45****
DriftDetectionTimestring

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

说明 仅当资源栈组做过偏差检测,才会返回该参数。
2020-02-27T07:47:47
StackDriftStatusstring

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

取值:

  • DRIFTED:资源栈处于偏差状态。
  • NOT_CHECKED:资源栈未进行过成功的偏差检测。
  • IN_SYNC:资源栈处于同步状态。
说明 仅当资源栈组做过偏差检测,才会返回该参数。
IN_SYNC
StatusReasonstring

状态原因描述。

说明 仅当资源栈的实例状态为 OUTDATED 时,才会返回该参数。
User initiated stop
StackGroupNamestring

资源栈组名称。

MyStackGroup
AccountIdstring

资源栈所属目标账号 ID。

156552876021****
RegionIdstring

资源栈所属地域。

cn-beijing
RdFolderIdstring

资源目录的资源夹 ID。

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

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "85DE34BD-7FF9-480F-8C21-556E9DA93ACD",
  "PageSize": 1,
  "PageNumber": 1,
  "StackInstances": [
    {
      "Status": "CURRENT",
      "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
      "StackId": "35ad60e3-6a92-42d8-8812-f0700d45****",
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "StackDriftStatus": "IN_SYNC",
      "StatusReason": "User initiated stop",
      "StackGroupName": "MyStackGroup",
      "AccountId": "156552876021****",
      "RegionId": "cn-beijing",
      "RdFolderId": "fd-4PvlVLOL8v"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
错误代码错误信息HTTP 状态码描述
InvalidParameterThe specified parameter {name} is invalid, {reason}.400无效参数,name 为参数名,reason 为原因。
StackGroupNotFoundThe StackGroup ({name}) could not be found.404资源栈组不存在。name 为资源栈组名称。
  • 本页导读 (1)
文档反馈