# 查询KMS密钥列表 - QueryingKMSKeys
#### 功能介绍
查询密钥列表。
- 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。
- 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListKmsTdeKey)中调试该接口。
#### 接口约束
仅支持数据库版本大于等于V2.0-3.300的实例。
#### URI
GET /v3/{project_id}/kms/list-keys/{kms_project_name}
表1路径参数 
| 参数               | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| project_id       | 是    | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。          |
| kms_project_name | 是    | String | **参数解释：** GaussDB使用透明加密的KMS主密钥ID所在资源空间名称。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 |
| X-Language   | 否    | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围** **：** - **zh-cn：**中文  - **en-us** **：**英文   **默认取值** **：** **en-us**                 |
   
#### 响应参数
表3响应Body参数 
| **参数**          | **参数类型**         | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|
| key_details     | Array of objects | **参数解释**: kms密钥列表。详情请参见[表4]。                                                                                                                                                                                                                                                           |
| authorized_id   | String           | **参数解释**: 授权用户ID，在开启透明加密能力时，必须对当前用户ID进行授权。 授权操作参考[创建授权](https://support.huaweicloud.com/api-dew/CreateGrant.html)接口 。 **取值范围**: 不涉及。 |
| authorized_name | String           | **参数解释**: 授权用户名称。 **取值范围**: 不涉及。                                                                                                                                                                              |
   
 表4key_details 
| **参数**           | **参数类型** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|
| key_id           | String   | **参数解释**: 密钥ID。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| default_key_flag | String   | **参数解释**: 默认主密钥标识。 **取值范围**: - 1：默认主密钥。  - 0：非默认主密钥。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| key_alias        | String   | **参数解释**: 密钥别名。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| key_spec         | String   | **参数解释**: 密钥生成算法。 **取值范围**: - AES_256：256位高级对称加密标准算法。  - SM4：128位国密对称加密算法。  - RSA_2048：2048位RSA公钥非对称加密算法。  - RSA_3072：3072位RSA公钥非对称加密算法。  - RSA_4096：4096位RSA公钥非对称加密算法。  - EC_P256：256位椭圆曲线 (NIST P-256) 非对称加密算法。  - EC_P384：384位椭圆曲线 (NIST P-384) 非对称加密算法。  - SM2：国密椭圆曲线非对称加密算法。  - ALL：支持所有算法。   |
| domain_id        | String   | **参数解释**: 用户域ID。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| key_state        | String   | **参数解释**: 密钥状态。 **取值范围**: - "1"：表示待激活状态。  - "2"：表示启用状态。  - "3"：表示禁用状态。  - "4"：表示计划删除状态。  - "5"：表示等待导入状态。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
   
#### 请求示例
查询当前可使用的kms密钥列表。
```
GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/4f07d3f50ce2466a9a7c014337b36409/kms/list-keys/cn-southwest-244
```
#### 响应示例
```
{
"key_details": [
{
"key_id": "1df79795-a726-460a-baed-2585309b7566",
"default_key_flag": "0",
"key_alias": "KMS-hwx627992",
"key_spec": "AES_256",
"domain_id": "0611e0475e00d5d10fabc017d8af04a0",
"key_state": "2"
}
],
"authorized_id": "6a4ace47839542ff8415207697574a60",
"authorized_name": "default_kms_user"
}
```
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。