Lists the key versions of a specified managed data key (DK).
Operation description
For details about the access policy required when a RAM user or RAM role invokes this operation, refer to access control.
This operation can be invoked through the shared gateway. For more information, refer to Alibaba Cloud SDK.
Shared gateway: Access KMS through public or VPC endpoints.
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DataKeyName |
string |
No |
The name of the managed data key (DK) to query. This parameter is required. |
example-data-key |
| PageNumber |
integer |
No |
The page number. The value must be an integer greater than 0. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Valid values: 1 to 100. Default value: 10. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues. |
7021b6ec-4be7-4d3c-8a68-1e85d4d515a0 |
| DataKeyName |
string |
The name of the managed data key (DK). |
example-data-key |
| PageSize |
integer |
The number of entries per page. Valid values: 1 to 100. Default value: 10. |
10 |
| PageNumber |
integer |
The page number. The value must be an integer greater than 0. Default value: 1. |
1 |
| TotalCount |
integer |
The total number of entries. |
1 |
| ManagedDataKeyVersions |
object |
The managed data key (DK) version information. |
|
| ManagedDataKeyVersion |
array<object> |
The list of managed data key (DK) versions. |
|
|
object |
|||
| DataKeyVersionId |
string |
xH6OPUmz |
|
| DataKeyVersionName |
string |
kms-datakeyversion!example-data-key!xH6OPUmz |
Examples
Success response
JSON format
{
"RequestId": "7021b6ec-4be7-4d3c-8a68-1e85d4d515a0",
"DataKeyName": "example-data-key",
"PageSize": 10,
"PageNumber": 1,
"TotalCount": 1,
"ManagedDataKeyVersions": {
"ManagedDataKeyVersion": [
{
"DataKeyVersionId": "xH6OPUmz\n",
"DataKeyVersionName": "kms-datakeyversion!example-data-key!xH6OPUmz"
}
]
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.