ListAliasesByKeyId - 查询主密钥（CMK）所有别名 - 密钥管理服务

接口说明

RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
KeyId	string	是	密钥的 ID 或密钥资源名称（ARN）。说明访问其他阿里云账号下的密钥时，必须输入密钥 ARN。密钥 ARN 的格式为`acs:kms:${region}:${account}:key/${keyid}`。	key-hzz630494463ejqjx****
PageNumber	integer	否	当前页数。取值范围：大于 0 的整数。默认值：1。	1
PageSize	integer	否	每页返回的结果个数。取值范围：0~101。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	1b57992c-834b-4811-a889-f8bac1ba0353
PageNumber	integer	当前页数。	1
PageSize	integer	每页的返回结果个数。	10
TotalCount	integer	返回的密钥总数。	1
Aliases	object
Alias	array<object>	别名。
	object
KeyId	string	密钥 ID。如果请求中的 KeyId 参数使用的是密钥 ARN，在响应中也会返回密钥 ID。	key-hzz630494463ejqjx****
AliasArn	string	别名的 ARN。	acs:kms:cn-hangzhou:123456:alias/ExampleAlias1
AliasName	string	别名的唯一标识符。	alias/ExampleAlias1

示例

正常返回示例

JSON格式

{
  "RequestId": "1b57992c-834b-4811-a889-f8bac1ba0353",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "Aliases": {
    "Alias": [
      {
        "KeyId": "key-hzz630494463ejqjx****",
        "AliasArn": "acs:kms:cn-hangzhou:123456:alias/ExampleAlias1",
        "AliasName": "alias/ExampleAlias1"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is not valid.	参数非法。
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。