使用DescribeGlobalDatabaseNetworks查询所有全球数据库网络（GDN）详情-云原生数据库 PolarDB-阿里云

查看账号下所有全球数据库网络（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 且不超过 Integer 数据类型的最大值。	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 详情。
GlobalDatabaseNetwork	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 包含的各集群详情。
DBCluster	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

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "RequestId": "69A85BAF-1089-4CDF-A82F-0A140F******",
  "PageNumber": 1,
  "Items": [
    {
      "DBVersion": 8,
      "GDNId": "gdn-****************",
      "CreateTime": "2020-03-23T05:46:54Z",
      "GDNStatus": "active",
      "DBClusters": [
        {
          "DBClusterId": "pc-****************",
          "Role": "primary",
          "RegionId": "cn-hangzhou"
        }
      ],
      "DBType": "MySQL",
      "GDNDescription": "test",
      "Labels": {
        "GDNVersion": ""
      }
    }
  ]
}

错误码

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。

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

变更历史

变更时间	变更内容概要	操作
2024-07-25	OpenAPI 错误码发生变更	查看变更详情
2023-08-15	OpenAPI 错误码发生变更	查看变更详情
2022-07-26	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2022-06-30	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情