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

查询AI应用列表

功能介绍

获取AI应用列表,支持过滤和分页

URI

GET /v1/{project_id}/aiguard/aiapps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

字符串类型,32位UUID。

取值范围:

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

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释:

每页返回的条目数量,用于限制返回的AI应用条目数量。

约束限制:

整数类型。

取值范围:

1-100。

默认取值:

10。

offset

Integer

参数解释:

偏移量,用于指定从第几条记录开始返回。

约束限制:

整数类型。

取值范围:

0-2147483647。

默认取值:

0。

name

String

参数解释:

AI应用名称,用于按名称过滤AI应用。

约束限制:

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

取值范围:

不涉及。

默认取值:

不涉及。

protect_status

Integer

参数解释:

防护状态,用于按防护状态过滤AI应用。

约束限制:

整数类型,取值为0或1。

取值范围:

0表示已禁用,1表示已启用。

默认取值:

不涉及。

policy_id

String

参数解释:

策略ID,用于按策略ID过滤AI应用。

约束限制:

字符串类型,32位UUID。

取值范围:

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

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

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

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Long

参数解释:

总条目数,返回查询结果的总条目数。

取值范围:

非负整数。

items

Array of AiAppItem objects

参数解释:

AI应用列表,返回符合条件的AI应用列表。

取值范围:

列表长度0-100。

表5 AiAppItem

参数

参数类型

描述

id

String

参数解释:

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

取值范围:

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

name

String

参数解释:

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

取值范围:

字符串类型,长度1-255字符。

description

String

参数解释:

应用描述,用于描述AI应用的功能和用途。

取值范围:

字符串类型,长度0-1024字符。

api_sign

String

参数解释:

API签名,用于验证API请求的合法性。

取值范围:

字符串类型,长度1-128字符。

protect_status

Integer

参数解释:

防护状态,用于标识AI应用的防护状态。

取值范围:

0表示已禁用,1表示已启用。

policy

Policy object

参数解释:

策略信息,返回与AI应用关联的策略信息

取值范围:

对象类型,Policy对象

create_time

Long

参数解释:

创建时间,返回AI应用的创建时间。

取值范围:

毫秒时间戳,大于0的整数。

update_time

Long

参数解释:

更新时间,返回AI应用的最后更新时间。

取值范围:

毫秒时间戳,大于0的整数。

表6 Policy

参数

参数类型

描述

id

String

参数解释:

策略ID,用于唯一标识一个策略。

取值范围:

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

name

String

参数解释:

策略名称,用于标识策略的名称。

取值范围:

字符串类型,长度1-255字符。

description

String

参数解释:

策略描述,用于描述策略的功能和用途。

取值范围:

字符串类型,长度0-1024字符。

请求示例

响应示例

状态码

状态码

描述

200

AI应用列表

400

请求无效

401

未授权

500

服务器内部错误

错误码

请参见错误码

相关文档