文档首页/ 资源编排服务 RFS/ API参考（吉隆坡区域）/ API/ 资源栈集/ 列举资源栈实例
更新时间：2024-12-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

列举资源栈实例

功能介绍

列举资源栈实例（ListStackInstances）

此API用于列举指定资源栈集下指定局点（region）或指定成员账户（stack_domain_id）或全部资源栈实例

  • 可以使用filter作为过滤器，过滤出指定局点（region）或指定成员账户（stack_domain_id）下的资源栈实例
  • 可以使用sort_key和sort_dir两个关键字对返回结果按创建时间（create_time）进行排序。给予的sort_key和sort_dir数量须一致，否则返回400。如果未给予sort_key和sort_dir，则默认按照创建时间降序排序。
  • 如果指定资源栈集下没有任何资源栈实例，则返回空list

URI

GET /v1/stack-sets/{stack_set_name}/stack-instances

表1 路径参数

参数

是否必选

参数类型

描述

stack_set_name

是

String

资源栈集的名称。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

最小长度：1

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

stack_set_id

否

String

资源栈集（stack_set）的唯一ID。

此ID由资源编排服务在生成资源栈集的时候生成，为UUID。

由于资源栈集名称仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，再重新创建一个同名资源栈集。

对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我认为的那个，而不是其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。

资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400

最小长度：36

最大长度：36

filter

否

String

过滤条件

  • 与（AND）运算符使用逗号（，）定义
  • 或（OR）运算符使用竖线（|）定义，OR运算符优先级高于AND运算符
  • 不支持括号
  • 过滤运算符仅支持双等号（==）
  • 过滤参数名及其值仅支持包含大小写英文、数字和下划线
  • 过滤条件中禁止使用分号，如果有分号，则此条过滤会被忽略
  • 一个过滤参数仅能与一个与条件相关，一个与条件中的多个或条件仅能与一个过滤参数相关

最小长度：0

最大长度：512

sort_key

否

Array

排序字段，仅支持给予create_time

最小长度：1

枚举值：

  • create_time

sort_dir

否

Array

指定升序还是降序

  • asc - 升序
  • desc - 降序

最小长度：1

枚举值：

  • asc
  • desc

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

是

String

用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID

最小长度：36

最大长度：128

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

stack_instances

Array of StackInstance objects

资源栈实例列表
表5 StackInstance

参数

参数类型

描述

stack_set_id

String

资源栈集（stack_set）的唯一ID。

此ID由资源编排服务在生成资源栈集的时候生成，为UUID。

由于资源栈集名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，在重新创建一个同名资源栈集。

对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我以为的那个，而不是又其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。

资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400

最小长度：36

最大长度：36

stack_set_name

String

资源栈集（stack_set）的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

最小长度：1

最大长度：128

status

String

资源栈实例的状态

  • WAIT_IN_PROGRESS - 资源栈实例等待操作中
  • CANCEL_COMPLETE - 资源栈实例操作取消完成
  • OPERATION_IN_PROGRESS - 资源栈实例操作中
  • OPERATION_FAILED - 资源栈实例操作失败
  • INOPERABLE - 资源栈实例不可操作
  • OPERATION_COMPLETE - 资源栈实例操作完成

枚举值：

  • WAIT_IN_PROGRESS
  • CANCEL_COMPLETE
  • OPERATION_IN_PROGRESS
  • OPERATION_FAILED
  • INOPERABLE
  • OPERATION_COMPLETE

status_message

String

在资源栈实例状态为INOPERABLE或OPERATION_FAILED时，会显示简要的错误信息总结以供debug

stack_id

String

资源栈（stack）的唯一ID。

此ID由资源编排服务在生成资源栈的时候生成，为UUID。

由于资源栈名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈，删除，再重新创建一个同名资源栈。

对于团队并行开发，用户可能希望确保，当前我操作的资源栈就是我认为的那个，而不是其他队友删除后创建的同名资源栈。因此，使用ID就可以做到强匹配。

资源编排服务保证每次创建的资源栈所对应的ID都不相同，更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致，则返回400

stack_name

String

资源栈的名称。此名字在domain_id+区域+project_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

最小长度：1

最大长度：128

stack_domain_id

String

资源栈实例所关联的资源栈所在的租户ID

latest_stack_set_operation_id

String

最新一次部署该资源栈实例的资源栈集操作ID。

此ID由资源编排服务在生成资源栈集操作的时候生成，为UUID。

region

String

资源栈实例所关联的资源栈所在的区域

create_time

String

资源栈实例的创建时间，格式为YYYY-MM-DDTHH:mm:ss.SSSZ，精确到毫秒，UTC时区，即，如1970-01-01T00:00:00.000Z。

update_time

String

资源栈实例的更新时间，格式为YYYY-MM-DDTHH:mm:ss.SSSZ，精确到毫秒，UTC时区，即，如1970-01-01T00:00:00.000Z。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 429

表10 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

请求示例

  • 通过filter获取指定资源栈集在成员账户domainA和domainB下的资源栈实例 
    GET https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances?filter=stack_domain_id==stackDomainIdA|stack_domain_id==stackDomainIdB
  • 通过sort_key和sort_dir指定返回的资源栈实例列表，以创建时间升序返回 
    GET https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances?sort_key=create_time&sort_dir=asc

响应示例

状态码： 200

列举资源栈实例成功

{
  "stack_instances" : [ {
    "stack_set_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
    "stack_set_name" : "my_hello_world_stack_set",
    "latest_stack_set_operation_id" : "3fef5d3e-27b6-44e8-9769-1d7262bd9430",
    "status" : "OPERATION_COMPLETE",
    "stack_id" : "ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2",
    "stack_name" : "my_hello_world_stack",
    "stack_domain_id" : "6cbcca2a2f114a63841bdbc7a19b7b09",
    "region" : "region_id",
    "create_time" : "2023-05-17T15:39:25.210Z",
    "update_time" : "2023-05-18T16:39:25.210Z"
  }, {
    "stack_set_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
    "stack_set_name" : "my_hello_world_stack_set",
    "latest_stack_set_operation_id" : "fb5e781e-a27d-46e2-9954-242753857a9f",
    "status" : "OPERATION_FAILED",
    "status_message" : "Deploy stack failed",
    "stack_id" : "4abf1770-2760-4339-9c18-427fa115db6a",
    "stack_name" : "my_hello_world_stack",
    "stack_domain_id" : "6cbcca2a2f114a63841bdbc7a19b7b12",
    "region" : "region_id",
    "create_time" : "2023-05-15T15:39:25.210Z",
    "update_time" : "2023-05-16T16:39:25.210Z"
  } ]
}

状态码

状态码

描述

200

列举资源栈实例成功

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

资源栈集不存在

429

请求数量过多

500

服务器内部错误
父主题： 资源栈集