DescribeHALogs - 查询实例高可用日志

查询实例高可用相关日志。

接口说明

说明
  • 仅 PolarDB MySQL 版支持该接口。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeHALogs

get

*全部资源

*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

DBClusterId

string

集群 ID。

pc-****************

DBNodeId

string

节点 ID。

说明

查询DBNodeId的 HA 切换记录。您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息,包括节点 ID。

pi-****************

PageNumber

integer

页码。

1

PageSize

integer

每页记录数,取值:5~50。默认值:10。

30

StartTime

string

查询开始日期。格式为YYYY-MM-DDThh:mm:ssZ(UTC 时间)。

2025-05-01T00:00:00Z

EndTime

string

查询结束时间,需晚于查询开始时间。格式为YYYY-MM-DDThh:mm:ssZ(UTC 时间)。

2025-05-23T01:01:00Z

LogType

string

日志类型

HaSwitchLogList

返回参数

名称

类型

描述

示例值

object

Schema of Response

TotalRecords

integer

总记录数。

160

ItemsNumbers

integer

当前页查询日志列表内的 Item 数量。

10

PageNumber

integer

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

1

DBInstanceName

string

实例 ID。

pc-a*************

DBInstanceType

string

实例类型,取值说明:

  • polardb_mysql_rw:读写实例。

  • polardb_mysql_ro:只读实例。

  • polardb_mysql_standby:standby 实例。

polardb_mysql_rw

HaStatus

integer

主备切换记录是否存在。取值说明

  • 1:不存在

  • 0:存在

1

HaLogItems

array<object>

主备切换日志列表

object

主备切换日志列表

SwitchId

string

主备切换日志 ID

e571f897-9b3c-4012-9470-88333832dec4

SwitchCauseCode

string

切换原因码。

Platform.Ha.AuroraService.ManualOperations

SwitchCauseDetail

string

切换原因。

Platform.Ha.ManuallyTriggered

SwitchStartTime

string

切换开始时间。

2025-05-20T03:09:45Z

SwitchFinishTime

string

切换结束时间。

2025-05-20T03:09:56Z

RequestId

string

请求 ID。

6BD9CDE4-5E7B-4BF3-9BB8-83C73E******

PageSize

integer

每页记录数,取值:30~100。默认值:30。

30

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
400 InvalidPageSize.Malformed The specified parameter PageSize is not valid. 指定的参数PageSize无效
400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid. 指定的参数PageNumber无效
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

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

变更历史

更多信息,参考变更详情