查询全球数据库网络(GDN)详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
polardb:DescribeGlobalDatabaseNetwork | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GDNId | string | 是 | GDN ID。 | gdn-bp1fttxsrmv***** |
ResourceGroupId | string | 否 | 资源组 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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | GDN.NotFound | Failed to found GdnInstance by name:%s | 按名称查找gdn实例失败:%s |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-29 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-01-24 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-06-21 | 新增 OpenAPI | 查看变更详情 |