
# 查询密钥列表
#### 功能介绍
专业版HiLens控制台密钥管理，根据用户请求条件筛选，查询用户创建的 密钥信息，以列表形式返回。
#### URI
GET /v3/{project_id}/ai-mgr/secrets
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                   |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-hilens/hilens_07_0020.html) |
表2Query参数 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                                                        |
|:---|:---|:---|:---|
| offset       | 否    | Integer | 查询的起始位置，取值范围为非负整数，默认为0                                                                                                    |
| limit        | 否    | Integer | 每页显示的条目数量，取值范围1\~100，默认为100                                                                                               |
| name         | 否    | String  | 设备名称，模糊匹配，只允许中文字符、英文字母、数字、下划线、中划线，最大长度64                                                                                  |
| workspace_id | 否    | String  | 工作空间ID，默认为注册账号子账号的default工作空间，可通过专业版HiLens控制台展开工作空间列表获取到工作空间ID                                                            |
| tags         | 否    | String  | 标签的key和value通过点连接，多个标签通过逗号连接，如：tags=key1.value1,key2.value2                                                               |
| provider     | 否    | String  | 服务提供者：ief或hilens。不传会查询全部服务类型的设备列表                                                                                         |
| sort         | 否    | String  | 排序方式，可根据名称、创建时间、更新时间排序枚举值：name，created_at，updated_at。sort默认升序，如sort=name，降序：sort=name%3Adesc。不填默认为sort=created_at%3Adesc。 |
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                 |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 租户Token。获取方法请参见[获取Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html) |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数      | 参数类型                                                                            | 描述     |
|:---|:---|:---|
| count   | Integer                                                                         | 数量     |
| secrets | Array of [SecretDetail] objects | 密钥详情列表 |
   
 表5SecretDetail 
| 参数           | 参数类型                                                                | 描述     |
|:---|:---|:---|
| workspace_id | String                                                              | 工作空间ID |
| id           | String                                                              | 密钥ID   |
| name         | String                                                              | 密钥名称   |
| description  | String                                                              | 密钥描述   |
| project_id   | String                                                              | 项目ID   |
| created_at   | String                                                              | 密钥创建时间 |
| updated_at   | String                                                              | 密钥更新时间 |
| secrets      | Array of [Secret] objects | 密钥列表   |
| tags         | Array of [Tag] objects       | 标签列表   |
   
 表6Secret 
| 参数    | 参数类型   | 描述                                                                                                   |
|:---|:---|:---|
| key   | String | 密钥key，最大长度63个字符。不能为空，只能包含大小写字母，数字，中划线"-"，下划线"_"                                                      |
| value | String | 密钥value，每个值最大长度10000个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线"-"，下划线"_" |
   
 表7Tag 
| 参数    | 参数类型   | 描述                                                                                                |
|:---|:---|:---|
| key   | String | 标签key，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线"-"，下划线"_"                                                   |
| value | String | 标签value，每个值最大长度43个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线"-"，下划线"_" |
   
#### 请求示例
获取密钥详情列表
```
GET https://{endpoint}/v3/{project_id}/ai-mgr/secrets
Request Header:  Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
```
#### 响应示例
**状态码： 200**
请求成功
```
{
  "count" : "1;",
  "secrets" : [ {
    "id" : "string",
    "name" : "string",
    "description" : "string",
    "workspace_id" : "string",
    "project_id" : "string",
    "created_at" : "string",
    "updated_at" : "string",
    "secrets" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "tags" : [ {
      "key" : "string",
      "value" : "string"
    } ]
  } ]
}
```
#### 状态码
| 状态码 | 描述       |
|:---|:---|
| 200 | 请求成功     |
| 401 | 认证不通过    |
| 403 | 拒绝执行请求   |
| 404 | 请求的资源不存在 |
| 500 | 服务器内部错误  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-hilens/ErrorCode.html)。
