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

PolarDB:DescribeGlobalDataNetworkList

最終更新日:Sep 24, 2026

全リージョンの Polarlakebase グローバルデータベースネットワーク (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:DescribeGlobalDataNetworkList

list

*すべてのリソース。

*

なし なし

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

PageNumber

integer

任意

クエリ結果のページ番号。

1

PageSize

integer

任意

1 ページあたりのレコード数。

30

レスポンスフィールド

フィールド

型

説明

例

object

応答のスキーマ。

RequestId

string

リクエスト ID。

CD35F3-F3-44CA-AFFF-BAF869******

TotalRecordCount

string

レコードの総数。

1

PageRecordCount

string

現在のページのレコード数。

1

PageNumber

string

ページ番号。

1

Items

object

GDN の詳細。

Networks

array<object>

GDN ネットワークのリスト。

array<object>

GDN ネットワークの詳細。

NetworkId

string

GDN ID。

gdn-xxx

NetworkDescription

string

GDN の説明。

mygdn

NetworkStatus

string

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

  • Creating: 作成中。

  • Running: 実行中。

  • Syncing: 同期中。

  • SyncFinished: 同期完了。

  • SyncFailed: 同期に失敗した。

  • SyncPartialFailed: 部分的な同期に失敗した。

  • Stopped: 停止。

  • Maintaining: メンテナンス中。

  • Restarting: 再起動中。

  • Locking: ロック中。

  • Locked: ロック済み。

  • Unlocking: ロック解除中。

  • Deleting: 削除中。

  • Deleted: 削除済み。

Running

NetworkTopology

object

GDN のネットワークトポロジー。

Sources

array<object>

同期ソースのリスト。

object

同期ソース。

SourceFileSystemPath

string

ソースパス。

/

SourceType

string

ソースタイプ。有効な値:

  • pfs: Polarlakebase High-performance エディション。

  • pcs: Polarlakebase コールドストレージエディション。

pcs

SourceRegion

string

ソースリージョン。

cn-wulanchabu

SourceId

string

ソース Polarlakebase インスタンス。

pcs-xxx

Destinations

array<object>

同期送信先のリスト。

object

同期送信先。

DestinationFileSystemPath

string

宛先パス。

/

DestinationRegion

string

ターゲットリージョン。

cn-beijing

DestinationType

string

送信先タイプ。有効な値:

  • pfs: Polarlakebase High-performance エディション。

  • pcs: Polarlakebase コールドストレージエディション。

pfs

DestinationId

string

送信先 Polarlakebase インスタンス。

pfs-xxx

CreateTime

string

GDN の作成時間。

時間は ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

2025-03-25T09:37:10Z

Channels

array<object>

同期チャネルのリスト。

object

同期チャネル。

ChannelId

string

同期チャネルの ID。

gdc-xxx

ChannelStatus

string

同期チャネルのステータス。有効な値:

  • Creating: 作成中。

  • Running: 実行中。

  • Syncing: 同期中。

  • SyncFinished: 同期完了。

  • SyncFailed: 同期に失敗した。

  • SyncPartialFailed: 部分的な同期に失敗した。

  • Stopped: 停止。

  • Maintaining: メンテナンス中。

  • Restarting: 再起動中。

  • Locking: ロック中。

  • Locked: ロック済み。

  • Unlocking: ロック解除中。

  • Deleting: 削除中。

  • Deleted: 削除済み。

Syncing

Progress

string

現在の同期の進行状況。

説明

値は浮動小数点のパーセンテージで、小数点以下 2 桁です。

11.45%

FreezeSourceDuringSync

boolean

転送中にソースパスをフリーズするかどうかを指定します。

true

例

成功レスポンス

JSONJSON

{
  "RequestId": "CD35F3-F3-44CA-AFFF-BAF869******",
  "TotalRecordCount": "1",
  "PageRecordCount": "1",
  "PageNumber": "1",
  "Items": {
    "Networks": [
      {
        "NetworkId": "gdn-xxx",
        "NetworkDescription": "mygdn",
        "NetworkStatus": "Running",
        "NetworkTopology": {
          "Sources": [
            {
              "SourceFileSystemPath": "/",
              "SourceType": "pcs",
              "SourceRegion": "cn-wulanchabu",
              "SourceId": "pcs-xxx"
            }
          ],
          "Destinations": [
            {
              "DestinationFileSystemPath": "/",
              "DestinationRegion": "cn-beijing",
              "DestinationType": "pfs",
              "DestinationId": "pfs-xxx"
            }
          ]
        },
        "CreateTime": "2025-03-25T09:37:10Z",
        "Channels": [
          {
            "ChannelId": "gdc-xxx",
            "ChannelStatus": "Syncing",
            "Progress": "11.45%",
            "FreezeSourceDuringSync": true
          }
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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