# 查询内置词库列表
#### 功能介绍
查询AI护栏内置词库列表，用于创建或更新规则时选择内置词库标签
#### URI
GET /v1/{project_id}/aiguard/system-lexicons
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目ID，用于标识请求所属的项目 **约束限制：** 字符串类型，32位UUID **取值范围：** 只能由英文字母、数字组成，长度为1\~64个字符 **默认取值：** 不涉及 |
   
表2Query参数 
| 参数   | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| type | 否    | String | **参数解释：** 词库类型过滤，用于过滤词库类型 **约束限制：** 字符串类型，长度1\~20字符 **取值范围：** inject（注入检测）、compliance（合规检测）、internal（内置词库） **默认取值：** 不涉及 |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token，用于验证请求的合法性。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) **约束限制：** 字符串类型，长度1\~16384个字符 **取值范围：** 只能由英文字母、数字及"-"、"_"组成 **默认取值：** 不涉及 |
| Content-Type | 是    | String | **参数解释：** 内容类型，用于指定请求体的媒体类型 **约束限制：** 固定值application/json **取值范围：** application/json **默认取值：** application/json                                         |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数    | 参数类型                                                                                        | 描述                                                                                                                                                                                                           |
|:---|:---|:---|
| total | Integer                                                                                     | **参数解释：** 总数，用于返回查询结果的总词库数 **取值范围：** 非负整数                                |
| items | Array of [SystemLexiconItem] objects | **参数解释：** 内置词库列表，用于返回查询结果的内置词库列表 **取值范围：** 数组类型，每个元素为SystemLexiconItem对象 |
   
 表5SystemLexiconItem 
| 参数    | 参数类型   | 描述                                                                                                                                                                                                                  |
|:---|:---|:---|
| label | String | **参数解释：** 词库标签标识，用于标识词库的唯一标签 **取值范围：** 字符串类型，长度1-64字符                           |
| name  | String | **参数解释：** 词库名称，用于标识词库的名称 **取值范围：** 字符串类型，长度1-255字符                              |
| type  | String | **参数解释：** 词库类型，用于标识词库的类型 **取值范围：** inject(注入检测)、compliance(合规检测)、internal(内置词库) |
   
**状态码：400**
表6响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                      |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码，用于标识错误类型 **取值范围：** 字符串类型，长度1\~64字符    |
| error_msg  | String | **参数解释：** 错误信息，用于描述错误详情 **取值范围：** 字符串类型，长度1\~2048字符 |
   
**状态码：500**
表7响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                      |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码，用于标识错误类型 **取值范围：** 字符串类型，长度1\~64字符    |
| error_msg  | String | **参数解释：** 错误信息，用于描述错误详情 **取值范围：** 字符串类型，长度1\~2048字符 |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
查询成功
```
{
  "total" : 3,
  "items" : [ {
    "label" : "GoalHijacking",
    "name" : "目标劫持",
    "type" : "inject"
  }, {
    "label" : "RolePlayInstruction",
    "name" : "角色扮演",
    "type" : "inject"
  }, {
    "label" : "BuiltinViolation",
    "name" : "内置违禁词",
    "type" : "internal"
  } ]
}
```
#### 状态码
| 状态码 | 描述      |
|:---|:---|
| 200 | 查询成功    |
| 400 | 参数错误    |
| 500 | 服务端内部错误 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-waf/ErrorCode.html)。