DescribeGadInstances - 查询Gad实例列表

更新时间: 2023-09-20 11:44:13

调用DescribeGadInstances接口查询RDS全球多活数据库集群列表或目标集群的详细信息。

调试

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

调试

授权信息

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

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

请求参数

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

RDS全球多活数据库集群ID。

  • 不传入该参数返回当前账号下的所有集群ID。
  • 传入该参数返回目标集群的详细信息。
说明 您可在第一次调用时不传入此参数获取当前账号下的所有集群ID,再通过传入集群ID查看该集群的详情。
gad-rm-bp1npi2j8********
RegionIdstring

地域ID,可调用DescribeRegions查询。

cn-hangzhou
ResourceGroupIdstring

资源组ID。

rg-acfmy*****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

76AF0609-4195-5DFC-BC78-3AD76FF872BB
GadInstancesobject []

由RDS全球多活数据库集群信息组成的数组。

GadInstanceNamestring

RDS全球多活数据库集群的ID。

gad-rm-bp1npi2j8********
Descriptionstring

集群名称。

GadTest
Statusstring

集群状态。取值:

  • activation:运行中。
  • creating:创建中。
  • replica_adding:添加节点中。
activation
CreationTimestring

集群的创建时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

2021-10-21T02:57:08Z
ModificationTimestring

最后一次变更集群的时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

2021-10-21T03:01:20Z
GadInstanceMembersobject []

由集群中各节点信息组成的数组。

DBInstanceIDstring

集群中节点的ID。

rm-bp1npi2j8********
Enginestring

集群中节点的数据库引擎。

说明 当前仅支持mysql
mysql
EngineVersionstring

集群中节点的数据库版本。

8.0
RegionIdstring

集群中节点所在的地域ID。

cn-hangzhou
Rolestring

RDS全球多活数据库集群中的节点类型。返回值:

  • CENTRAL:中心节点,集群中的唯一主节点,所有单元节点的数据都从该节点同步。
  • UNIT:单元节点,一个集群中可以有10个单元节点,所有单元节点都从中心节点同步数据。
CENTRAL
Statusstring

节点状态。取值:

  • activation:运行中。
  • creating:创建中。
activation
DtsInstancestring

包含DTS同步信息的JSON数组。

说明 每个单元节点(备节点)都会通过DTS和中心节点(主节点)进行数据同步,该参数中包含了DTS的同步链路ID和请求ID。
{\"dtsInstanceId\":\"dtsm9t107c********\",\"dtsRequestId\":\"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\"}
ResourceGroupIdstring

资源组ID。

rg-acfmy*****
Servicestring

RDS全球多活数据库集群的引擎。

说明 当前仅支持mysql
mysql

示例

正常返回示例

JSON格式

{
  "RequestId": "76AF0609-4195-5DFC-BC78-3AD76FF872BB",
  "GadInstances": [
    {
      "GadInstanceName": "gad-rm-bp1npi2j8********",
      "Description": "GadTest",
      "Status": "activation",
      "CreationTime": "2021-10-21T02:57:08Z",
      "ModificationTime": "2021-10-21T03:01:20Z",
      "GadInstanceMembers": [
        {
          "DBInstanceID": "rm-bp1npi2j8********",
          "Engine": "mysql",
          "EngineVersion": "8.0",
          "RegionId": "cn-hangzhou",
          "Role": "CENTRAL",
          "Status": "activation",
          "DtsInstance": "{\\\"dtsInstanceId\\\":\\\"dtsm9t107c********\\\",\\\"dtsRequestId\\\":\\\"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\\\"}",
          "ResourceGroupId": "rg-acfmy*****"
        }
      ],
      "Service": "mysql"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 云数据库 RDS 相关技术圈