調用DescribeKmsKeys查詢可用於雲端硬碟加密的KMS密鑰-ApsaraDB for MongoDB-阿里雲

介面說明

查詢到的密鑰僅適用於雲端硬碟加密。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeKmsKeys

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID，您可以調用 DescribeRegions 查詢。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	60EEBD77-227C-5B39-86EA-D89163C5****
KmsKeys	array	KMS 的密鑰列表。
	object	KMS 的金鑰組象。
KeyAlias	string	密鑰別名。	key-shh656820f4mh9qxxxxx alias/test1
KeyId	string	金鑰識別碼。	37291352-xxxx-xxxx-adbf-fd0630a95583

樣本

正常返回樣本

JSON格式

{
  "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****",
  "KmsKeys": [
    {
      "KeyAlias": "key-shh656820f4mh9qxxxxx     alias/test1",
      "KeyId": "37291352-xxxx-xxxx-adbf-fd0630a95583"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
404	EntityNotExistUser	The User does not exist.
404	EntityNotExistService	The Service mongodb.aliyuncs.com does not exist.
404	NoPermissionService	The Account NoPermission Error! Please Authorize The Account! Service Name: mongodb.aliyuncs.com, SLR Role:AliyunServiceRoleForMongoDB.
409	EntityAlreadyExistsRole	The Role already exists:AliyunServiceRoleForMongoDB.

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

變更歷史

更多資訊，參考變更詳情。