DescribeKey
最近更新时间: 2025-10-20 17:05:53
1. 接口描述
接口请求域名： kms.api3.fincloud.tencent.cn。
用于获取指定KeyId的主密钥属性详情信息。
默认接口请求频率限制：100次/秒。
接口更新时间：2020-01-15 14:34:52。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeKey |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-18 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| KeyId | 是 | 否 | String | CMK全局唯一标识符 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KeyMetadata | KeyMetadata | 密钥属性信息 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| ResourceUnavailable.CmkNotFound | CMK不存在。 |
| InvalidParameterValue.InvalidKeyId | KeyId不合法。 |
| InternalError | 内部错误。 |
| UnauthorizedOperation | 未授权操作。 |