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

PolarDB:CheckCloudResourceAuthorized

最終更新日:Sep 10, 2026

PolarDB-X インスタンスが Key Management Service (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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardbx:CheckCloudResourceAuthorized

none

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

RegionId

string

必須

インスタンスが属するリージョンの ID。

cn-hangzhou

DBInstanceName

string

必須

インスタンスの ID。

pxc-********

RoleArn

string

任意

権限が付与されたロールのグローバルリソース記述子 Amazon リソースネーム (ARN)。ロールの権限付与が完了すると、関連する KMS を使用できます。フォーマット: acs:ram::$accountID:role/$roleName。

  • $accountID: Alibaba Cloud アカウント ID。ID をビューするには、Alibaba Cloud マネジメントコンソールにログインし、右上隅のプロフィール画像にマウスを移動して、[セキュリティ設定項目] をクリックします。

  • $roleName: RAM ロール名。値は AliyunRdsInstanceEncryptionDefaultRole に固定されています。

acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

レスポンスフィールド

フィールド

型

説明

例

object

RequestId

string

リクエスト ID。

A501A191-BD70-5E50-98A9-C2A486A82****

Data

object

レスポンスボディ。

AuthorizationState

string

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

  • 0: 権限未付与。

  • 1: 権限付与済み。

  • 2: KMS が有効化されていない。

0

RoleArn

string

権限が付与されたロールのグローバルリソース記述子 Amazon リソースネーム (ARN)。ロールの権限付与が完了すると、関連する KMS を使用できます。フォーマット: acs:ram::$accountID:role/$roleName。

acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

例

成功レスポンス

JSONJSON

{
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Data": {
    "AuthorizationState": "0",
    "RoleArn": "acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole"
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

403 IncorrectEngineVersion The current engine version does not support the operation.

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

変更履歴

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