有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: kms.tencentcloudapi.com 。

用于获取指定KeyId的主密钥属性详情信息。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeKey。
Version String 公共参数,本接口取值:2019-01-18。
Region String 公共参数,详见产品支持的 地域列表
KeyId String CMK全局唯一标识符
示例值:23e80852-1e38-11e9-b129-5cb9019b4b01

3. 输出参数

参数名称 类型 描述
KeyMetadata KeyMetadata 密钥属性信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

https://kms.tencentcloudapi.com/?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": "TENCENT_KMS",
            "ValidTo": 0
        },
        "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
    }
}

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

此CMK被计划删除

输入示例

https://kms.tencentcloudapi.com/?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": "TENCENT_KMS",
            "ValidTo": 0
        },
        "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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