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

Consulta los registros de alta disponibilidad de una instancia.

Descripción de la operación

Nota

Solo PolarDB for MySQL admite esta operación.

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:DescribeHALogs

get

*Todos los recursos.

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

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. Nota Consulta los registros de conmutación por error de alta disponibilidad del DBNodeId especificado. Puede llamar a la operación DescribeDBClusters para consultar los detalles de todos los clústeres de su cuenta, incluidos los ID de nodo.	pi-****************
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página. Valores válidos: de 5 a 50. Valor predeterminado: 10.	30
StartTime	string	No	La hora de inicio de la consulta. Especifique la hora en el formato `YYYY-MM-DDThh:mm:ssZ` (UTC).	2025-05-01T00:00:00Z
EndTime	string	No	La hora de finalización de la consulta. La hora de finalización debe ser posterior a la hora de inicio. Especifique la hora en el formato `YYYY-MM-DDThh:mm:ssZ` (UTC).	2025-05-23T01:01:00Z
LogType	string	Sí	El tipo de registro. Valores válidos: HaSwitchLogList : Lista de registros de conmutación por error de alta disponibilidad.	HaSwitchLogList

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
TotalRecords	integer	El número total de registros.	160
ItemsNumbers	integer	El número de elementos de la lista de registros en la página actual.	10
PageNumber	integer	El número de página. El valor es un entero positivo que no excede el valor máximo del tipo de dato Integer. Valor predeterminado: 1.	1
DBInstanceName	string	El ID de la instancia.	pc-a*************
DBInstanceType	string	El tipo de instancia. Valores válidos: polardb_mysql_rw: instancia de lectura/escritura. polardb_mysql_ro: instancia de solo lectura. polardb_mysql_standby: instancia en espera.	polardb_mysql_rw
HaStatus	integer	Indica si existen registros de conmutación principal/secundaria. Valores válidos: 1: No existen registros. 0: Existen registros.	1
HaLogItems	array<object>	La lista de registros de conmutación principal/secundaria.
	object	La lista de registros de conmutación principal/secundaria.
SwitchId	string	El ID del registro de conmutación principal/secundaria.	e571f897-9b3c-4012-9470-88333832dec4
SwitchCauseCode	string	El código de causa de la conmutación.	Platform.Ha.AuroraService.ManualOperations
SwitchCauseDetail	string	La causa de la conmutación.	Platform.Ha.ManuallyTriggered
SwitchStartTime	string	La hora de inicio de la conmutación. La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2025-05-20T03:09:45Z
SwitchFinishTime	string	La hora de finalización de la conmutación. La hora está en formato ISO 8601 en UTC (formato: YYYY-MM-DDTHH:mm:ssZ).	2025-05-20T03:09:56Z
RequestId	string	El ID de la solicitud.	6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
PageSize	integer	El número de entradas por página. Valores válidos: de 30 a 100. Valor predeterminado: 30.	30

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalRecords": 160,
  "ItemsNumbers": 10,
  "PageNumber": 1,
  "DBInstanceName": "pc-a*************",
  "DBInstanceType": "polardb_mysql_rw",
  "HaStatus": 1,
  "HaLogItems": [
    {
      "SwitchId": "e571f897-9b3c-4012-9470-88333832dec4",
      "SwitchCauseCode": "Platform.Ha.AuroraService.ManualOperations",
      "SwitchCauseDetail": "Platform.Ha.ManuallyTriggered",
      "SwitchStartTime": "2025-05-20T03:09:45Z",
      "SwitchFinishTime": "2025-05-20T03:09:56Z"
    }
  ],
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******",
  "PageSize": 30
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	El parámetro PageSize especificado no es válido.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	El parámetro PageNumber especificado no es válido.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	La operación falló. El ID de instancia del cluster especificado no existe.

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.