文档首页> 资源编排服务 RFS> API参考> 资源编排API> 资源栈集> 列举资源栈集
更新时间：2024-06-28 GMT+08:00
查看PDF

列举资源栈集

功能介绍

列举资源栈集（ListStackSets）

此API用于列举当前用户（domain）当前局点（region）下全部资源栈集。

  • 可以使用filter作为过滤器，过滤出指定权限模型（permission_model）下的资源栈集。

  • 可以使用sort_key和sort_dir两个关键字对返回结果按创建时间（create_time）进行排序。给予的sort_key和sort_dir数量须一致，否则返回400。如果未给予sort_key和sort_dir，则默认按照创建时间降序排序。

  • 注意：目前暂时返回全量资源栈集信息，即不支持分页

  • 如果没有任何资源栈集，则返回空list

URI

GET /v1/stack-sets

表1 Query参数

参数

是否必选

参数类型

描述

filter

否

String

过滤条件

  • 与（AND）运算符使用逗号（，）定义

  • 或（OR）运算符使用竖线（|）定义，OR运算符优先级高于AND运算符

  • 不支持括号

  • 过滤运算符仅支持双等号（==）

  • 过滤参数名及其值仅支持包含大小写英文、数字和下划线

  • 过滤条件中禁止使用分号，如果有分号，则此条过滤会被忽略

  • 一个过滤参数仅能与一个与条件相关，一个与条件中的多个或条件仅能与一个过滤参数相关

最小长度：0

最大长度：512

sort_key

否

Array

排序字段，仅支持给予create_time

最小长度：1

枚举值：

  • create_time

sort_dir

否

Array

指定升序还是降序

  • asc - 升序

  • desc - 降序

最小长度：1

枚举值：

  • asc

  • desc

call_identity

否

String

仅支持资源栈集权限模式为SERVICE_MANAGED时指定该参数。用于指定用户是以组织管理账号还是成员帐户中的服务委托管理员身份调用资源栈集。默认为SELF。

  • 无论指定何种用户身份，创建或部署的资源栈集始终在组织管理账号名下。*

    • SELF - 以组织管理账号身份调用。

    • DELEGATED_ADMIN - 以服务委托管理员身份调用。用户的华为云账号必须在组织中已经被注册为”资源编排资源栈集服务“的委托管理员。

枚举值：

  • SELF

  • DELEGATED_ADMIN

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

是

String

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

最小长度：36

最大长度：128

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

stack_sets

Array of StackSet objects

资源栈集
表4 StackSet

参数

参数类型

描述

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

stack_set_description

String

资源栈集的描述。可用于客户识别自己的资源栈集。

最小长度：0

最大长度：1024

permission_model

String

权限模型，定义了RFS操作资源栈集时所需委托的创建方式，枚举值，默认为SELF_MANAGED。用户可以使用创建资源栈集（CreateStackSet）API 指定该参数。该参数暂不支持更新。用户如果想要更新权限模型，可以通过先删除再创建同名资源栈集实现。

  • SELF_MANAGED - 自我管理，基于部署需求，用户需要提前手动创建委托，既包含管理账号授权给RFS的委托，也包含成员账号授权给管理账号的委托。如果委托不存在或权限不足，创建资源栈集不会失败，创建资源栈实例时才会报错。

  • SERVICE_MANAGED - 服务管理，基于Organization服务，RFS会自动创建部署Organization 成员账号时所需的全部 IAM 委托。用户需要提前在Organization可信服务列表中将”资源编排资源栈集服务“启用，且只有Organization的管理账号或”资源编排资源栈集服务“的委托管理员，才允许指定SERVICE_MANAGED创建资源栈集，否则会报错。

缺省值：SELF_MANAGED

枚举值：

  • SELF_MANAGED

  • SERVICE_MANAGED

status

String

资源栈集的状态

  • IDLE - 资源栈集空闲

  • OPERATION_IN_PROGRESS - 资源栈集操作中

  • DEACTIVATED - 资源栈集禁用

枚举值：

  • IDLE

  • OPERATION_IN_PROGRESS

  • DEACTIVATED

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

表5 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表6 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表8 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表10 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 429

表11 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表12 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表14 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

请求示例

  • 获取当前用户（domain）当前局点（region）下全部资源栈集，以创建时间降序返回

    GET https://{endpoint}/v1/stack-sets

  • 通过filter获取指定权限模型为SELF_MANAGED下的资源栈集，以创建时间降序返回

    GET https://{endpoint}/v1/stack-sets?filter=permission_model==SELF_MANAGED

  • 通过sort_key和sort_dir指定返回的资源栈集列表，以创建时间升序返回

    GET https://{endpoint}/v1/stack-sets?sort_key=create_time&sort_dir=asc

响应示例

状态码： 200

列举资源栈集成功

{
  "stack_sets" : [ {
    "stack_set_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
    "stack_set_name" : "my_first_stack_set",
    "stack_set_description" : "my first stack set",
    "permission_model" : "SELF_MANAGED",
    "status" : "IDLE",
    "create_time" : "2023-05-15T15:39:25.751Z",
    "update_time" : "2023-05-15T16:39:25.751Z"
  }, {
    "stack_set_id" : "b3e7e15f-f96b-4190-94f4-bb8120f8c4dc",
    "stack_set_name" : "my_second_stack_set",
    "stack_set_description" : "my second stack set",
    "permission_model" : "SELF_MANAGED",
    "status" : "OPERATION_IN_PROGRESS",
    "create_time" : "2023-05-15T14:39:25.210Z",
    "update_time" : "2023-05-15T15:39:25.233Z"
  } ]
}

状态码

状态码

描述

200

列举资源栈集成功

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

429

请求数量过多

500

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