查询策略模板列表 - ListPolicyTemplate
功能介绍
查询策略模板概要信息列表，包含策略信息以及应用对象信息。用户在创建策略组的时候，可以根据已有策略模板按需调整配置，快速完成策略组的创建。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:policyGroups:listTemplate
List
-
-
-
-
URI
GET /v1/{project_id}/policy-templates
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
查询的偏移量。 |
|
limit |
否 |
Integer |
查询的数量，值区间[1-100]。 |
|
policy_group_name |
否 |
String |
根据策略模板名字过滤结果。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
总数。 |
|
items |
Array of PolicyGroupForTemplate objects |
策略组列表，返回列表条目数量上限为分页的最大上限值。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
策略组的唯一标识。 |
|
name |
String |
策略组名称。 |
|
priority |
Integer |
优先级。 |
|
description |
String |
服务器组描述。 |
|
create_time |
String |
策略组创建时间。 |
|
update_time |
String |
策略组更新时间。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码：405
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
状态码：503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET /v1/089b2f9a3d80d3062f24c00ca4ed5cbd/policy-templates
响应示例
状态码：200
查询策略模板信息的响应。
{
"count" : 2,
"items" : [ {
"id" : "572947120093396992",
"name" : "test0001",
"priority" : 0,
"description" : "test0001",
"create_time" : "2023-05-29T07:39:50.509Z",
"update_time" : "2023-05-29T07:39:50.509Z"
}, {
"id" : "572944657261002752",
"name" : "tsfasdfas",
"priority" : 0,
"description" : "",
"create_time" : "2023-05-29T07:30:03.324Z",
"update_time" : "2023-05-29T07:30:03.324Z"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询策略模板信息的响应。 |
|
400 |
由于包含语法错误，当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
405 |
请求中指定的方法不被允许。 |
|
500 |
服务内部错误，具体返回错误码请参见错误码说明。 |
|
503 |
服务不可用。 |
错误码
请参见错误码。
