接口功能介绍
查看指定id的密钥详情
接口约束
请保证账户余额大于0
URI
POST /v1/keyManage/describeKey
路径参数
无
Query参数
无
请求参数
请求头header参数
请参见请求消息头
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 密钥唯一标识id | 474e569e-8814-474a-948b-dbcf6d853eff |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回码，取值范围： 200：成功 400：参数确实或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 |
200 | |
| errorCode | 是 | String | 错误码 | KMS.0514 | |
| msg | 是 | String | 调用结果信息 | 获取密钥详情成功 | |
| data | 是 | Object | 接口返回结果 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| deleteDate | 是 | String | 密钥删除时间 | Tue Oct 25 15:06:52 CST 2022 | |
| rotationInterval | 是 | String | 轮转周期，时间范围为7天-730天，例如7d代表7天 | 7d | |
| nextRotationDate | 是 | String | 下次轮转时间 | Tue Oct 25 15:06:52 CST 2022 | |
| creationDate | 是 | String | 密钥创建时间 | Tue Oct 25 15:06:52 CST 2022 | |
| description | 是 | String | 密钥描述，长度小于8129 | 测试 | |
| cmkUuid | 是 | String | 密钥唯一标识id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| status | 是 | String | 密钥状态，取值范围： 0：已禁用 1：启用中 2：待删除 3：待导入 |
1 | |
| keyUsage | 是 | String | 密钥类型，取值范围： 1：加密解密 2：签名验签 |
1 | |
| lastRotationDate | 是 | String | 上一次轮转时间 | Tue Oct 25 15:06:52 CST 2022 | |
| creator | 是 | String | 密钥所属用户id | 562b89493b1a40e1b97ea05e50dd8170 | |
| protectionLevel | 是 | String | 密钥保护级别，取值范围： 0：硬件 1：软件 |
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 | 是 | int | 是否为默认密钥 | 1 | |
| primaryKeyVersion | 是 | String | 密钥版本 | f2ffbff9-940a-41a4-ba9a-fe1fd8f22792 |
请求示例
请求头header
{
"Content-Type": "application/json",
"requestDate": "20221101T154654Z",
"ctyun-eop-request-id": "89bf1559-a96e-4bc9-98fc-394d169a42e4",
"Eop-Authorization":"91ef73a6329545c294be1d5c763bdf7e Headers=ctyun-eop-request-id;eop-date Signature=2mc3zggaqLEGTSVy2H8lWsFEm+BNJf0CrcomDSOxPfc=",
"regionId":"60a39fca876e11ea91cf0242ac110002"
}
请求体body
{
"cmkUuid":"474e569e-8814-474a-948b-dbcf6d853eff"
}
响应示例
{
"code": "200",
"errorCode": null,
"msg": "获取密钥详情成功",
"data": {
"deleteDate": null,
"rotationInterval": null,
"nextRotationDate": null,
"creationDate": "Tue Oct 25 15:06:52 CST 2022",
"description": "",
"cmkUuid": "474e569e-8814-474a-948b-dbcf6d853eff",
"status": "1",
"keyUsage": "1",
"lastRotationDate": "Tue Oct 25 15:06:52 CST 2022",
"creator": "1123",
"protectionLevel": "1",
"origin": "1",
"automaticRotation": "1",
"materialExpireTime": "null",
"keySpec": "AES_256",
"isDefault": 1,
"primaryKeyVersion": "f2ffbff9-940a-41a4-ba9a-fe1fd8f22792"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
| 400 | 表示参数缺失或错误。 |
| 401 | 表示用户验证错误。 |
| 404 | 表示操作目标不可用。 |
| 500 | 表示系统内部错误。 |
错误码
请参考 错误码说明。
