调用DescribeGadInstances接口查询RDS全球多活数据库集群列表或目标集群的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeGadInstances |
系统规定参数。取值:DescribeGadInstances。 |
GadInstanceName | String | 否 | gad-rm-bp1npi2j8******** |
RDS全球多活数据库集群ID。
|
RegionId | String | 否 | cn-hangzhou |
地域ID,可调用DescribeRegions查询。 |
ResourceGroupId | String | 否 | rg-acfmy***** |
资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 76AF0609-4195-5DFC-BC78-3AD76FF872BB |
请求ID。 |
GadInstances | Array of GadInstances |
由RDS全球多活数据库集群信息组成的数组。 |
|
GadInstanceName | String | gad-rm-bp1npi2j8******** |
RDS全球多活数据库集群的ID。 |
Description | String | GadTest |
集群名称。 |
Status | String | activation |
集群状态。取值:
|
CreationTime | String | 2021-10-21T02:57:08Z |
集群的创建时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
ModificationTime | String | 2021-10-21T03:01:20Z |
最后一次变更集群的时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
GadInstanceMembers | Array of GadInstanceMembers |
由集群中各节点信息组成的数组。 |
|
DBInstanceID | String | rm-bp1npi2j8******** |
集群中节点的ID。 |
Engine | String | mysql |
集群中节点的数据库引擎。 |
EngineVersion | String | 8.0 |
集群中节点的数据库版本。 |
RegionId | String | cn-hangzhou |
集群中节点所在的地域ID。 |
Role | String | CENTRAL |
RDS全球多活数据库集群中的节点类型。返回值:
|
Status | String | activation |
节点状态。取值:
|
DtsInstance | String | {\”dtsInstanceId\”:\”dtsm9t107c********\”,\”dtsRequestId\”:\”190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\”} |
包含DTS同步信息的JSON数组。 |
ResourceGroupId | String | rg-acfmy***** |
资源组ID。 |
Service | String | mysql |
RDS全球多活数据库集群的引擎。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeGadInstances
&GadInstanceName=gad-rm-bp1npi2j8********
&
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
76AF0609-4195-5DFC-BC78-3AD76FF872BB
activation
测试gad
gad-rm-bp1npi2j8********
2021-10-21T02:57:08Z
mysql
2021-10-21T03:01:20Z
CENTRAL
activation
8.0
rm-bp1npi2j8********
cn-hangzhou
mysql
UNIT
activation
8.0
rm-bp10iyemc********
cn-hangzhou
{"dtsInstanceId":"dtsoai1091********","dtsRequestId":"8E762933-4945-5FD0-B73E-B34DE97711D7"}
mysql
UNIT
activation
8.0
rm-bp12srz4r********
cn-hangzhou
{"dtsInstanceId":"dtsqu710mn********","dtsRequestId":"38500624-625E-503F-B3F7-D958BD092814"}
mysql
UNIT
activation
8.0
rm-bp13f617l********
cn-hangzhou
{"dtsInstanceId":"dtsm9t107c********","dtsRequestId":"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C"}
mysql
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "76AF0609-4195-5DFC-BC78-3AD76FF872BB",
"GadInstances" : [ {
"Status" : "activation",
"Description" : "测试gad",
"GadInstanceName" : "gad-rm-bp1npi2j8********",
"CreationTime" : "2021-10-21T02:57:08Z",
"Service" : "mysql",
"ModificationTime" : "2021-10-21T03:01:20Z",
"GadInstanceMembers" : [ {
"Role" : "CENTRAL",
"Status" : "activation",
"EngineVersion" : "8.0",
"DBInstanceID" : "rm-bp1npi2j8********",
"RegionId" : "cn-hangzhou",
"Engine" : "mysql"
}, {
"Role" : "UNIT",
"Status" : "activation",
"EngineVersion" : "8.0",
"DBInstanceID" : "rm-bp10iyemc********",
"RegionId" : "cn-hangzhou",
"DtsInstance" : "{\"dtsInstanceId\":\"dtsoai1091********\",\"dtsRequestId\":\"8E762933-4945-5FD0-B73E-B34DE97711D7\"}",
"Engine" : "mysql"
}, {
"Role" : "UNIT",
"Status" : "activation",
"EngineVersion" : "8.0",
"DBInstanceID" : "rm-bp12srz4r********",
"RegionId" : "cn-hangzhou",
"DtsInstance" : "{\"dtsInstanceId\":\"dtsqu710mn********\",\"dtsRequestId\":\"38500624-625E-503F-B3F7-D958BD092814\"}",
"Engine" : "mysql"
}, {
"Role" : "UNIT",
"Status" : "activation",
"EngineVersion" : "8.0",
"DBInstanceID" : "rm-bp13f617l********",
"RegionId" : "cn-hangzhou",
"DtsInstance" : "{\"dtsInstanceId\":\"dtsm9t107c********\",\"dtsRequestId\":\"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\"}",
"Engine" : "mysql"
} ]
} ]
}
错误码
访问错误中心查看更多错误码。
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/154230.html