All Products
Search
Document Center

Key Management Service:DescribeKeyVersion

Last Updated:Jul 29, 2025

Queries the information about a key version.

Operation description

This topic provides an example on how to query the information about a version of the CMK 1234abcd-12ab-34cd-56ef-12345678****. The ID of the CMK version is 2ab1a983-7072-4bbc-a582-584b5bd8****. The response shows that the creation time of the CMK version is 2016-03-25T10:42:40Z.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
KeyIdstringYes

The globally unique ID of the CMK.

You can also set this parameter to an alias that is bound to the CMK. For more information, see Alias overview.

1234abcd-12ab-34cd-56ef-12345678****
KeyVersionIdstringYes

The globally unique ID of the CMK version.

You can call the ListKeyVersions operation to query the versions of the CMK.

2ab1a983-7072-4bbc-a582-584b5bd8****

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7021b6ec-4be7-4d3c-8a68-1e85d4d515a0
KeyVersionobject

The metadata of the CMK version.

KeyIdstring

The globally unique ID of the CMK.

Note If you set the KeyId parameter in the request to an alias of the CMK, the ID of the CMK to which the alias is bound is returned.
1234abcd-12ab-34cd-56ef-12345678****
KeyVersionIdstring

The globally unique ID of the CMK version.

2ab1a983-7072-4bbc-a582-584b5bd8****
CreationDatestring

The date and time when the CMK version was created. The time is displayed in UTC.

2016-03-25T10:42:40Z

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.