该接口用于查询RDS MySQL全球多活数据库集群列表或目标集群的详细信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeGadInstances | List |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GadInstanceName | string | 否 | RDS全球多活数据库集群ID。
说明
您可在第一次调用时不传入此参数获取当前账号下的所有集群ID，再通过传入集群ID查看该集群的详情。
| gad-rm-bp1npi2j8**** |
| RegionId | string | 否 | 地域ID，可调用DescribeRegions查询。 | cn-hangzhou |
| ResourceGroupId | string | 否 | 资源组ID。 | rg-acfmy**** |
返回参数
示例
正常返回示例
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"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史
