全部产品
Search

搜索本产品

    云原生数据库 PolarDB：DescribeGlobalDatabaseNetwork - 查询全球数据库网络

    文档中心

    云原生数据库 PolarDB：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。

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。