调用DescribeDBInstanceHAConfig接口查询RDS实例高可用模式和数据复制方式。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBInstanceHAConfig

系统规定参数,取值:DescribeDBInstanceHAConfig

DBInstanceId String rm-uf6wjk5xxxxxx

实例ID。

返回数据

名称 类型 示例值 描述
DBInstanceId String rm-uf6wjk5xxxxxx

实例ID。

HAMode String RPO

高可用模式,取值:

  • RPO:数据一致性优先,实例会尽可能保障数据的可靠性,即数据丢失量最少。对于数据一致性要求比较高的用户应该使用RPO模式。
  • RTO:实例可用性优先,实例会尽快恢复服务,即可用时间最长。对于数据库在线时间要求比较高的用户应该使用RTO模式。
说明 仅MySQL实例返回此参数。
SyncMode String Sync

数据复制方式,取值:

  • Sync:强同步
  • Semi-sync:半同步
  • Async:异步
说明 仅MySQL实例返回此参数。
HostInstanceInfos Array of NodeInfo

主备实例信息列表。

NodeInfo
NodeId String 3397027

实例的唯一标识。

NodeType String Master

节点类型,取值:

  • Master:主节点
  • Slave:备节点
RegionId String cn-hangzhou

地域ID。

ZoneId String cn-hangzhou-b

可用区ID。

SyncStatus String NotAvailable

同步状态,取值:

  • NotAvailable:不可用,即发生故障。
  • Syncing:同步中,切换可能会发生数据丢失。
  • Synchronized:完成同步。
  • NotSupport:引擎类型或者版本不涉及主备同步。
LogSyncTime String 2018-05-05T15:15:00Z

备实例收到主实例日志的时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

DataSyncTime String 2018-05-05T15:15:00Z

备实例执行日志完成数据同步的时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceHAConfig
&DBInstanceId=rm-uf6wjk5xxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDBInstanceHAConfigResponse>
  <RequestId>103D4ACC-F2F9-4A7E-9ACC-14B0A25613E0</RequestId>
  <DBInstanceId>rm-uf6wjk5xxxxxx</DBInstanceId>
  <HAMode>RPO</HAMode>
  <HostInstanceInfos>
        <NodeInfo>
              <DataSyncTime></DataSyncTime>
              <ZoneId>cn-hangzhou-h</ZoneId>
              <LogSyncTime></LogSyncTime>
              <NodeType>Slave</NodeType>
              <NodeId>13567431</NodeId>
              <SyncStatus>NotSupport</SyncStatus>
              <RegionId>cn-hangzhou</RegionId>
        </NodeInfo>
        <NodeInfo>
              <DataSyncTime></DataSyncTime>
              <ZoneId>cn-hangzhou-h</ZoneId>
              <LogSyncTime></LogSyncTime>
              <NodeType>Master</NodeType>
              <NodeId>14565107</NodeId>
              <SyncStatus>NotSupport</SyncStatus>
              <RegionId>cn-hangzhou</RegionId>
        </NodeInfo>
  </HostInstanceInfos>
  <SyncMode>Semi-sync</SyncMode>
</DescribeDBInstanceHAConfigResponse>

JSON 格式

{
	"RequestId": "103D4ACC-F2F9-4A7E-9ACC-14B0A25613E0",
	"DBInstanceId": "rm-uf6wjk5xxxxxx",
	"HAMode": "RPO",
	"HostInstanceInfos": {
		"NodeInfo": [
			{
				"DataSyncTime": "",
				"ZoneId": "cn-hangzhou-h",
				"LogSyncTime": "",
				"NodeType": "Slave",
				"NodeId": "13567431",
				"SyncStatus": "NotSupport",
				"RegionId": "cn-hangzhou"
			},
			{
				"DataSyncTime": "",
				"ZoneId": "cn-hangzhou-h",
				"LogSyncTime": "",
				"NodeType": "Master",
				"NodeId": "14565107",
				"SyncStatus": "NotSupport",
				"RegionId": "cn-hangzhou"
			}
		]
	},
	"SyncMode": "Semi-sync"
}

错误码

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