DescribeDBInstanceHAConfig - 查询RDS实例高可用模式和数据复制方式

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeDBInstanceHAConfig	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例ID。	rm-uf6wjk5xxxxxx

返回参数

名称	类型	描述	示例值
	object
DBInstanceId	string	实例ID。	rm-uf6wjk5xxxxxx
RequestId	string	请求ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
HAMode	string	高可用模式，取值： RPO：数据一致性优先，实例会尽可能保障数据的可靠性，即数据丢失量最少。对于数据一致性要求比较高的用户应该使用RPO模式。 RTO：实例可用性优先，实例会尽快恢复服务，即可用时间最长。对于数据库在线时间要求比较高的用户应该使用RTO模式。说明仅MySQL实例返回此参数。	RPO
SyncMode	string	数据复制方式，取值： Sync：强同步 Semi-sync：半同步 Async：异步说明仅MySQL实例返回此参数。	Sync
HostInstanceInfos	array	主备实例信息列表。
	object
LogSyncTime	string	备实例收到主实例日志的时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2018-05-05T15:15:00Z
NodeType	string	节点类型，取值： Master：主节点 Slave：备节点	Master
ZoneId	string	可用区ID。	cn-hangzhou-b
SyncStatus	string	同步状态，取值： NotAvailable：不可用，即发生故障。 Syncing：同步中，切换可能会发生数据丢失。 Synchronized：完成同步。 NotSupport：引擎类型或者版本不涉及主备同步。	NotAvailable
DataSyncTime	string	备实例执行日志完成数据同步的时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。	2018-05-05T15:15:00Z
NodeId	string	实例的唯一标识。	3397027
RegionId	string	地域ID。	cn-hangzhou

示例

正常返回示例

JSON格式

{
  "DBInstanceId": "rm-uf6wjk5xxxxxx",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "HAMode": "RPO",
  "SyncMode": "Sync",
  "HostInstanceInfos": {
    "NodeInfo": [
      {
        "LogSyncTime": "2018-05-05T15:15:00Z",
        "NodeType": "Master",
        "ZoneId": "cn-hangzhou-b",
        "SyncStatus": "NotAvailable",
        "DataSyncTime": "2018-05-05T15:15:00Z",
        "NodeId": "3397027",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2022-06-23

OpenAPI 描述信息更新

变更项	变更内容
API 描述	OpenAPI 描述信息更新