ListAliasesByKeyId -

調試

您可以在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.	參數非法。

訪問錯誤中心查看更多錯誤碼。