查询策略组列表 - ListAiPolicyGroups
功能介绍
查询策略组列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/ai/policy/groups
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,可通过我的凭证,项目id获取 约束限制: 必填 取值范围: 字符长度1-256位 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| group_id | 否 | String | 参数解释: 策略组ID 约束限制: 不涉及 取值范围: 字符长度1-20位 默认取值: 不涉及 |
| group_name | 否 | String | 参数解释: 策略组名称 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
| protection_object | 否 | String | 参数解释: 防护对象 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
| object_type | 否 | Integer | 参数解释: 对象类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
| limit | 否 | Integer | 参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_num | Integer | 参数解释: 总数 取值范围: 最小值0,最大值2147483647 |
| data_list | Array of AiPolicyGroupInfo objects | 参数解释: AI策略组列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| group_id | String | 参数解释: 策略组ID 取值范围: 字符长度1-20位 |
| group_name | String | 参数解释: 策略组名称 取值范围: 字符长度1-128位 |
| group_type | Integer | 参数解释: 策略组ID 取值范围: 最小值0,最大值2147483647 |
| project_id | String | 项目ID |
| protection_object | String | 参数解释: 防护对象 取值范围: 字符长度1-128位 |
| object_type | Integer | 参数解释: 防护对象类型 取值范围: |
| object_num | Integer | 参数解释: 防护对象个数 取值范围: 取值0-100000 |
| is_default | Boolean | 参数解释: 是否是默认策略 取值范围: |
| is_exclusive | Boolean | 参数解释: 是否是默认策略 取值范围: |
| enabled | Boolean | 参数解释: 是否启用 取值范围: |
| detail_is_used | Boolean | 参数解释: 是否启用 取值范围: |
| description | String | 参数解释: 描述 取值范围: 字符长度0-256位 |
| create_time | Integer | 参数解释: 创建时间 取值范围: 最小值0,最大值9223372036854775807 |
| update_time | Integer | 参数解释: 创建时间 取值范围: 最小值0,最大值9223372036854775807 |
| policy_list | Array of AiPolicyList objects | 参数解释: 策略列表 取值范围: 不涉及 |
| agent_id_list | Array of strings | 参数解释: 智能体列表 取值范围: 不涉及 |
请求示例
查询策略组列表
GET https://{endpoint}/v5/{project_id}/ai/policy/groups 响应示例
状态码:200
请求已成功
{
"total_num" : 3,
"data_list" : [ {
"group_id" : 2058116443399700480,
"group_name" : "xxxx",
"project_id" : "84b5266c14ae489fa6549827f032dc62",
"protection_object" : "OfficeClaw",
"object_type" : 0,
"object_num" : 1,
"is_default" : true,
"enabled" : true,
"description" : "1111",
"create_time" : 1778874953990,
"update_time" : 1779604792737,
"policy_list" : null
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。