文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 实例管理/ 查询KMS秘钥详情
更新时间：2025-09-12 GMT+08:00
查看PDF
分享

查询KMS秘钥详情

功能介绍

查询KMS秘钥详情。

调试

您可以在API Explorer中调试该接口。

接口约束

仅支持数据库版本大于等于V2.0-3.300的实例。

URI

GET /v3/{project_id}/kms/{kms_key_id}/describe-key/{kms_project_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

kms_key_id

是

String

参数解释:

kms秘钥ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

kms_project_name

是

String

参数解释：

GaussDB使用透明加密的KMS主密钥ID所在资源空间名称。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us。

响应参数

表3 响应Body参数

参数

参数类型

描述

key_id

String

参数解释:

秘钥ID。

取值范围:

不涉及。

key_alias

String

参数解释:

密钥别名。

取值范围:

不涉及。

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/be987847-bebf-42e9-9a1f-1ec1254cc213/describe-key/cn-southwest-244
GET https://gaussdb-opengauss.sa-brazil-1.telefonicaopencloud.com/v3/4f07d3f50ce2466a9a7c014337b36409/kms/be987847-bebf-42e9-9a1f-1ec1254cc213/describe-key/cn-southwest-244

响应示例

{ 
  "key_id" : "48891736-c787-4f17-8f6c-9e227e9ca4c7", 
  "key_alias" : "KMS-gaussdb-te", 
  "domain_id" : "5cf7b58fe8f14bacaa1abe2ec01feb5f", 
  "key_state" : "2" 
}

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档