文档

DescribeDBInstanceSwitchLog - 查询实例的主备切换日志信息

更新时间:

查询实例的主备切换日志。

接口说明

调用本接口时,实例必须满足以下条件:

  • 实例的类型为副本集实例或分片集群实例。

  • 实例的规格类型为本地物理盘。

调试

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

授权信息

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

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

请求参数

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

查询开始时间,格式为yyyy-mm-ddThh:mmZ(UTC 时间)。

2023-05-27T02:46Z
EndTimestring

查询结束时间,必须晚于查询开始时间,格式为yyyy-mm-ddThh:mmZ(UTC 时间)。

2023-05-28T02:00Z
PageNumberinteger

页码,取值为大于 0 且不超过 integer 数据类型的最大值,默认值为 1

1
PageSizeinteger

每页记录数,取值:30、50、100,默认值为 30

30
DBInstanceIdstring

实例 ID。

dds-uf68f1b5a57exxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

ECBCA991-XXXX-XXXX-834C-B3E8007F33AA
DBInstanceIdstring

实例 ID。

dds-uf68f1b5a57exxxx
TotalCountlong

查询结果中主备切换记录的数量。

1
PageSizelong

每页记录数。

30
PageNumberlong

当前页码。

1
LogItemsobject []

主备切换日志列表。

SwitchStatusstring

切换状态。 返回值为:

  • 1:切换成功。
  • 0:切换失败。
1
SwitchTimestring

切换时间,格式为yyyy-mm-ddThh:mm:ssZ(UTC 时间)。

2023-02-07T18:00:00Z
SwitchCodestring

切换原因代码:

  • USER_CONSOLE_OPERATION:人工操作
  • OPERATION_AND_MAINTENANCE:风险隐患
  • MACHINE_DOWNTIME:宿主机下线
  • PRIMARY_UNHEALTHY:实例异常
  • SECONDARY_UNHEALTHY:实例异常
  • MULTIPLE_NODE_FAILURES:实例异常
USER_CONSOLE_OPERATION
NodeIdstring

当实例为副本集实例,展示实例 ID;当实例为分片集实例,展示切换的节点 ID。

当实例为副本集实例:dds-uf68f1b5a57exxxx。 当实例为分片集实例:d-uf652b73f554xxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "ECBCA991-XXXX-XXXX-834C-B3E8007F33AA",
  "DBInstanceId": "dds-uf68f1b5a57exxxx",
  "TotalCount": 1,
  "PageSize": 30,
  "PageNumber": 1,
  "LogItems": [
    {
      "SwitchStatus": "1",
      "SwitchTime": "2023-02-07T18:00:00Z",
      "SwitchCode": "USER_CONSOLE_OPERATION",
      "NodeId": "当实例为副本集实例:dds-uf68f1b5a57exxxx。\n当实例为分片集实例:d-uf652b73f554xxxx"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterCombinationThe end time must be greater than the start time开始时间不能大于结束时间。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈