调用DescribeGlobalDatabaseNetworks接口查看账号下所有全球数据库网络(GDN)的详情。

全球数据库(Global Database Network,简称GDN)是由分布在全球不同地域的多个PolarDB集群组成的网络,网络中所有集群的数据保持同步。当您的业务部署在多个地域时,实现应用访问数据库的低延迟和高稳定性。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeGlobalDatabaseNetworks

系统规定参数,取值为DescribeGlobalDatabaseNetworks

返回数据

名称 类型 示例值 描述
Items Array of GlobalDatabaseNetwork

GDN详情。

CreateTime String 2020-03-23T05:46:54Z

GDN创建时间,格式为YYYY-MM-DDThh:mm:ssZ(UTC时间)。

DBClusters Array of DBCluster

GDN包含的各集群详情。

DBClusterId String pc-****************

集群ID。

RegionId String cn-hangzhou

地域ID。

Role String primary

集群角色,取值范围如下:

  • primary:主集群
  • standby:从集群
说明 一个GDN中包含一个主集群和最多四个从集群。更多信息,请参见全球数据库网络(GDN)
DBType String MySQL

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

DBVersion String 8.0

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

GDNDescription String test

GDN名称。

GDNId String gdn-****************

GDN ID。

GDNStatus String active

GDN状态,取值范围如下:

  • creating:创建中
  • active:运行中
  • deleting:删除中
  • locked:锁定中(此时无法对GDN下的任一集群执行任何操作)
  • removing_member:从集群正在脱离GDN
PageNumber Integer 1

页数。

PageRecordCount Integer 30

本页记录数量。

RequestId String 69A85BAF-1089-4CDF-A82F-0A140F******

请求ID。

TotalRecordCount Integer 1

总记录数。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeGlobalDatabaseNetworks
&<公共请求参数>

正常返回示例

XML 格式

<DescribeGlobalDatabaseNetworksResponse>
  <TotalRecordCount>1</TotalRecordCount>
  <PageRecordCount>30</PageRecordCount>
  <RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>
  <PageNumber>1</PageNumber>
  <Items>
        <GDNStatus>active</GDNStatus>
        <DBVersion>8.0</DBVersion>
        <GDNId>gdn-****************</GDNId>
        <CreateTime>2020-03-23T05:46:54Z</CreateTime>
        <GDNDescription>test</GDNDescription>
        <DBType>MySQL</DBType>
        <DBClusters>
              <Role>primary</Role>
              <DBClusterId>pc-****************</DBClusterId>
              <RegionId>cn-hangzhou</RegionId>
        </DBClusters>
        <DBClusters>
              <Role>standby</Role>
              <DBClusterId>pc-****************</DBClusterId>
              <RegionId>cn-shanghai</RegionId>
        </DBClusters>
  </Items>
</DescribeGlobalDatabaseNetworksResponse>

JSON 格式

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

错误码

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