すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for MongoDB:CheckCloudResourceAuthorized

最終更新日:Oct 12, 2026

MongoDB インスタンスに対して Key Management サービス (KMS) キーが権限付与されているかどうかを照会します。

操作説明

TDE (透過的データ暗号化) を有効にする ModifyDBInstanceTDE 操作を呼び出す前に、この操作を呼び出して MongoDB インスタンスに対する KMS キーの権限付与をクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:CheckCloudResourceAuthorized

get

*dbinstance

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

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

DBInstanceId

string

必須

インスタンスの ID。

dds-bp18f7d6b6a7****

TargetRegionId

string

必須

インスタンスのリージョン ID。 DescribeDBInstanceAttribute 操作を呼び出してリージョン ID をクエリできます。

cn-hangzhou

レスポンスフィールド

フィールド

型

説明

例

object

AuthorizationState

integer

権限付与ステータス。有効な値:

  • 0: 権限付与されていません。

  • 1: 権限付与されています。

  • 2: ユーザーが KMS を有効にしていません。

1

RequestId

string

リクエスト ID。

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

RoleArn

string

Alibaba Cloud リソースへのアクセスが権限付与されているロールの情報。

説明

このパラメーターは、AuthorizationState の戻り値が 1 の場合にのみ応答に含まれます。

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

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。