全部產品
Search

搜尋本產品

    ：DescribeGlobalDatabaseNetwork - 查詢全球資料庫網路

    文件中心

    ：DescribeGlobalDatabaseNetwork - 查詢全球資料庫網路

    更新時間：Dec 11, 2025

    查詢全球資料庫網路（GDN）詳情。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeGlobalDatabaseNetwork

    get

    *dbcluster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    GDNId

    string

    是

    GDN ID。

    gdn-bp1fttxsrmv*****
    ResourceGroupId

    string

    否

    資源群組 ID。

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    GDNStatus

    string

    GDN 的狀態。取值：

    • creating：建立中

    • active：運行中

    • deleting：刪除中

    • locked：鎖定中（此時無法對 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

    叢集到期時間。

    說明

    僅付費方式為 Prepaid（訂用帳戶）的叢集會返回具體參數值，Postpaid（隨用隨付）叢集則返回空值。

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

    string

    叢集是否到期。

    • true：是

    • false：否

    說明

    僅付費方式為 Prepaid（訂用帳戶）的叢集支援返回該參數。

    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

    GDN 中的叢集 ID。

    pc-wz9fb5nn44u1d****
    DBClusterStatus

    string

    GDN 中的叢集狀態。具體請參見叢集狀態表。

    Running
    StorageUsed

    string

    儲存空間的使用量，單位為 Byte。

    3012558848
    DBClusterDescription

    string

    叢集描述。

    test
    Category

    string

    產品系列，取值範圍如下：

    Normal：叢集版 Basic：單節點 Archive：高壓縮引擎（X-Engine） NormalMultimaster：多主架構叢集版 SENormal：標準版

    說明

    • PolarDB PostgreSQL 版 PostgreSQL 11 版本不支援單節點。

    • PolarDB MySQL 版 8.0 版本、5.7 版本，PolarDB PostgreSQL 版 PostgreSQL 14 版本支援標準版。

    • PolarDB MySQL 版 8.0 版本，支援高壓縮引擎（X-Engine）和多主架構叢集版。

    Normal
    Role

    string

    叢集角色。取值：

    • primary：主叢集

    • standby：從叢集

    說明

    一個 GDN 中包含一個主叢集和最多四個從叢集。

    primary
    ServerlessType

    string

    Serverless 類型。當前取值固定為 AgileServerless（敏態）。

    說明

    僅 Serverless 叢集支援該參數。

    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

    Failover 優先順序。每個節點都有一個 Failover 優先順序，決定了當故障切換時，該節點被選舉為主節點的機率高低。數值越大，優先順序越高，取值範圍為 1~15。

    1
    MaxConnections

    integer

    叢集最大的並發串連數。

    8000
    MaxIOPS

    integer

    最大 I/O 請求次數，即 IOPS。

    32000
    DBNodeId

    string

    資料庫節點 ID。

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

    string

    叢集 ID

    pc-bp1s826a1up******
    ResourceGroupId

    string

    資源群組 ID

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

    object

    GDNVersion

    string

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 GDN.NotFound Failed to found GdnInstance by name:%s
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

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

    變更歷史

    更多資訊，參考變更詳情。