调用ListKeys查询调用者在调用地域的所有主密钥ID。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ListKeys | 要执行的操作。取值:ListKeys。 |
PageNumber | Integer | 否 | 1 | 当前页数。 取值范围:大于0。 默认值:1。 |
PageSize | Integer | 否 | 10 | 每页返回值的个数。 取值范围:1~100。 默认值:10。 |
Filters | String | 否 | [{"Key":"KeyState", "Values":["Enabled","Disabled"]}] | 主密钥过滤器。由Key-Values键值对组成,长度为0~10。
Filters不同Key之间的逻辑关系为AND,同一个Key中的多个Value之间的逻辑关系为OR。例如:输入
[ {"Key":"KeyState", "Values":["Enabled","Disabled"]},
{"Key":"KeyState", "Values":["PendingDeletion"]},
{"Key":"KeySpec", "Values":["Aliyun_AES_256"]}
]
时,语义为:
(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion)
AND (KeySpec=Aliyun_AES_256)。
|
返回数据
名称 |
类型 |
示例值 |
描述 |
PageNumber | Integer | 1 | 当前页数。 |
PageSize | Integer | 10 | 每页返回值的个数。 |
RequestId | String | 8252db58-2036-408c-a3d5-56e656dc2551 | 本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
TotalCount | Integer | 3 | 主密钥的总数。 |
Keys | Array of Key | 主密钥。 |
|
Key | |||
KeyId | String | 08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4**** | 主密钥的全局唯一标识符。 |
KeyArn | String | acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81**** | 主密钥的ARN。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListKeys
&PageNumber=1
&PageSize=10
&Filters=[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]
&公共请求参数
正常返回示例
XML
格式
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
格式
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****"
} ]
}
错误码
访问错误中心查看更多错误码。