返回指定主密钥(CMK)的相关信息。

请求参数

名称 类型 是否必需 描述
KeyId String CMK的全局唯一标识符。该参数也可以被指定为CMK绑定的别名,详情请参见别名使用说明

返回参数

名称 类型 描述
KeyMetadata KeyMetadata CMK的metadata。
RequestId String 本次请求的ID。

KeyMetadata

名称 类型 描述
CreationDate Timestamp 创建主密钥(CMK)的日期和时间(UTC)。
Description String CMK的描述。
KeyId String CMK全局唯一标识符。
KeyState String CMK的状态,详情请参见用户主密钥的状态对API调用的影响
KeyUsage String CMK的用途。
PrimaryKeyVersion String 当前的主版本标志符。主版本是CMK的活跃加密密钥,KMS使用主版本处理加密请求。
DeleteDate Timestamp CMK的预计删除时间,详情请参见ScheduleKeyDeletion。只有当KeyState值为PendingDeletion时,返回该值。
Creator String CMK创建者。
Arn String 阿里云资源名称。
Origin String CMK的密钥材料来源。
MaterialExpireTime String 密钥材料的过期时间(UTC)。当该值为空时,表示密钥材料不会过期。
ProtectionLevel String 密钥的保护级别。
LastRotationDate Timestamp 最近一次轮转的时间(UTC)。对新创建密钥,为初始密钥版本生成时间。
AutomaticRotation String 是否开启自动密钥轮转,取值如下:
  • Enabled:自动轮转处于开启状态。
  • Disabled:自动轮转处于未开启状态。
  • Suspended:自动轮转被暂停执行,详情请参见自动轮转密钥
RotationInterval String 密钥自动轮转的周期(秒数)。格式为整数值后加上字符s。例如,7天的轮转周期为604800s。只有当AutomaticRotation参数值为EnabledSuspended时,返回该值。
NextRotationDate Timestamp 下一次轮转的时间。只有当AutomaticRotation参数值为EnabledSuspended时,返回该值。

示例

请求示例

https://kms.cn-hangzhou.aliyuncs.com/?Action=DescribeKey
&KeyId=<your-key-id>
&<公共请求参数>

返回示例

JSON 格式

//json response
{
        "KeyMetadata": {
                "CreationDate": "2016-03-25T10:42:40Z",
                "Description": "key description example",
                "KeyId": "08c33a6f-4e0a-4a1b-a3fa-7ddf****",
                "KeyState": "Enabled",
                "KeyUsage": "ENCRYPT/DECRYPT",
                "PrimaryKeyVersion": "0ec2d249-9f64-4d8f-9587-1215525e****",
                "DeleteDate": "",
                "Creator":"123456",
                "Arn":"acs:kms:cn-hangzhou:123456:key/08c33a6f-4e0a-4a1b-a3fa-7ddf****",
                "Origin":"Aliyun_KMS",
                "MaterialExpireTime":"",
                "ProtectionLevel":"HSM",
                "LastRotationDate": "2019-06-06T18:22:03Z",
                "AutomaticRotation": "Enabled",
                "RotationInterval": "31536000s",
                "NextRotationDate": "2020-07-06T18:22:03Z"
        },
        "RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

XML 格式

//xml response
<KMS>
 <KeyMetadata>
        <CreationDate>2016-03-25T10:40:47Z</CreationDate>
        <Description>key description example</Description>
        <KeyId>08c33a6f-4e0a-4a1b-a3fa-7ddf****</KeyId>
        <KeyState>Enabled</KeyState>
        <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
        <PrimaryKeyVersion>0ec2d249-9f64-4d8f-9587-1215525e****</PrimaryKeyVersion>
        <DeleteDate></DeleteDate>
        <Creator>123456</Creator>
        <Arn>acs:kms:cn-hangzhou:123456:key/08c33a6f-4e0a-4a1b-a3fa-7ddf****</Arn>
        <Origin>Aliyun_KMS</Origin>
        <MaterialExpireTime></MaterialExpireTime>
        <ProtectionLevel>HSM</ProtectionLevel>
        <LastRotationDate>2016-03-25T10:42:40Z</LastRotationDate>
        <AutomaticRotation>Enabled</AutomaticRotation>
        <RotationInterval>31536000s</RotationInterval>
        <NextRotationDate>2017-03-25T10:42:40Z</NextRotationDate>
 </KeyMetadata>
 <RequestId>6cb4bf6b-d9c9-4660-af5f-2328378e7257</RequestId>
</KMS>