DescribeGlobalDatabaseNetwork - 查询全球数据库网络

查询全球数据库网络(GDN)详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeGlobalDatabaseNetworkget
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

请求参数

名称类型必填描述示例值
GDNIdstring

GDN ID。

gdn-bp1fttxsrmv*****
ResourceGroupIdstring

资源组 ID。

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

返回参数

名称类型描述示例值
object
GDNStatusstring

GDN 的状态。取值:

  • creating:创建中

  • active:运行中

  • deleting:删除中

  • locked:锁定中(此时无法对 GDN 下的任一集群执行任何操作)

  • removing_member:从集群正在脱离 GDN

active
Connectionsarray<object>

链接信息。

Connectionobject
ConnectionStringstring

链接地址。

abc.polardb.rds.aliyuncs.com
NetTypestring

网络类型。

Private
Portstring

链接地址的端口号。

3306
DBVersionstring

数据库引擎版本。当前仅支持 8.0 版本。

8.0
RequestIdstring

请求 ID。

67F2E75F-AE67-4FB2-821F-A81237EACD15
GDNIdstring

GDN ID。

gdn-bp1fttxsrmv*****
CreateTimestring

GDN 的创建时间。

2020-02-24T11:57:54Z
DBTypestring

数据库引擎类型。当前仅支持 MySQL 类型。

MySQL
GDNDescriptionstring

GDN 备注描述。要求如下:

  • 不能以 http://或 https://开头。

  • 必须以大小写字母或中文开头。

  • 可以包含大小写字母、中文、数字、下划线(_)或连字符(-)。

  • 长度为 2~126 个字符。

GDN-fortest
GlobalDomainNamestring

全局域名

[gdnid].gdn.rds.aliyuncs.com
DBClustersarray<object>

GDN 中包含的集群。

DBClusterobject
ReplicaLagstring

主从集群间跨地域的复制延迟时间。单位为秒。

1
ExpireTimestring

集群到期时间。

说明 仅付费方式为 Prepaid(包年包月)的集群会返回具体参数值,Postpaid(按量付费)集群则返回空值。
2020-11-14T16:00:00Z
Expiredstring

集群是否到期。

  • true:是

  • false:否

说明 仅付费方式为 Prepaid(包年包月)的集群支持返回该参数。
false
DBNodeClassstring

数据库节点规格。

polar.mysql.x4.large
PayTypestring

付费类型:

  • Postpaid:按量付费。

  • Prepaid:预付费(包年包月)。

Prepaid
DBTypestring

数据库引擎类型。当前仅支持 MySQL 类型。

MySQL
RegionIdstring

地域 ID。

cn-hangzhou
DBVersionstring

数据库引擎版本。当前仅支持 8.0 版本。

8.0
DBClusterIdstring

GDN 中的集群 ID。

pc-wz9fb5nn44u1d****
DBClusterStatusstring

GDN 中的集群状态。具体请参见集群状态表

Running
StorageUsedstring

存储空间的使用量,单位为 Byte。

3012558848
DBClusterDescriptionstring

集群描述。

test
Categorystring

产品系列,取值范围如下:

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
    Rolestring

    集群角色。取值:

    • primary:主集群

    • standby:从集群

    说明 一个 GDN 中包含一个主集群和最多四个从集群。
    primary
    ServerlessTypestring

    Serverless 类型。当前取值固定为 AgileServerless(敏态)。

    说明 仅 Serverless 集群支持该参数。
    AgileServerless
    DBNodesarray<object>

    数据库节点的信息详情。

    DBNodeobject
    DBNodeClassstring

    数据库节点规格。

    polar.mysql.x4.large
    ZoneIdstring

    可用区 ID。

    cn-hangzhou-i
    CreationTimestring

    数据库节点的创建时间。

    2020-03-23T21:35:43Z
    DBNodeRolestring

    数据库节点的角色。取值:

    • Writer:主节点

    • Reader:只读节点

    Reader
    DBNodeStatusstring

    节点状态。取值:

    • Creating:创建中

    • Running:运行中

    • Deleting:删除中

    • Rebooting:重启中

    • ClassChanging:正在变更节点规格

    • NetAddressCreating:正在创建网络连接

    • NetAddressDeleting:正在删除网络连接

    • NetAddressModifying:正在修改网络连接

    • MinorVersionUpgrading:小版本升级中

    • Maintaining:集群维护中

    • Switching:切换中

    Running
    FailoverPriorityinteger

    Failover 优先级。每个节点都有一个 Failover 优先级,决定了当故障切换时,该节点被选举为主节点的概率高低。数值越大,优先级越高,取值范围为 1~15。

    1
    MaxConnectionsinteger

    集群最大的并发连接数。

    8000
    MaxIOPSinteger

    最大 I/O 请求次数,即 IOPS。

    32000
    DBNodeIdstring

    数据库节点 ID。

    pi-****************
    DBClusterIdstring

    集群 ID

    pc-bp1s826a1up******
    ResourceGroupIdstring

    资源组 ID

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

    示例

    正常返回示例

    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-************"
    }

    错误码

    HTTP status code错误码错误信息描述
    400GDN.NotFoundFailed to found GdnInstance by name:%s按名称查找gdn实例失败:%s
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

    变更历史

    变更时间变更内容概要操作
    2024-08-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-01-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2021-06-21新增 OpenAPI查看变更详情