すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeDBClusterAccessWhiteList

    ドキュメントセンター

    AnalyticDB:DescribeDBClusterAccessWhiteList

    最終更新日:Feb 26, 2026

    AnalyticDB for MySQL クラスターの IP アドレスホワイトリストを照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    adb:DescribeDBClusterAccessWhiteList

    get

    DBCluster

    acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    am-uf6wjk5xxxxxxxxxx
    RegionId

    string

    任意

    クラスターが属するリージョン ID。

    説明

    DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-qingdao

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    1AD222E9-E606-4A42-BF6D-8A4442913CEF
    Items

    object

    IPArray

    array<object>

    照会された IP アドレスホワイトリスト。

    object

    DBClusterIPArrayAttribute

    string

    IP アドレスホワイトリストの属性。デフォルトでは、このパラメーターは空です。

    説明

    hidden 属性を持つ IP アドレスホワイトリストは、コンソールに表示されません。これらの IP アドレスホワイトリストは、Data Transmission Service (DTS) や PolarDB-X などのサービスにアクセスするために使用されます。

    hidden
    SecurityIPList

    string

    IP アドレスホワイトリスト内の IP アドレス。最大 1,000 個の IP アドレスを返すことができます。複数の IP アドレスはカンマ (,) で区切られます。

    127.0.0.1
    DBClusterIPArrayName

    string

    IP アドレスホワイトリストの名前。

    • IP アドレスホワイトリストの名前は、長さが 2～32 文字である必要があります。名前に使用できる文字は、小文字、数字、アンダースコア (_) です。名前は小文字で始まり、小文字または数字で終わる必要があります。

    • 各クラスターは最大 50 個の IP アドレスホワイトリストをサポートします。

    test

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "IPArray": [
      {
        "DBClusterIPArrayAttribute": "hidden",
        "SecurityIPList": "127.0.0.1",
        "DBClusterIPArrayName": "test"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The DBClusterId provided does not exist in our records.

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

    変更履歴

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