すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeDBClusterProxy

    ドキュメントセンター

    PolarDB:DescribeDBClusterProxy

    最終更新日:Dec 11, 2025

    データベースクラスタープロキシの詳細を照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeDBClusterProxy

    get

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    pc-2zek76tdi709m6mf4
    RegionId

    string

    任意

    リージョン ID。

    説明

    詳細については、「DescribeRegions」をご参照ください。

    cn-hangzhou
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-acfm4ifnqnun3zq

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    ChildInstances

    array<object>

    Cloud Enterprise Network (CEN) インスタンスによってロードされたネットワークインスタンスのリスト。

    object

    ネットワークインスタンスの詳細。

    DBNodeClass

    string

    ノードの仕様。 詳細については、次のドキュメントをご参照ください：

    polar.mysql.g4.medium
    DBNodeIP

    string

    データベースクラスターノードのプライベート IP アドレス。

    10.*.*10
    DBNodeId

    string

    データベースクラスターノードの ID。

    pi-wz97h479y364g9du7
    DBNodePort

    string

    データベースクラスターノードのポート。

    2450
    DBNodeStatus

    string

    ノードのステータス。 有効な値：

    • Creating: ノードは作成中です。

    • Running: ノードは実行中です。

    • Deleting: ノードは削除中です。

    • Rebooting: ノードは再起動中です。

    • DBNodeCreating: ノードが追加されています。

    • DBNodeDeleting: ノードが削除されています。

    • ClassChanging: ノードの仕様が変更されています。

    • NetAddressCreating: ネットワーク接続が作成されています。

    • NetAddressDeleting: ネットワーク接続が削除されています。

    • NetAddressModifying: ネットワーク接続が変更されています。

    • MinorVersionUpgrading: マイナーバージョンがアップグレードされています。

    • Maintaining: インスタンスはメンテナンス中です。

    • Switching: スイッチオーバーが進行中です。

    Running
    HostName

    string

    ホスト名。

    sh-lsf01-144-37
    DBProxyClusterId

    string

    プロキシクラスター ID。

    pe-xxxxxxxxx
    DBProxyClusterNum

    integer

    プロキシノードの数。

    2
    DBProxyClusterStatus

    string

    プロキシクラスターのステータス。

    ClassChanging
    RequestId

    string

    リクエスト ID。

    30E11ED2-C922-5B96-BCC6-11EE8C484AC6

    例

    成功レスポンス

    JSONJSON

    {
  "ChildInstances": [
    {
      "DBNodeClass": "polar.mysql.g4.medium",
      "DBNodeIP": "10.*.*10",
      "DBNodeId": "pi-wz97h479y364g9du7",
      "DBNodePort": "2450",
      "DBNodeStatus": "Running",
      "HostName": "sh-lsf01-144-37"
    }
  ],
  "DBProxyClusterId": "pe-xxxxxxxxx",
  "DBProxyClusterNum": 2,
  "DBProxyClusterStatus": "ClassChanging",
  "RequestId": "30E11ED2-C922-5B96-BCC6-11EE8C484AC6"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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