查詢指定密鑰對應的所有別名。
調試
您可以在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. | 參數非法。 |
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?