AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

DescribeDBLogFiles - 查看实例HA切换记录

更新时间：
复制为 MD 格式
产品详情
我的收藏

查询PolarDB集群日志信息，如主备切换日志。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeDBLogFiles

list

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

 无 无

请求参数

名称

类型

必填

描述

示例值
DBClusterId

string

是

集群 ID。

pc-*************
DBNodeId

string

否

PolarDB 集群中节点的 ID。

pi-*************
PageNumber

integer

否

页码，取值范围为大于 0 且不超过 Integer 的最大值的整数，默认值为 1。

1
PageSize

integer

否

每页记录数，取值：5 ~ 50。默认值：10。

10
StartTime

string

否

查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2023-08-20T16:00:00Z
EndTime

string

否

查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2023-09-20T16:00:00Z
LogType

string

是

日志类型，可选值：

  • HaSwitchLogList：主备切换日志列表

  • HaSwitchLogInfo：主备切换日志详情

  • SimulateSwitchLogs：演练日志切换日志

枚举值：

  • HaSwitchLogInfo :

    HaSwitchLogInfo

  • SimulateSwitchLogs :

    SimulateSwitchLogs

  • HaSwitchLogList :

    HaSwitchLogList

HaSwitchLogList
DescribeSimulateSwitchMode

string

否

演练记录的模式，可选值：

  • 0：查询逻辑实例上的演练记录，可指定演练 ID 查询

  • 1：根据 ListId 查看物理实例的演练记录

  • 2：查看最近一次进行中的演练记录

0
SimulateListId

string

否

逻辑实例演练记录 ID

"95"
SimulateStatusList

string

否

演练状态列表：

  • 0：等待调度

  • 1：成功

  • 2：进行中

  • 3：失败

  • 4：中断

  • 5：等待回切

  • 6：取消

"0,1,2,3,4,5"
SimulateModeList

string

否

演练模式列表，可选值：

  • "0"：故障注入到主可用区

  • "1"：故障注入到 DB 实例

  • "2"：故障注入到容灾机房

0,1,2

返回参数

名称

类型

描述

示例值

object

TotalRecords

integer

总记录数。

1
ItemsNumbers

integer

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

1
PageNumber

integer

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

1
DBInstanceName

string

逻辑实例名称。

pc-****************
DBInstanceType

string

实例类型，取值说明：

  • polardb_mysql_rw：读写实例。

  • polardb_mysql_ro：只读实例。

  • polardb_mysql_standby：standby 实例。

polardb_mysql_rw
HaStatus

integer

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

  • 1：不存在

  • 0：存在

枚举值：

  • 0 :

    0

  • 1 :

    1

1
HaLogItems

array<object>

主备切换日志列表。

object

主备切换日志。

SwitchId

string

主备切换日志 ID。

e571f897-9b3c-4012-9470-88333832dec4
FromDBType

string

切换前实例类型，取值说明：

  • polardb_mysql_rw：读写实例。

  • polardb_mysql_ro：只读实例。

  • polardb_mysql_standby：standby 实例。

polardb_mysql_rw
SwitchCauseCode

string

切换原因错误码。

Platform.Ha.AuroraService.ManualOperations
SwitchCauseDetail

string

切换原因详情。

Platform.Ha.ManuallyTriggered
SwitchStartTime

string

切换开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-05-20T03:09:45Z
SwitchFinishTime

string

切换结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-05-20T03:09:56Z
TotalSessions

integer

切换时总会话数。

10000
AffectedSessions

integer

切换时影响会话数。

100
SwitchType

integer

切换类型。

0
RequestId

string

请求 ID。

24A1990B-4F6E-482B-B8CB-75C612******
PageSize

integer

每页记录数，取值：5~50。默认值：10。

10
SwitchListItems

array<object>

故障演练记录列表。

array<object>

演练记录。

SimulateListId

string

逻辑实例演练记录 ID。

23
SimulateMode

string

演练模式。

0
SimulateStatus

string

演练状态。

  • 0：等待调度

  • 1：成功

  • 2：进行中

  • 3：失败

  • 4：中断

  • 5：等待回切

2
StartTime

string

切换开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-02-25T01:05:00Z
EndTime

string

切换结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-02-10T02:25:00Z
EventStartTime

string

系统事件开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-04-19T01:12:00Z
EventFinishTime

string

系统事件结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-04-19T02:12:00Z
SimulateTaskId

string

演练任务 ID

23
DBNodeCrashList

array

演练节点实例名列表。

说明

节点维度的演练只支持单个节点，可用区维度的演练可不传该参数，或传入所有节点。

string

演练节点实例。

pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t
SwitchLogItems

array<object>

故障演练日志列表。

array<object>

故障演练日志。

SimulateListId

string

演练列表 ID。

96
SimulateLogId

string

演练日志 ID。

23
DBInstanceId

string

集群 ID。

说明

您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息（如集群 ID）。

pc-*************
SrcDbType

string

源数据库类型。取值如下：

  • PolarDBMySQL：PolarDB 大版本升级迁移时的源数据库类型。

  • RDS：将数据从 RDS 迁移至 PolarDB MySQL 时的源数据类型。

PolarDBMySQL
DstDbType

string

目标数据库类型。取值如下：

  • PolarDBMySQL：PolarDB 大版本升级迁移时的源数据库类型。

  • RDS：将数据从 RDS 迁移至 PolarDB MySQL 时的源数据类型。

PolarDBMySQL
SimulateStatus

string

演练状态。

  • 0：等待调度

  • 1：成功

  • 2：进行成

  • 3：失败

  • 4：中断

  • 5：等待回切

1
EventStartTime

string

系统事件开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-04-19T01:12:00Z
EventFinishTime

string

系统事件结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-04-19T02:12:00Z

SwitchStepItems

array<object>

故障演练步骤列表。

object

故障演练步骤。

StepName

string

当前执行的步骤名。您可以通过 DescribeHistoryTasks 查询指定任务 ID 当前的执行步骤。常见取值do_pause表示等待预设时间执行。

init_task_info
StartTime

string

查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-04-19T02:12:00Z
SimulatePhase

string

演练阶段。

  • PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION：故障注入

  • PolarDB.MySQL.FaultSimulate.Phase.RECOVERY：恢复阶段

  • PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS：后处理阶段

PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
EndTime

string

查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-08-14T02:07:00Z
TimeCost

string

请求处理的耗时，单位毫秒（ms）。

1000
IsSuccess

string

是否调用 API 成功，取值：

  • true：调用 API 成功

  • false：调用 API 失败

true
SwitchStepItems

array<object>

切换步骤列表。

object

SimulatePhase

string

演练阶段。

  • PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION：故障注入

  • PolarDB.MySQL.FaultSimulate.Phase.RECOVERY：恢复阶段

  • PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS：后处理阶段

PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
StepName

string

当前执行的步骤名。您可以通过 DescribeHistoryTasks 查询指定任务 ID 当前的执行步骤。常见取值do_pause表示等待预设时间执行。

init_task_info
StartTime

string

步骤开始时间。格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-07-16T02:12:00Z
EndTime

string

步骤结束时间。格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-07-23T02:30:00Z
TimeCost

string

请求处理的耗时，单位毫秒（ms）。

1000
IsSuccess

string

更新联系人是否成功，取值：

  • true：更新成功

  • false：更新失败

true
DBNodeId

string

数据库集群节点 ID。

说明

当请求参数中Key的值设置为PolarDBDiskUsage时，不会返回该参数。

pi-*************
FaultInjectionType

string

故障注入方式。取值范围如下：

  • 0：基于Crash SQL的实例故障注入

CrashSQLInjection
SwitchLogItems

array<object>

故障演练日志列表。

array<object>

故障演练日志。

SimulateListId

string

演练列表 ID。

231
Simulatecode

string

演练状态。

0
DBInstanceId

string

集群 ID。

说明

您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息（如集群 ID）。

pc-*************
SrcDbType

string

源数据库类型。取值如下：

  • PolarDBMySQL：PolarDB 大版本升级迁移时的源数据库类型。

  • RDS：将数据从 RDS 迁移至 PolarDB MySQL 时的源数据类型。

PolarDBMySQL
DstDbType

string

目标数据库类型。取值如下：

  • PolarDBMySQL：PolarDB 大版本升级迁移时的源数据库类型。

  • RDS：将数据从 RDS 迁移至 PolarDB MySQL 时的源数据类型。

PolarDBMySQL
SimulateStatus

string

演练状态。

  • 0：等待调度

  • 1：成功

  • 2：进行成

  • 3：失败

  • 4：中断

  • 5：等待回切

1
EventStartTime

string

系统事件开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-04-19T01:12:00Z
EventFinishTime

string

系统事件结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-04-19T02:12:00Z
SwitchStepItems

array<object>

切换步骤列表。

object

StepName

string

步骤名称。

init_task_info
StepMsg

string

步骤信息。

This step exec success

StartTime

string

步骤开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2024-10-21T02:12:00Z
EndTime

string

步骤结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2025-03-27T02:27:00Z
TimeCost

string

请求处理的耗时，单位毫秒（ms）。

1000
IsSuccess

string

调用是否成功，取值：

  • true：调用成功

  • false：调用失败

true
SimulatePhase

string

演练阶段。

  • PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION：故障注入

  • PolarDB.MySQL.FaultSimulate.Phase.RECOVERY：恢复阶段

  • PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS：后处理阶段

PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
DBNodeId

string

节点 ID。

说明

DBNodeId和DBClusterId必选其一填入。您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括节点 ID。

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

示例

正常返回示例

JSON格式

{
  "TotalRecords": 1,
  "ItemsNumbers": 1,
  "PageNumber": 1,
  "DBInstanceName": "pc-****************",
  "DBInstanceType": "polardb_mysql_rw",
  "HaStatus": 1,
  "HaLogItems": [
    {
      "SwitchId": "e571f897-9b3c-4012-9470-88333832dec4",
      "FromDBType": "polardb_mysql_rw",
      "SwitchCauseCode": "Platform.Ha.AuroraService.ManualOperations",
      "SwitchCauseDetail": "Platform.Ha.ManuallyTriggered",
      "SwitchStartTime": "2025-05-20T03:09:45Z",
      "SwitchFinishTime": "2025-05-20T03:09:56Z",
      "TotalSessions": 10000,
      "AffectedSessions": 100,
      "SwitchType": 0
    }
  ],
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "PageSize": 10,
  "SwitchListItems": [
    {
      "SimulateListId": "23",
      "SimulateMode": "0",
      "SimulateStatus": "2",
      "StartTime": "2025-02-25T01:05:00Z",
      "EndTime": "2025-02-10T02:25:00Z",
      "EventStartTime": "2025-04-19T01:12:00Z",
      "EventFinishTime": "2025-04-19T02:12:00Z",
      "SimulateTaskId": "23",
      "DBNodeCrashList": [
        "pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t"
      ],
      "SwitchLogItems": [
        {
          "SimulateListId": "96",
          "SimulateLogId": "23",
          "DBInstanceId": "pc-*************",
          "SrcDbType": "PolarDBMySQL",
          "DstDbType": "PolarDBMySQL",
          "SimulateStatus": "1",
          "EventStartTime": "2025-04-19T01:12:00Z",
          "EventFinishTime": "2025-04-19T02:12:00Z\n",
          "SwitchStepItems": [
            {
              "StepName": "init_task_info",
              "StartTime": "2025-04-19T02:12:00Z",
              "SimulatePhase": "PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION",
              "EndTime": "2025-08-14T02:07:00Z",
              "TimeCost": "1000",
              "IsSuccess": "true"
            }
          ]
        }
      ],
      "SwitchStepItems": [
        {
          "SimulatePhase": "PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION",
          "StepName": "init_task_info",
          "StartTime": "2025-07-16T02:12:00Z",
          "EndTime": "2025-07-23T02:30:00Z",
          "TimeCost": "1000",
          "IsSuccess": "true",
          "DBNodeId": "pi-*************"
        }
      ],
      "FaultInjectionType": "CrashSQLInjection"
    }
  ],
  "SwitchLogItems": [
    {
      "SimulateListId": "231",
      "Simulatecode": "0",
      "DBInstanceId": "pc-*************",
      "SrcDbType": "PolarDBMySQL",
      "DstDbType": "PolarDBMySQL",
      "SimulateStatus": "1",
      "EventStartTime": "2025-04-19T01:12:00Z",
      "EventFinishTime": "2025-04-19T02:12:00Z",
      "SwitchStepItems": [
        {
          "StepName": "init_task_info",
          "StepMsg": "This step exec success ",
          "StartTime": "2024-10-21T02:12:00Z",
          "EndTime": "2025-03-27T02:27:00Z",
          "TimeCost": "1000",
          "IsSuccess": "true",
          "SimulatePhase": "PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION",
          "DBNodeId": "pi-*************"
        }
      ]
    }
  ]
}

错误码

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。

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

变更历史

更多信息，参考变更详情。

上一篇：ModifyDBClusterArch - 修改集群的高可用模式下一篇：DescribeHALogs - 查询实例高可用日志