この操作を呼び出して、KMS キーが ApsaraDB for MongoDB インスタンスに対して権限を与えられているかどうかを確認できます。

ModifyDBInstanceTDE 操作を呼び出して透過的データ暗号化 (Transparent Data Encryption; TDE) を有効にする前に、KMS キーが ApsaraDB for MongoDB インスタンスに権限付与されているかどうかを確認できます。

注 KMS キーが ApsaraDB for MongoDB インスタンスに対して権限を付与されていない場合、TDE は有効にできません。 チケットを起票し、権限情報を変更できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この API は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK に用意されている API のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須項目 例 説明
DBInstanceId String 必須 dds-bpxxxxxxxx

インスタンスの ID。
TargetRegionId String 必須 cn-hangzhou

インスタンスのリージョン ID 。 インスタンスのリージョン ID を照会するには、DescribeDBInstanceAttribute 操作を呼び出します。

Action String 必須 CheckCloudResourceAuthorized

実行する操作。 値を CheckCloudResourceAuthorized に設定します。

AccessKeyId String 任意 LTAIgbTGpxxxxxx

Alibaba Cloud から提供された AccessKey ID。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String A0181AC4-F186-46ED-87CA-100C70B86729

リクエストの ID。
AuthorizationState Integer 1

KMS キーが ApsaraDB for MongoDB インスタンスに対して権限付与されているかどうかを示します。 有効値：

  • 0：権限なし
  • 1：権限あり
  • 2：KMS が無効
RoleArn String acs:ram::140xxxxxxxx:role/aliyunrdsinstanceencryptiondefaultrole

権限付与された Alibaba リソース名 (ARN) のロール情報。

注 このパラメーターは、戻り値パラメーターの AuthorizationState が 1 の場合に有効です。

例

リクエスト例


http(s)://mongodb.aliyuncs.com/? Action=CheckCloudResourceAuthorized
&DBInstanceId=dds-bpxxxxxxxx
&TargetRegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式 

<RequestId>A0181AC4-F186-46ED-87CA-100C70B86729</RequestId>
<AuthorizationState>1</AuthorizationState>
<RoleArn>acs:ram::140xxxxxxxx:role/aliyunrdsinstanceencryptiondefaultrole</RoleArn>

JSON 形式 

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

エラーコード

エラーコードについては、「API エラーセンター」をご参照ください。