指定された CMK の詳細情報を返します。

リクエストパラメーター

名前 データ型 必須 / 省略可能 説明
KeyId String 必須 CMK のグローバル一意識別子。 エイリアスを使用できます。 詳細については、概要 をご参照ください。

レスポンスパラメーター

名前 データ型 説明
KeyMetadata KeyMetadata CMK に関するメタデータを含みます。

KeyMetadata

名前 データ型 説明
CreationDate Timestamp CMK が作成された日時 (UTC 形式) 。
Description String CM の説明。
KeyId String CMK のグローバル一意識別子。
KeyState String CMK の状態。 詳細については、Impact of CMK states on API call をご参照ください。
KeyUsage String CMK の使用。
DeleteDate Timestamp KMS が CMK を削除する日時。 詳細については、ScheduleKeyDeletion をご参照ください。 この値は、KeyState が PendingDeletion の場合にのみ表示されます。
Creator String CMK の作成者。
Arn String CMK の Alibaba Cloud Resource Name (ARN)。
Origin String CMK のキーマテリアルのソース。
MaterialExpireTime String キーの有効期限が切れる日時 (UTC形式) 。 値が null の場合、キーの期限は切れません。

例

リクエストの例

https://kms.cn-hangzhou.aliyuncs.com/?Action=DescribeKey
&KeyId=<your-key-id>
&<Common Request Parameters>

レスポンス例

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",
                "DeleteDate": "",
                "Creator":"123456",
                "Arn":"acs:kms:cn-hangzhou:123456:key/08c33a6f-4e0a-4a1b-a3fa-7ddf****",
                "Origin":"Aliyun_KMS",
                "MaterialExpireTime":""
        },
        "RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

XML 形式 

//xml response
<KMS>
 <KeyMetadata>
        <CreationDate>2016-03-25T10:40:47Z</CreationDate>
        <Description>key description example</Description><!-- description-->
        <KeyId>08c33a6f-4e0a-4a1b-a3fa-7ddf****</KeyId>
        <KeyState>Enabled</KeyState>
        <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
        <DeleteDate></DeleteDate>
        <Creator>123456</Creator>
        <Arn>acs:kms:cn-hangzhou:123456:key/08c33a6f-4e0a-4a1b-a3fa-7ddf****</Arn>
        <Origin>Aliyun_KMS</Origin>
        <MaterialExpireTime></MaterialExpireTime>
 </KeyMetadata>
 <RequestId>6cb4bf6b-d9c9-4660-af5f-2328378e7257</RequestId>
</KMS>