すべてのプロダクト
Search

このプロダクト

    :DescribeGlobalDatabaseNetworks

    ドキュメントセンター

    :DescribeGlobalDatabaseNetworks

    最終更新日:Dec 12, 2025

    アカウント内のすべてのグローバルデータベースネットワーク (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:DescribeGlobalDatabaseNetworks

    get

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FilterRegion

    string

    任意

    指定されたリージョンでセカンダリクラスターを作成できる GDN のリストを照会します。

    cn-beijing
    DBClusterId

    string

    任意

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、クラスター ID を含む、リージョン内のすべてのクラスターに関する情報を照会できます。

    pc-**************
    PageSize

    integer

    任意

    1 ページあたりのレコード数。 デフォルト値：30。 有効な値：

    • 30

    • 50

    • 100

    30
    PageNumber

    integer

    任意

    ページ番号。 値は、Integer データ型の最大値を超えない正の整数である必要があります。 デフォルト値：1。

    1
    GDNDescription

    string

    任意

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

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

    • 先頭は英字である必要があります。

    • 英字、数字、アンダースコア (_)、ハイフン (-) を使用できます。

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

    test
    GDNId

    string

    任意

    GDN の ID。

    gdn-****************
    ResourceGroupId

    string

    任意

    リソースグループ ID。

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalRecordCount

    integer

    レコードの総数。

    1
    PageRecordCount

    integer

    現在のページに表示されるレコード数。

    30
    RequestId

    string

    リクエスト ID。

    69A85BAF-1089-4CDF-A82F-0A140F******
    PageNumber

    integer

    ページ番号。

    1
    Items

    array<object>

    GDN の詳細。

    array<object>

    DBVersion

    string

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

    8.0
    GDNId

    string

    GDN の ID。

    gdn-****************
    CreateTime

    string

    GDN が作成された時刻。 時刻は YYYY-MM-DDThh:mm:ssZ フォーマットの UTC 時間です。

    2020-03-23T05:46:54Z
    GDNStatus

    string

    GDN のステータス。 有効な値：

    • creating：GDN は作成中です。

    • active：GDN は実行中です。

    • deleting：GDN は削除中です。

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

    • removing_member：セカンダリクラスターは GDN から削除中です。

    active
    DBClusters

    array<object>

    GDN 内のクラスターの詳細。

    object

    DBClusterId

    string

    クラスター ID。

    pc-****************
    Role

    string

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

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

    • standby：セカンダリクラスター。

    説明

    GDN には、1 つのプライマリクラスターと最大 4 つのセカンダリクラスターが含まれます。 詳細については、「グローバルデータベースネットワーク (GDN)」をご参照ください。

    primary
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    DBType

    string

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

    MySQL
    GDNDescription

    string

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

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

    • 先頭は英字である必要があります。

    • 英字、数字、アンダースコア (_)、ハイフン (-) を使用できます。

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

    test
    Labels

    object

    GDNVersion

    string

    例

    成功レスポンス

    JSONJSON

    {
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "RequestId": "69A85BAF-1089-4CDF-A82F-0A140F******",
  "PageNumber": 1,
  "Items": [
    {
      "DBVersion": "8.0",
      "GDNId": "gdn-****************",
      "CreateTime": "2020-03-23T05:46:54Z",
      "GDNStatus": "active",
      "DBClusters": [
        {
          "DBClusterId": "pc-****************",
          "Role": "primary",
          "RegionId": "cn-hangzhou"
        }
      ],
      "DBType": "MySQL",
      "GDNDescription": "test",
      "Labels": {
        "GDNVersion": ""
      }
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.
    400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.

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

    変更履歴

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