查询指定密钥对应的所有别名。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
| Action | String | 是 | ListAliasesByKeyId | 要执行的操作。取值：ListAliasesByKeyId。 |
| KeyId | String | 是 | key-hzz630494463ejqjx**** | 密钥的ID或密钥资源名称（ARN）。 说明 访问其他阿里云账号下的密钥时，必须输入密钥ARN。密钥ARN的格式为 acs:kms:${region}:${account}:key/${keyid}。 |
| PageNumber | Integer | 否 | 1 | 当前页数。 取值范围：大于0的整数。 默认值：1。 |
| PageSize | Integer | 否 | 10 | 每页返回的结果个数。 取值范围：0~101。 默认值：10。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
| RequestId | String | 1b57992c-834b-4811-a889-f8bac1ba0353 | 本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。 |
| PageNumber | Integer | 1 | 当前页数。 |
| PageSize | Integer | 10 | 每页的返回结果个数。 |
| TotalCount | Integer | 1 | 返回的密钥总数。 |
| Aliases | Array of Alias | 别名。 |
|
| Alias | |||
| KeyId | String | key-hzz630494463ejqjx**** | 密钥ID。如果请求中的KeyId参数使用的是密钥ARN，在响应中也会返回密钥ID。 |
| AliasArn | String | acs:kms:cn-hangzhou:123456:alias/ExampleAlias1 | 别名的ARN。 |
| AliasName | String | alias/ExampleAlias1 | 别名的唯一标识符。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListAliasesByKeyId
&KeyId=key-hzz630494463ejqjx****
&PageNumber=1
&PageSize=10
&公共请求参数正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListAliasesByKeyIdResponse>
<RequestId>1b57992c-834b-4811-a889-f8bac1ba0353</RequestId>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>1</TotalCount>
<Aliases>
<KeyId>key-hzz630494463ejqjx****</KeyId>
<AliasArn>acs:kms:cn-hangzhou:123456:alias/ExampleAlias1</AliasArn>
<AliasName>alias/ExampleAlias1</AliasName>
</Aliases>
</ListAliasesByKeyIdResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "1b57992c-834b-4811-a889-f8bac1ba0353",
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 1,
"Aliases" : [ {
"KeyId" : "key-hzz630494463ejqjx****",
"AliasArn" : "acs:kms:cn-hangzhou:123456:alias/ExampleAlias1",
"AliasName" : "alias/ExampleAlias1"
} ]
}错误码
|
HttpCode |
错误码 |
错误信息 |
描述 |
| 400 | InvalidParameter | The specified parameter is not valid. | 参数非法。 |
访问错误中心查看更多错误码。