全部產品
Search
文件中心

PolarDB:DescribeGlobalDatabaseNetworks - 查看所有全球資料庫網路(GDN)詳情

更新時間:Apr 17, 2026

查看帳號下所有全球資料庫網路(GDN)的詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeGlobalDatabaseNetworks

get

*DBCluster

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

請求參數

名稱

類型

必填

描述

樣本值

FilterRegion

string

查詢可以在指定 Region 建立從叢集的 GDN 列表。

cn-beijing

DBClusterId

string

叢集 ID。

說明

您可以調用 DescribeDBClusters 介面查看目標地區下所有的叢集資訊,包括叢集 ID。

pc-**************

PageSize

integer

每頁記錄數。預設值為 30,取值如下:

  • 30

  • 50

  • 100

30

PageNumber

integer

頁碼。預設值為 1,取值為大於 0 且不超過 整數資料類型的最大值。

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:建立中

  • active:運行中

  • deleting:刪除中

  • locked:鎖定中(此時無法對 GDN 下的任一叢集執行任何操作)

  • removing_member:從叢集正在脫離 GDN

active

DBClusters

array<object>

GDN 包含的各叢集詳情。

object

DBClusterId

string

叢集 ID。

pc-****************

Role

string

叢集角色,取值範圍如下:

  • primary:主叢集

  • standby:從叢集

說明

一個 GDN 中包含一個主叢集和最多四個從叢集。更多資訊,請參見全球資料庫網路(GDN)

primary

RegionId

string

地區 ID。

cn-hangzhou

DBType

string

資料庫引擎類型,當前僅支援 MySQL 類型。

MySQL

GDNDescription

string

GDN 描述。要求如下:

  • 不能以 http://或 https://開頭。

  • 必須以大小寫字母或中文開頭。

  • 可以包含大小寫字母、中文、數字、底線(_)或連字號(-)。

  • 長度為 2~126 個字元。

test

Labels

object

屬性標籤。

GDNVersion

string

GDN 版本

2.0

樣本

正常返回樣本

JSON格式

{
  "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": "2.0"
      }
    }
  ]
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidPageSize.Malformed The specified parameter PageSize is not valid. 指定的參數PageSize無效
400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid. 指定的參數PageNumber無效
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情