查询KMS密钥列表
调试
您可以在API Explorer中调试该接口。
接口约束
仅支持数据库版本大于等于V2.0-3.300的实例。
URI
GET /v3/{project_id}/kms/list-keys/{kms_project_name}
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
X-Language |
否 |
String |
参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: en-us。 |
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key_details |
Array of objects |
参数解释: kms密钥列表。详情请参见表4。 |
|
authorized_id |
String |
参数解释: 授权用户ID,在开启透明加密能力时,必须对当前用户ID进行授权。 授权操作参考创建授权接口 。 取值范围: 不涉及。 |
|
authorized_name |
String |
参数解释: 授权用户名称。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key_id |
String |
参数解释: 密钥ID。 取值范围: 不涉及。 |
|
default_key_flag |
String |
参数解释: 默认主密钥标识。 取值范围: 默认主密钥标识为1,非默认标识为0。 |
|
key_alias |
String |
参数解释: 密钥别名。 取值范围: 不涉及。 |
|
key_spec |
String |
参数解释: 密钥生成算法。 取值范围:
|
|
domain_id |
String |
参数解释: 用户域ID。 取值范围: 不涉及。 |
|
key_state |
String |
参数解释: 密钥状态。 取值范围:
|
请求示例
查询当前可使用的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"
}
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。