DescribeDBLogFiles - PolarDB - Centro de documentación de Alibaba Cloud

Consulta los registros de un clúster de PolarDB, como los registros de conmutación por error entre nodos primario y secundario.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribeDBLogFiles

list

*DBCluster

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBClusterId	string	Sí	El ID del clúster.	pc-*************
DBNodeId	string	No	El ID del nodo en el clúster de PolarDB.	pi-*************
PageNumber	integer	No	El número de página. El valor debe ser un número entero mayor que 0. El valor predeterminado es 1.	1
PageSize	integer	No	El tamaño de la página. Valores válidos: de 5 a 50. El valor predeterminado es 10.	10
StartTime	string	No	El inicio del intervalo de tiempo a consultar. La hora debe estar en formato UTC y tener el formato `yyyy-MM-ddTHH:mm:ssZ`.	2023-08-20T16:00:00Z
EndTime	string	No	El fin del intervalo de tiempo a consultar. La hora debe estar en formato UTC y tener el formato `yyyy-MM-ddTHH:mm:ssZ`.	2023-09-20T16:00:00Z
LogType	string	Sí	El tipo de registro. Valores válidos: HaSwitchLogList: Una lista de registros de conmutación por error. HaSwitchLogInfo: Detalles de un registro de conmutación por error. SimulateSwitchLogs: Registros de simulación de conmutación por error. Valores válidos: HaSwitchLogList : HaSwitchLogList.	HaSwitchLogList
DescribeSimulateSwitchMode	string	No	El modo para consultar los registros de simulación. Valores válidos: 0: Consulta los registros de simulación de una instancia lógica. Puede especificar el ID de la simulación. 1: Consulta los registros de simulación de una instancia física según un `SimulateListId` especificado. 2: Consulta los registros de la simulación más reciente en curso.	0
SimulateListId	string	No	El ID de un registro de simulación de instancia lógica.	"95"
SimulateStatusList	string	No	Filtra los resultados por uno o más estados de simulación. Especifique varios estados como una cadena separada por comas. Valores válidos: 0: En espera de programación 1: Correcto 2: En ejecución 3: Fallido 4: Interrumpido 5: En espera de reversión 6: Cancelado	"0,1,2,3,4,5"
SimulateModeList	string	No	Filtra los resultados por uno o más modos de simulación. Especifique varios modos como una cadena separada por comas. Valores válidos: 0: Se inyecta una falla en la zona de disponibilidad primaria. 1: Se inyecta una falla en la instancia de base de datos. 2: Se inyecta una falla en el centro de datos de recuperación ante desastres.	0,1,2

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
TotalRecords	integer	El número total de registros.	1
ItemsNumbers	integer	El número de elementos de registro en la página actual.	1
PageNumber	integer	El número de página. Debe ser un entero positivo que no exceda el valor máximo del tipo de datos Integer. Valor predeterminado: 1.	1
DBInstanceName	string	El ID del clúster.	pc-****************
DBInstanceType	string	El tipo de instancia. Valores válidos: polardb_mysql_rw: instancia de lectura y escritura. polardb_mysql_ro: instancia de solo lectura. polardb_mysql_standby: instancia en espera.	polardb_mysql_rw
HaStatus	integer	Indica si existe un registro de conmutación por error. Valores válidos: 1: No 0: Sí Valores válidos: 0 : 0 1 : 1	1
HaLogItems	array<object>	Una lista de registros de conmutación por error.
	object	El registro de conmutación por error.
SwitchId	string	El ID del registro de conmutación por error.	e571f897-9b3c-4012-9470-88333832dec4
FromDBType	string	El tipo de instancia antes de la conmutación por error. Valores válidos: polardb_mysql_rw: instancia de lectura y escritura. polardb_mysql_ro: instancia de solo lectura. polardb_mysql_standby: instancia en espera.	polardb_mysql_rw
SwitchCauseCode	string	El código de error de la causa de la conmutación por error.	Platform.Ha.AuroraService.ManualOperations
SwitchCauseDetail	string	Detalles sobre la causa de la conmutación por error.	Platform.Ha.ManuallyTriggered
SwitchStartTime	string	La hora en que inició la conmutación por error. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-05-20T03:09:45Z
SwitchFinishTime	string	La hora en que se completó la conmutación por error. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-05-20T03:09:56Z
TotalSessions	integer	El número total de sesiones durante la conmutación por error.	10000
AffectedSessions	integer	El número de sesiones afectadas durante la conmutación por error.	100
SwitchType	integer	El tipo de conmutación por error.	0
RequestId	string	El ID de la solicitud.	24A1990B-4F6E-482B-B8CB-75C612******
PageSize	integer	El número de entradas a devolver en cada página. Valores válidos: de 5 a 50. Valor predeterminado: 10.	10
SwitchListItems	array<object>	Una lista de registros de simulación de fallas.
	array<object>	El registro de simulación de fallas.
SimulateListId	string	El ID del registro de simulación de fallas.	23
SimulateMode	string	El modo de simulación de fallas.	0
SimulateStatus	string	El estado de la simulación de fallas. Valores válidos: 0: Pendiente 1: Éxito 2: En ejecución 3: Fallido 4: Abortado 5: Esperando reversión	2
StartTime	string	La hora en que inició la simulación de fallas. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-02-25T01:05:00Z
EndTime	string	La hora en que se completó la simulación de fallas. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-02-10T02:25:00Z
EventStartTime	string	La hora en que inició el evento del sistema. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-04-19T01:12:00Z
EventFinishTime	string	La hora en que se completó el evento del sistema. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-04-19T02:12:00Z
SimulateTaskId	string	El ID de la tarea de simulación de fallas.	23
DBNodeCrashList	array	Los ID de los nodos en los que se simulará una falla. Nota Para una simulación de fallas a nivel de nodo, especifique el ID de un solo nodo. Para una simulación de fallas a nivel de zona de disponibilidad, puede omitir este parámetro o especificar los ID de todos los nodos en la zona.
	string	El ID del nodo.	pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t
SwitchLogItems	array<object>	Una lista de registros de simulación de fallas.
	array<object>	El registro de simulación de fallas.
SimulateListId	string	El ID de la lista de simulación.	96
SimulateLogId	string	El ID del registro de simulación.	23
DBInstanceId	string	El ID del clúster. Nota Puede llamar a la operación DescribeDBClusters para consultar los detalles de sus clústeres, incluidos los ID de los clústeres.	pc-*************
SrcDbType	string	El tipo de base de datos de origen. Valores válidos: PolarDBMySQL: Una actualización de versión principal de PolarDB for MySQL. RDS: Una migración de RDS a PolarDB for MySQL.	PolarDBMySQL
DstDbType	string	El tipo de base de datos de destino. Valores válidos: PolarDBMySQL: Una actualización de versión principal de PolarDB for MySQL. RDS: Una migración de RDS a PolarDB for MySQL.	PolarDBMySQL
SimulateStatus	string	El estado de la simulación de fallas. Valores válidos: 0: Pendiente 1: Éxito 2: En ejecución 3: Fallido 4: Abortado 5: Esperando reversión	1
EventStartTime	string	La hora en que inició el evento del sistema. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-04-19T01:12:00Z
EventFinishTime	string	La hora en que se completó el evento del sistema. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-04-19T02:12:00Z
SwitchStepItems	array<object>	Una lista de pasos de simulación de fallas.
	object	El paso de simulación de fallas.
StepName	string	El nombre del paso actual. Puede llamar a la operación DescribeHistoryTasks para consultar el paso actual de una tarea especificada. Un valor común es do_pause, que indica que el sistema espera durante un período de tiempo determinado.	init_task_info
StartTime	string	La hora en que inició el paso. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-04-19T02:12:00Z
SimulatePhase	string	La fase de simulación de fallas. Valores válidos: PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION: La fase de inyección de fallas. PolarDB.MySQL.FaultSimulate.Phase.RECOVERY: La fase de recuperación. PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS: La fase de posprocesamiento.	PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
EndTime	string	La hora en que se completó el paso. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-08-14T02:07:00Z
TimeCost	string	La duración del paso en milisegundos.	1000
IsSuccess	string	Indica si el paso fue exitoso. Valores válidos: `true`: El paso fue exitoso. `false`: El paso falló.	true
SwitchStepItems	array<object>	Una lista de pasos de conmutación por error.
	object
SimulatePhase	string	La fase de simulación de fallas. Valores válidos: PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION: La fase de inyección de fallas. PolarDB.MySQL.FaultSimulate.Phase.RECOVERY: La fase de recuperación. PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS: La fase de posprocesamiento.	PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
StepName	string	El nombre del paso actual. Puede llamar a la operación DescribeHistoryTasks para consultar el paso actual de una tarea especificada. Un valor común es do_pause, que indica que el sistema espera durante un período de tiempo determinado.	init_task_info
StartTime	string	La hora en que inició el paso. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-07-16T02:12:00Z
EndTime	string	La hora en que se completó el paso. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-07-23T02:30:00Z
TimeCost	string	La duración del paso en milisegundos.	1000
IsSuccess	string	Indica si el paso fue exitoso. Valores válidos: `true`: El paso fue exitoso. `false`: El paso falló.	true
DBNodeId	string	El ID del nodo del clúster. Nota Este parámetro se devuelve solo cuando el parámetro `Key` en la solicitud no está establecido en `PolarDBDiskUsage`.	pi-*************
FaultInjectionType	string	El método de inyección de fallas. Valores válidos: CrashSQLInjection: Inyecta una falla en la instancia mediante `Crash SQL`.	CrashSQLInjection
SwitchLogItems	array<object>	Una lista de registros de simulación de fallas.
	array<object>	El registro de simulación de fallas.
SimulateListId	string	El ID de la lista de simulación.	231
Simulatecode	string	El código de estado de la simulación de fallas.	0
DBInstanceId	string	El ID del clúster. Nota Puede llamar a la operación DescribeDBClusters para consultar los detalles de sus clústeres, incluidos los ID de los clústeres.	pc-*************
SrcDbType	string	El tipo de base de datos de origen. Valores válidos: PolarDBMySQL: Una actualización de versión principal de PolarDB for MySQL. RDS: Una migración de RDS a PolarDB for MySQL.	PolarDBMySQL
DstDbType	string	El tipo de base de datos de destino. Valores válidos: PolarDBMySQL: Una actualización de versión principal de PolarDB for MySQL. RDS: Una migración de RDS a PolarDB for MySQL.	PolarDBMySQL
SimulateStatus	string	El estado de la simulación de fallas. Valores válidos: 0: Pendiente 1: Éxito 2: En ejecución 3: Fallido 4: Abortado 5: Esperando reversión	1
EventStartTime	string	La hora en que inició el evento del sistema. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-04-19T01:12:00Z
EventFinishTime	string	La hora en que se completó el evento del sistema. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-04-19T02:12:00Z
SwitchStepItems	array<object>	Una lista de pasos de conmutación por error.
	object
StepName	string	El nombre del paso.	init_task_info
StepMsg	string	Un mensaje sobre el estado de ejecución del paso.	Este paso se ejecutó correctamente
StartTime	string	La hora en que inició el paso. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2024-10-21T02:12:00Z
EndTime	string	La hora en que se completó el paso. La hora tiene el formato `yyyy-MM-ddTHH:mm:ssZ` y se muestra en UTC.	2025-03-27T02:27:00Z
TimeCost	string	La duración del paso en milisegundos.	1000
IsSuccess	string	Indica si el paso fue exitoso. Valores válidos: `true`: El paso fue exitoso. `false`: El paso falló.	true
SimulatePhase	string	La fase de simulación de fallas. Valores válidos: PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION: La fase de inyección de fallas. PolarDB.MySQL.FaultSimulate.Phase.RECOVERY: La fase de recuperación. PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS: La fase de posprocesamiento.	PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
DBNodeId	string	El ID del nodo. Nota Debe especificar el parámetro `DBNodeId` o `DBClusterId`. Puede llamar a la operación DescribeDBClusters para consultar los detalles de sus clústeres, incluidos los ID de los nodos.	pi-*************

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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-*************"
        }
      ]
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.