更新时间:2026-08-19 GMT+08:00
分享

查询策略列表

功能介绍

查询AI护栏策略列表

URI

GET /v1/{project_id}/aiguard/policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于标识请求所属的项目

约束限制:

字符串类型,32位UUID

取值范围:

只能由英文字母、数字组成,长度为1~64个字符

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释:

每页返回的最大数据量,用于限制返回的列表数量

约束限制:

整数类型,最小值1,最大值1000

取值范围:

1~1000

默认取值:

10

offset

Integer

参数解释:

分页偏移量,用于指定返回列表的起始位置

约束限制:

整数类型,最小值0

取值范围:

0~2147483647

默认取值:

0

name

String

参数解释:

策略名称,用于过滤返回的策略列表

约束限制:

字符串类型,长度1~255字符

取值范围:

只能由英文字母、数字、中文及"_"、"-"组成

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,用于验证请求的合法性。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制:

字符串类型,长度1~16384个字符

取值范围:

只能由英文字母、数字及"-"、"_"组成

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型,用于指定请求体的媒体类型

约束限制:

固定值application/json;charset=utf8

取值范围:

application/json;charset=utf8

默认取值:

application/json;charset=utf8

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总记录数,用于表示查询结果的总数

取值范围:

非负整数

items

Array of AiGuardPolicyItem objects

参数解释:

策略列表,用于返回查询结果的策略列表

取值范围:

数组类型,每个元素为AiGuardPolicyItem对象

表5 AiGuardPolicyItem

参数

参数类型

描述

id

String

参数解释:

策略ID,用于唯一标识AI护栏策略。

取值范围:

字符串类型,32位UUID。

name

String

参数解释:

策略名称,用于标识AI护栏策略的名称。

取值范围:

字符串类型,长度1~64字符。

bind_ai_apps

Array of AiAppBasicInfo objects

参数解释:

绑定的AI应用列表,列出与策略绑定的所有AI应用信息。

取值范围:

数组类型,每个元素为AiAppBasicInfo对象。

action

AiGuardPolicyAction object

参数解释:

防护动作,描述策略的防护动作配置。

取值范围:

对象类型,包含category字段。

create_time

Long

参数解释:

创建时间,用于标识策略的创建时间。

取值范围:

毫秒时间戳。

表6 AiAppBasicInfo

参数

参数类型

描述

id

String

参数解释:

AI应用ID,用于唯一标识AI应用。

取值范围:

字符串类型,32位UUID。

name

String

参数解释:

AI应用名称,用于标识AI应用的名称。

取值范围:

字符串类型,长度1~64字符。

表7 AiGuardPolicyAction

参数

参数类型

描述

category

String

参数解释:

动作分类,用于指定防护动作的类型

取值范围:

log(仅记录)、block(拦截)

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,用于标识错误类型

取值范围:

字符串类型,长度1~64字符

error_msg

String

参数解释:

错误信息,用于描述错误详情

取值范围:

字符串类型,长度1~2048字符

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,用于标识错误类型

取值范围:

字符串类型,长度1~64字符

error_msg

String

参数解释:

错误信息,用于描述错误详情

取值范围:

字符串类型,长度1~2048字符

请求示例

响应示例

状态码:200

操作成功

{
  "total" : 2,
  "items" : [ {
    "id" : "50d6d179c041409b905f53d948d10693",
    "name" : "12389",
    "bind_ai_apps" : [ {
      "id" : "aiapp1",
      "name" : "name1"
    }, {
      "id" : "aiapp2",
      "name" : "name2"
    } ],
    "create_time" : 11111111111
  }, {
    "id" : "50d6d179c041409b905f53d948d10693",
    "name" : "12389",
    "bind_ai_apps" : [ {
      "id" : "aiapp1",
      "name" : "name1"
    }, {
      "id" : "aiapp2",
      "name" : "name2"
    } ],
    "create_time" : 11111111111
  } ]
}

状态码

状态码

描述

200

操作成功

400

参数错误

500

服务端内部错误

错误码

请参见错误码

相关文档