列举资源栈集
功能介绍
列举资源栈集（ListStackSets）
此API用于列举当前用户（domain）当前局点（region）下全部资源栈集。
-
可以使用filter作为过滤器，过滤出指定权限模型（permission_model）下的资源栈集。
-
可以使用sort_key和sort_dir两个关键字对返回结果按创建时间（create_time）进行排序。给予的sort_key和sort_dir数量须一致，否则返回400。如果未给予sort_key和sort_dir，则默认按照创建时间降序排序。
-
注意：目前暂时返回全量资源栈集信息，即不支持分页
-
如果没有任何资源栈集，则返回空list
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/stack-sets
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
filter |
否 |
String |
过滤条件
|
|
sort_key |
否 |
Array of strings |
排序字段，仅支持给予create_time |
|
sort_dir |
否 |
Array of strings |
指定升序还是降序
|
|
call_identity |
否 |
String |
仅支持资源栈集权限模式为SERVICE_MANAGED时指定该参数。用于指定用户是以组织管理账号还是成员账号中的服务委托管理员身份调用资源栈集。默认为SELF。
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Client-Request-Id |
是 |
String |
用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
stack_sets |
Array of StackSet objects |
资源栈集 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
stack_set_id |
String |
资源栈集（stack_set）的唯一ID。 此ID由资源编排服务在生成资源栈集的时候生成，为UUID。 由于资源栈集名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈集，删除，再重新创建一个同名资源栈集。 对于团队并行开发，用户可能希望确保，当前我操作的资源栈集就是我以为的那个，而不是被其他队友删除后创建的同名资源栈集。因此，使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈集所对应的ID都不相同，更新不会影响ID。如果给予的stack_set_id和当前资源栈集的ID不一致，则返回400 |
|
stack_set_name |
String |
资源栈集（stack_set）的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 |
|
stack_set_description |
String |
资源栈集的描述。可用于客户识别自己的资源栈集。 |
|
permission_model |
String |
权限模型，定义了RFS操作资源栈集时所需委托的创建方式，枚举值，默认为SELF_MANAGED。用户可以使用创建资源栈集（CreateStackSet）API 指定该参数。该参数暂不支持更新。用户如果想要更新权限模型，可以通过先删除再创建同名资源栈集实现。
|
|
status |
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 429
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
请求示例
-
获取当前用户（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 |
服务器内部错误 |
