指定されたカスタマーマスターキー (CMK) バージョンに関する詳細情報を照会します。

このトピックでは、CMK 1234abcd-12ab-34cd-56ef-12345678 **** のバージョンに関する情報を照会する方法の例を示します。 CMKバージョンのIDは2ab1a983-7072-4bbc-a582-584b5bd8 **** です。 応答は、CMKバージョンの作成時間が2016-03-25T10:42:40Zであることを示しています。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 DescribeKeyVersion

実行する操作です。 値をDescribeKeyVersionに設定します。

KeyId String 必須 1234abcd-12ab-34cd-56ef-12345678 ****

グローバルに一意な CMK の ID。

このパラメーターをCMKにバインドされているエイリアスに設定することもできます。 詳細については、「エイリアスの概要」をご参照ください。

KeyVersionId String 必須 2ab1a983-7072-4bbc-a582-584b5bd8 ****

CMKバージョンのグローバル一意ID。

ListKeyVersions操作を呼び出して、CMKのバージョンを照会できます。

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター データ型 説明
KeyVersion Struct

CMKバージョンのメタデータ。

CreationDate String 2016-03-25T10:42:40Z

CMKバージョンが作成された日時。 時刻は UTC で表示されます。

KeyId String 1234abcd-12ab-34cd-56ef-12345678 ****

グローバルに一意な CMK の ID。

リクエストのKeyIdパラメーターをCMKのエイリアスに設定すると、エイリアスがバインドされているCMKのIDが返されます。
KeyVersionId String 2ab1a983-7072-4bbc-a582-584b5bd8 ****

CMKバージョンのグローバル一意ID。

RequestId String 7021b6ec-4be7-4d3c-8a68-1e85d4d515a0

リクエストの ID です。

リクエストの例

http(s)://[Endpoint]/?Action=DescribeKeyVersion
&KeyId=1234abcd-12ab-34cd-56ef-12345678 ****
&KeyVersionId=2ab1a983-7072-4bbc-a582-584b5bd8 ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

<KMS>
         <RequestId>7021b6ec-4be7-4d3c-8a68-1e85d4d515a0</RequestId>
         <KeyVersion>
                   <CreationDate>2016-03-25T10:42:40Z</CreationDate>
                   <KeyId>1234abcd-12ab-34cd-56ef-12345678 ****</KeyId>
                   <KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
         </KeyVersion>
</KMS>

JSON 形式

{
    "RequestId":"7021b6ec-4be7-4d3c-8a68-1e85d4d515a0" 、
    "KeyVersion":{
        "CreationDate":"2016-03-25T10:42:40Z" 、
        "KeyId":"1234abcd-12ab-34cd-56ef-12345678 ****" 、
        "KeyVersionId":"2ab1a983-7072-4bbc-a582-584b5bd8 ****"
        }
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。