全部產品
Search
文件中心

ApsaraDB for MongoDB:CheckCloudResourceAuthorized - 查詢KMS密鑰是否已授權給執行個體

更新時間:Apr 21, 2026

查詢KMS密鑰是否已授權給MongoDB執行個體。

介面說明

在調用 ModifyDBInstanceTDE 介面開啟透明資料加密 TDE 前,請調用本介面查詢 KMS 密鑰是否已授權給 MongoDB 執行個體。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:CheckCloudResourceAuthorized

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

請求參數

名稱

類型

必填

描述

樣本值

DBInstanceId

string

執行個體 ID。

dds-bp18f7d6b6a7****

TargetRegionId

string

執行個體所屬地區,您可以調用 DescribeDBInstanceAttribute 查詢。

cn-hangzhou

返回參數

名稱

類型

描述

樣本值

object

AuthorizationState

integer

授權狀態,取值說明:

  • 0:未授權。

  • 1:已授權。

  • 2:使用者未開啟 KMS。

1

RequestId

string

請求 ID。

A0181AC4-F186-46ED-87CA-100C70B86729

RoleArn

string

已授權阿里雲資源的角色資訊。

說明

AuthorizationState 傳回值為 1 時,才會返回本參數。

acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole

樣本

正常返回樣本

JSON格式

{
  "AuthorizationState": 1,
  "RequestId": "A0181AC4-F186-46ED-87CA-100C70B86729",
  "RoleArn": "acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情