全部產品
Search
文件中心

Key Management Service:ListAliasesByKeyId - 查詢主要金鑰(CMK)所有別名

更新時間:Dec 21, 2025

查詢與指定主要金鑰(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

金鑰識別碼。如果請求中的 KeyId 參數使用的是密鑰 ARN,在響應中也會返回金鑰識別碼。

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.

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

變更歷史

更多資訊,參考變更詳情