# 查询PII分类
#### 功能介绍
查询PII分类
#### URI
GET /v1/{project_id}/aiguard/pii/categories
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目ID，用于标识请求所属的项目。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html)。 **约束限制：** 字符串类型，长度1-64字符。 **取值范围：** 只能由英文字母、数字组成，长度为1\~64个字符。 **默认取值：** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token，用于验证请求的合法性。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 **约束限制：** 字符串类型，长度1-16384字符。 **取值范围：** 只能由英文字母、数字及"-"、"_"组成，长度为1\~16384个字符。 **默认取值：** 不涉及。                                                                                     |
| X-Language   | 否    | String | **参数解释：** 语言类型，用于指定响应中PII分类名称的显示语言。系统会根据此参数从国际化表中查询对应语言的显示名称；当指定语言的数据不存在时，自动回退到en-US（英语）；若en-US数据也不存在，则返回原始编码作为名称。系统会自动对语言代码进行标准化处理（语言部分转小写，国家/地区部分转大写，如zh-cn自动转为zh-CN）。 **约束限制：** 只能由英文字母、数字及"*"、"-"、"."组成，长度为1\~32个字符，格式为语言代码-国家/地区代码。 **取值范围：** 只能由英文字母、数字及"*"、"-"、"."组成，长度为1\~32个字符，格式为语言代码-国家/地区代码，如zh-CN、en-US。 **默认取值：** en-US。 |
| Content-Type | 是    | String | **参数解释：** 内容类型，用于指定请求体的媒体类型。 **约束限制：** 固定值application/json;charset=utf-8。 **取值范围：** 固定值application/json;charset=utf-8。 **默认取值：** application/json;charset=utf-8。                                                                                             |
   
#### 响应参数
**状态码：200**
表3响应Header参数 
| 参数           | 参数类型   | 描述                                                                                                                                                                          |
|:---|:---|:---|
| X-request-id | String | **参数解释：** 请求ID号，用于唯一标识一次请求，便于问题追踪。 **取值范围：** 字符串类型，长度1-64字符。 |
   
表4响应Body参数 
| 参数    | 参数类型                                                                       | 描述                                                 |
|:---|:---|:---|
| items | Array of [CategoryItem] objects | PII分类列表，包含所有已启用的PII分类及其子分类，列表中的分类按category字段字典序排列。 |
   
 表5CategoryItem 
| 参数            | 参数类型                                                                             | 描述                                                                                                                                                                          |
|:---|:---|:---|
| category      | String                                                                           | PII分类的编码标识，由数据库中已启用（status=1）的PII记录的category字段去重后生成。 取值范围：只能由英文字母、数字组成，长度为1\~64个字符。                                                    |
| name          | String                                                                           | PII分类的显示名称，根据请求头X-Language指定的语言从国际化表中查询（查询key为CATEGORY_+category编码）。若指定语言无对应翻译，回退至en-US；若en-US也无数据，则返回category原始编码。 取值范围：长度为1\~255个字符。 |
| subcategories | Array of [SubcategoryItem] objects | 该PII分类下的子分类列表，同一category下的subcategory会去重处理。                                                                                                                                 |
   
 表6SubcategoryItem 
| 参数          | 参数类型   | 描述                                                                                                                                                                                    |
|:---|:---|:---|
| subcategory | String | PII子分类的编码标识，由数据库中对应category下已启用（status=1）记录的subcategory字段去重后生成。 取值范围：只能由英文字母、数字组成，长度为1\~64个字符。                                                   |
| name        | String | PII子分类的显示名称，根据请求头X-Language指定的语言从国际化表中查询（查询key为SUBCATEGORY_+subcategory编码）。若指定语言无对应翻译，回退至en-US；若en-US也无数据，则返回subcategory原始编码。 取值范围：长度为1\~255个字符。 |
   
**状态码：400**
表7响应Header参数 
| 参数           | 参数类型   | 描述                                                                                                                                                                          |
|:---|:---|:---|
| X-request-id | String | **参数解释：** 请求ID号，用于唯一标识一次请求，便于问题追踪。 **取值范围：** 字符串类型，长度1-64字符。 |
   
表8响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                         |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码，用于表示请求失败的错误码。 **取值范围：** 字符串类型，长度1-64字符。       |
| error_msg  | String | **参数解释：** 错误信息，用于表示请求失败的错误信息。 **取值范围：** 字符串类型，长度1-2048字符。   |
| detail     | String | **参数解释：** 错误详细描述，用于表示请求失败的详细描述。 **取值范围：** 字符串类型，长度0-2048字符。 |
   
**状态码：401**
表9响应Header参数 
| 参数           | 参数类型   | 描述                                                                                                                                                                          |
|:---|:---|:---|
| X-request-id | String | **参数解释：** 请求ID号，用于唯一标识一次请求，便于问题追踪。 **取值范围：** 字符串类型，长度1-64字符。 |
   
表10响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                         |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码，用于表示请求失败的错误码。 **取值范围：** 字符串类型，长度1-64字符。       |
| error_msg  | String | **参数解释：** 错误信息，用于表示请求失败的错误信息。 **取值范围：** 字符串类型，长度1-2048字符。   |
| detail     | String | **参数解释：** 错误详细描述，用于表示请求失败的详细描述。 **取值范围：** 字符串类型，长度0-2048字符。 |
   
**状态码：403**
表11响应Header参数 
| 参数           | 参数类型   | 描述                                                                                                                                                                          |
|:---|:---|:---|
| X-request-id | String | **参数解释：** 请求ID号，用于唯一标识一次请求，便于问题追踪。 **取值范围：** 字符串类型，长度1-64字符。 |
   
表12响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                         |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码，用于表示请求失败的错误码。 **取值范围：** 字符串类型，长度1-64字符。       |
| error_msg  | String | **参数解释：** 错误信息，用于表示请求失败的错误信息。 **取值范围：** 字符串类型，长度1-2048字符。   |
| detail     | String | **参数解释：** 错误详细描述，用于表示请求失败的详细描述。 **取值范围：** 字符串类型，长度0-2048字符。 |
   
**状态码：500**
表13响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                         |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码，用于表示请求失败的错误码。 **取值范围：** 字符串类型，长度1-64字符。       |
| error_msg  | String | **参数解释：** 错误信息，用于表示请求失败的错误信息。 **取值范围：** 字符串类型，长度1-2048字符。   |
| detail     | String | **参数解释：** 错误详细描述，用于表示请求失败的详细描述。 **取值范围：** 字符串类型，长度0-2048字符。 |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
成功返回PII类型列表
```
{
  "items" : [ {
    "category" : "deviceInfo",
    "name" : "Device Information",
    "subcategories" : [ {
      "subcategory" : "deviceConfigInfo",
      "name" : "Device Configuration Information"
    }, {
      "subcategory" : "ipAddressInfo",
      "name" : "IP Address Information"
    } ]
  }, {
    "category" : "enterpriseInfo",
    "name" : "Enterprise Information",
    "subcategories" : [ {
      "subcategory" : "enterpriseIdentifier",
      "name" : "Enterprise Identifier"
    } ]
  } ]
}
```
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | 成功返回PII类型列表 |
| 400 | 请求参数无效      |
| 401 | 认证失败        |
| 403 | 权限不足        |
| 500 | 服务端内部处理错误   |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-waf/ErrorCode.html)。