Queries all customer master keys (CMKs) of the current Alibaba Cloud account in the current region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListKeys | The operation that you want to perform. Set the value to ListKeys. |
PageNumber | Integer | No. | 1 | The number of the page to return. Pages start from page 1. Default value: 1. |
PageSize | Integer | No. | 10 | The number of entries to return on each page. Valid values: 1 to 100. Default value: 10. |
Filters | String | No | [{"Key":"KeyState", "Values":["Enabled","Disabled"]}] | The CMK filter. The filter consists of one or more key-value pairs. You can specify a maximum of 10 key-value pairs.
The logical relationship between different keys is AND. The logical relationship between values of the Values field in a key-value pair is OR. Example:
[ {"Key":"KeyState", "Values":["Enabled","Disabled"]},
{"Key":"KeyState", "Values":["PendingDeletion"]},
{"Key":"KeySpec", "Values":["Aliyun_AES_256"]}
]
. In this example, the semantics are:
(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion)
AND (KeySpec=Aliyun_AES_256).
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
PageNumber | Integer | 1 | The page number of the returned page. |
PageSize | Integer | 10 | The number of entries returned per page. |
RequestId | String | 8252db58-2036-408c-a3d5-56e656dc2551 | The ID of the request, which is used to locate and troubleshoot issues. |
TotalCount | Integer | 3 | The total number of CMKs. |
Keys | Array of Key | An array that consists of CMKs. |
|
Key | |||
KeyId | String | 08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4**** | The ID of the CMK. The ID must be globally unique. |
KeyArn | String | acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81**** | The Alibaba Cloud Resource Name (ARN) of the CMK. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ListKeys
&PageNumber=1
&PageSize=10
&Filters=[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ListKeysResponse>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<RequestId>8252db58-2036-408c-a3d5-56e656dc2551</RequestId>
<TotalCount>3</TotalCount>
<Keys>
<KeyId>08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****</KeyId>
<KeyArn>acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****</KeyArn>
</Keys>
</ListKeysResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageNumber" : 1,
"PageSize" : 10,
"RequestId" : "8252db58-2036-408c-a3d5-56e656dc2551",
"TotalCount" : 3,
"Keys" : [ {
"KeyId" : "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
"KeyArn" : "acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****"
} ]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter | The specified parameter is not valid. | The error message returned because an invalid value is specified for the parameter. |
404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. | The error message returned because the specified AccessKey ID does not exist. |
For a list of error codes, see Service error codes.