全部产品
Search

搜索本产品

    云原生数据库 PolarDB：DescribeGlobalDatabaseNetworks - 查看所有全球数据库网络（GDN）详情

    文档中心

    云原生数据库 PolarDB：DescribeGlobalDatabaseNetworks - 查看所有全球数据库网络（GDN）详情

    更新时间：Jul 25, 2024

    查看账号下所有全球数据库网络（GDN）的详情。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    FilterRegionstring否

    查询可以在指定 Region 创建从集群的 GDN 列表。

    		cn-beijing
    DBClusterIdstring否

    集群 ID。

    说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息，包括集群 ID。
    		pc-**************
    PageSizeinteger否

    每页记录数。默认值为 30，取值如下：

    • 30
    • 50
    • 100
    		30
    PageNumberinteger否

    页码。默认值为 1，取值为大于 0 且不超过 Integer 数据类型的最大值。

    		1
    GDNDescriptionstring否

    GDN 描述。要求如下：

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

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

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

    • 长度为 2~126 个字符。

    		test
    GDNIdstring否

    GDN ID。

    		gdn-****************
    ResourceGroupIdstring否

    资源组 ID。

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

    返回参数

    名称类型描述示例值
    object
    TotalRecordCountinteger

    总记录数。

    		1
    PageRecordCountinteger

    本页记录数量。

    		30
    RequestIdstring

    请求 ID。

    		69A85BAF-1089-4CDF-A82F-0A140F******
    PageNumberinteger

    页数。

    		1
    Itemsarray<object>

    GDN 详情。

    object
    DBVersionstring

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

    		8.0
    GDNIdstring

    GDN ID。

    		gdn-****************
    CreateTimestring

    GDN 创建时间，格式为YYYY-MM-DDThh:mm:ssZ（UTC 时间）。

    		2020-03-23T05:46:54Z
    GDNStatusstring

    GDN 状态，取值范围如下：

    • creating：创建中
    • active：运行中
    • deleting：删除中
    • locked：锁定中（此时无法对 GDN 下的任一集群执行任何操作）
    • removing_member：从集群正在脱离 GDN
    		active
    DBClustersarray<object>

    GDN 包含的各集群详情。

    object
    DBClusterIdstring

    集群 ID。

    		pc-****************
    Rolestring

    集群角色，取值范围如下：

    • primary：主集群
    • standby：从集群
    说明 一个 GDN 中包含一个主集群和最多四个从集群。更多信息，请参见全球数据库网络（GDN）。
    		primary
    RegionIdstring

    地域 ID。

    		cn-hangzhou
    DBTypestring

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

    		MySQL
    GDNDescriptionstring

    GDN 描述。要求如下：

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

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

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

    • 长度为 2~126 个字符。

    		test

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.指定的参数PageSize无效
    400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.指定的参数PageNumber无效
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

    变更历史

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