获取主密钥属性

最近更新时间: 2026-09-17 00:03:13

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全局唯一标识符
示例值： 93866e69-9755-11ef-8e65-52540089bc41

3. 输出参数

参数名称 类型 描述
KeyMetadata KeyMetadata 密钥属性信息
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码 描述
InvalidParameter 参数错误。
ResourceUnavailable.CmkNotFound CMK不存在。
InvalidParameterValue.InvalidKeyId KeyId不合法。
InternalError 内部错误。
UnauthorizedOperation 未授权操作。

5. 示例

示例1 获取主密钥属性示例

获取指定CMK的属性详情信息。

输入示例

https://kms.api3.fincloud.tencent.cn/?Action=DescribeKey
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&<公共请求参数>

输出示例

{
    "Response": {
        "KeyMetadata": {
            "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01",
            "Alias": "myalias",
            "CreateTime": 1548210729,
            "Description": "test cmk",
            "KeyState": "Enabled",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "Type": 1,
            "CreatorUin": 1001,
            "KeyRotationEnabled": true,
            "Owner": "user",
            "NextRotateTime": 1553151489,
                        "DeletionDate":0,
"Origin": "KMS",
            "ValidTo": 0
        },
        "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
    }
}

示例2 获取被计划删除主密钥属性示例

此CMK被计划删除

输入示例

https://kms.api3.fincloud.tencent.cn/?Action=DescribeKey
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b02
&<公共请求参数>

输出示例

{
    "Response": {
        "KeyMetadata": {
            "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b02",
            "Alias": "myalias",
            "CreateTime": 1548210729,
            "Description": "test cmk",
            "KeyState": "PendingDelete",
            "KeyUsage": "ENCRYPT_DECRYPT",
            "Type": 1,
            "CreatorUin": 1001,
            "KeyRotationEnabled": true,
            "Owner": "user",
            "NextRotateTime": 1553151489,
                        "DeletionDate":1560580015,
"Origin": "KMS",
            "ValidTo": 0
        },
        "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
    }
}