查看密钥详情
更新时间 2026-03-12 14:01:33
最近更新时间: 2026-03-12 14:01:33
接口功能介绍
查看指定id的密钥详情
接口约束
请保证账户余额大于0
URI
POST /v1/keyManage/describeKey
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 密钥唯一标识id | 474e569e-8814-474a-948b-dbcf6d853eff |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 返回码 取值范围：200 成功 | 200 | |
| error | String | 错误码 | KMS_0514 | |
| message | String | 调用结果信息 | 获取密钥详情成功 | |
| returnObj | Object | 接口返回结果 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deleteDate | String | 密钥删除时间 | Tue Oct 25 15:06:52 CST 2022 | |
| rotationInterval | String | 轮转周期 | 7d | |
| nextRotationDate | String | 下次轮转时间 | Tue Oct 25 15:06:52 CST 2022 | |
| creationDate | String | 密钥创建时间 | Tue Oct 25 15:06:52 CST 2022 | |
| description | String | 密钥描述 | 密钥描述，长度小于8129 | Tue Oct 25 15:06:52 CST 2022 |
| cmkUuid | String | 密钥唯一标识 | 474e569e-8814-474a-948b-dbcf6d853eff | |
| status | String | 密钥状态 | 1 | |
| keyUsage | String | 密钥类型1-加密解密 2-签名验签 | 1 | |
| lastRotationDate | String | 上一次轮转时间 | Tue Oct 25 15:06:52 CST 2022 | |
| creator | String | 密钥所属用户id | 562b89493b1a40e1b97ea05e50dd8170 | |
| protectionLevel | String | 密钥保护级别 | 保护等级，0为硬件，1为软件 | |
| origin | String | 密钥来源 1-KMS 2-外部密钥 | 1 | |
| automaticRotation | String | 是否开启轮转取值0，1，2 | 1 | |
| materialExpireTime | String | 密钥材料过期时间 | Tue Oct 25 15:06:52 CST 2022 | |
| keySpec | String | 密钥类型 | AES_256 | |
| isDefault | Integer | 是否为默认密钥 | 1 | |
| primaryKeyVersion | String | 密钥版本 | f2ffbff9-940a-41a4-ba9a-fe1fd8f22792 | |
| deleted | String | 密钥是否删除取值（0-未删除，1-已删除） | 0 | |
| epId | String | 企业项目id | 53e50630604f42eba9d4fd9e0d8458bf | |
| requestId | String | 请求id | a2a7ca1d-86d6-4364-86bf-51599de3b542 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionId": "fecnjniakfkn2314ndekqldedcsadfg"
}
请求体body
{
"cmkUuid": "474e569e-8814-474a-948b-dbcf6d853eff"
}
响应示例
{
"statusCode": "200",
"message": "获取密钥详情成功",
"returnObj": {
"requestId": "765d6440-175e-4be0-b047-86e44622aa40",
"primaryKeyVersion": "4b0a3c5f-e11c-4e2d-abef-999eedb82ea1",
"deleteDate": null,
"rotationInterval": "604800",
"nextRotationDate": "2025-10-29 15:59:07",
"creationDate": "2025-10-22 15:59:07",
"description": "描述",
"cmkUuid": "4fa4750e-53c9-4411-8d88-f49edf106589",
"status": 1,
"keyUsage": 1,
"lastRotationDate": "2025-10-22 15:59:07",
"creator": "c07960e2659b486e8d48ab7e6022645d",
"protectionLevel": 1,
"origin": 1,
"automaticRotation": 0,
"isDefault": 0,
"materialExpireTime": null,
"keySpec": "AES_256",
"deleted": 0,
"epId": null
}
}
状态码
请参考 状态码
错误码
请参考 错误码
