すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeGlobalDatabaseNetwork

    ドキュメントセンター

    PolarDB:DescribeGlobalDatabaseNetwork

    最終更新日:Apr 17, 2026

    Global Database Network (GDN) の詳細を取得します。

    今すぐお試しください

    この 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:DescribeGlobalDatabaseNetwork

    get

    *dbcluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GDNId

    string

    必須

    Global Database Network (GDN) の ID。

    gdn-bp1fttxsrmv*****
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    GDNStatus

    string

    Global Database Network (GDN) のステータス。有効な値：

    • creating：GDN は作成中です。

    • active：GDN は実行中です。

    • deleting：GDN は削除中です。

    • locked：GDN はロックされています。この状態では、GDN 内のどのクラスターに対しても操作を実行できません。

    • removing_member：クラスターが GDN から削除されています。

    active
    Connections

    array<object>

    接続の詳細。

    object

    ConnectionString

    string

    接続文字列。

    abc.polardb.rds.aliyuncs.com
    NetType

    string

    ネットワークタイプ。

    Private
    Port

    string

    接続文字列のポート番号。

    3306
    DBVersion

    string

    データベースエンジンバージョン。バージョン 8.0 のみがサポートされています。

    8.0
    RequestId

    string

    リクエスト ID。

    67F2E75F-AE67-4FB2-821F-A81237EACD15
    GDNId

    string

    GDN ID。

    gdn-bp1fttxsrmv*****
    CreateTime

    string

    GDN が作成された時刻。

    2020-02-24T11:57:54Z
    DBType

    string

    データベースエンジンタイプ。MySQL のみがサポートされています。

    MySQL
    GDNDescription

    string

    GDN の説明。次の要件を満たす必要があります：

    • http:// または https:// で始めることはできません。

    • 英字または中国語文字で始める必要があります。

    • 英字、中国語文字、数字、アンダースコア (_)、ハイフン (-) のみを含めることができます。

    • 長さは 2～126 文字である必要があります。

    GDN-fortest
    GlobalDomainName

    string

    グローバルドメイン名。

    [gdnid].gdn.rds.aliyuncs.com
    DBClusters

    array<object>

    GDN 内のクラスター。

    array<object>

    ReplicaLag

    string

    プライマリクラスターとスタンバイクラスター間のクロスリージョンレプリケーションのレプリケーションラグ。単位：秒。

    1
    ExpireTime

    string

    クラスターの有効期限。

    説明

    このパラメーターは、サブスクリプションクラスターに対してのみ返されます。従量課金クラスターの場合は、空の文字列が返されます。

    2020-11-14T16:00:00Z
    Expired

    string

    クラスターが期限切れかどうかを示します。有効な値：

    • true：クラスターは期限切れです。

    • false：クラスターは期限切れではありません。

    説明

    このパラメーターは、サブスクリプションクラスターに対してのみ返されます。

    false
    DBNodeClass

    string

    ノードタイプ。

    polar.mysql.x4.large
    PayType

    string

    クラスターの課金方法。有効な値：

    • Postpaid：従量課金。

    • Prepaid：サブスクリプション。

    Prepaid
    DBType

    string

    データベースエンジン。MySQL のみがサポートされています。

    MySQL
    RegionId

    string

    クラスターのリージョン ID。

    cn-hangzhou
    DBVersion

    string

    データベースエンジンバージョン。バージョン 8.0 のみがサポートされています。

    8.0
    DBClusterId

    string

    クラスター ID。

    pc-wz9fb5nn44u1d****
    DBClusterStatus

    string

    クラスターのステータス。詳細については、「クラスターのステータス」をご参照ください。

    Running
    StorageUsed

    string

    使用済みストレージ容量。単位：バイト。

    3012558848
    DBClusterDescription

    string

    クラスターの説明。

    test
    Category

    string

    クラスターのエディション。有効な値：

    Normal: Cluster Edition Basic: シングルノードエディション Archive: X-Engine エディション NormalMultimaster: Multi-master Cluster Edition SENormal: Standard Edition

    説明

    • PostgreSQL 11 を実行する PolarDB for PostgreSQL クラスターでは、シングルノードエディションはサポートされていません。

    • Standard Edition は、MySQL 8.0 または 5.7 を実行する PolarDB for MySQL クラスター、および PostgreSQL 14 を実行する PolarDB for PostgreSQL クラスターでサポートされています。

    • X-Engine エディションと Multi-master Cluster Edition は、MySQL 8.0 を実行する PolarDB for MySQL クラスターでのみサポートされています。

    Normal
    Role

    string

    GDN 内のクラスターのロール。有効な値：

    • primary：プライマリクラスター

    • standby：スタンバイクラスター

    説明

    GDN は、1 つのプライマリクラスターと最大 4 つのスタンバイクラスターで構成されます。

    primary
    ServerlessType

    string

    サーバーレスクラスターのタイプ。値は AgileServerless に固定されています。

    説明

    このパラメーターは、サーバーレスクラスターに対してのみ返されます。

    AgileServerless
    DBNodes

    array<object>

    クラスター内のノードの詳細。

    object

    DBNodeClass

    string

    ノードタイプ。

    polar.mysql.x4.large
    ZoneId

    string

    ゾーン ID。

    cn-hangzhou-i
    CreationTime

    string

    ノードが作成された時刻。

    2020-03-23T21:35:43Z
    DBNodeRole

    string

    ノードのロール。有効な値：

    • Writer：プライマリノード

    • Reader：読み取り専用ノード

    Reader
    DBNodeStatus

    string

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

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

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

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

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

    • ClassChanging：ノードタイプは変更中です。

    • NetAddressCreating：ネットワーク接続は作成中です。

    • NetAddressDeleting：ネットワーク接続は削除中です。

    • NetAddressModifying：ネットワーク接続は変更中です。

    • MinorVersionUpgrading：マイナーバージョンはアップグレード中です。

    • Maintaining：クラスターはメンテナンス中です。

    • Switching：フェイルオーバーは進行中です。

    Running
    FailoverPriority

    integer

    フェイルオーバー優先度。フェイルオーバーが発生した場合、システムは読み取り専用ノードをプライマリノードに昇格させます。値が大きいほど優先度が高くなります。各読み取り専用ノードには、フェイルオーバー優先度が割り当てられます。有効な値：1～15。

    1
    MaxConnections

    integer

    最大同時接続数。

    8000
    MaxIOPS

    integer

    最大 IOPS。

    32000
    DBNodeId

    string

    ノード ID。

    pi-****************
    DBClusterId

    string

    クラスター ID。

    pc-bp1s826a1up******
    ResourceGroupId

    string

    リソースグループ ID。

    rg-************
    Labels

    object

    GDN のラベル。

    GDNVersion

    string

    GDN のバージョン。

    2.0

    例

    成功レスポンス

    JSONJSON

    {
  "GDNStatus": "active",
  "Connections": [
    {
      "ConnectionString": "abc.polardb.rds.aliyuncs.com",
      "NetType": "Private",
      "Port": "3306"
    }
  ],
  "DBVersion": "8.0",
  "RequestId": "67F2E75F-AE67-4FB2-821F-A81237EACD15",
  "GDNId": "gdn-bp1fttxsrmv*****",
  "CreateTime": "2020-02-24T11:57:54Z",
  "DBType": "MySQL",
  "GDNDescription": "GDN-fortest",
  "GlobalDomainName": "[gdnid].gdn.rds.aliyuncs.com",
  "DBClusters": [
    {
      "ReplicaLag": "1",
      "ExpireTime": "2020-11-14T16:00:00Z",
      "Expired": "false",
      "DBNodeClass": "polar.mysql.x4.large",
      "PayType": "Prepaid",
      "DBType": "MySQL",
      "RegionId": "cn-hangzhou",
      "DBVersion": "8.0",
      "DBClusterId": "pc-wz9fb5nn44u1d****",
      "DBClusterStatus": "Running",
      "StorageUsed": "3012558848",
      "DBClusterDescription": "test",
      "Category": "Normal",
      "Role": "primary",
      "ServerlessType": "AgileServerless",
      "DBNodes": [
        {
          "DBNodeClass": "polar.mysql.x4.large",
          "ZoneId": "cn-hangzhou-i",
          "CreationTime": "2020-03-23T21:35:43Z",
          "DBNodeRole": "Reader",
          "DBNodeStatus": "Running",
          "FailoverPriority": 1,
          "MaxConnections": 8000,
          "MaxIOPS": 32000,
          "DBNodeId": "pi-****************"
        }
      ]
    }
  ],
  "DBClusterId": "pc-bp1s826a1up******",
  "ResourceGroupId": "rg-************",
  "Labels": {
    "GDNVersion": "2.0"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 GDN.NotFound Failed to found GdnInstance by name:%s
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.

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

    変更履歴

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