DescribeHALogs - PolarDB: Central de Documentação do Alibaba Cloud

Consulta os logs de alta disponibilidade (HA) de uma instância.

Descrição da operação

Nota

Apenas o PolarDB para MySQL é compatível com esta operação.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

polardb:DescribeHALogs

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	pc-****************
DBNodeId	string	Não	O ID do nó. Nota Este é um campo opcional. Se especificado, consulta os registros de switchover de alta disponibilidade (HA) do DBNodeId. Você pode chamar a operação DescribeDBClusters para visualizar as informações detalhadas de todos os clusters em sua conta, incluindo os IDs dos nós.	pi-****************
PageNumber	integer	Não	O número da página.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 5 a 50. Valor padrão: 10.	30
StartTime	string	Não	O início do intervalo de tempo a ser consultado. O horário segue o formato `YYYY-MM-DDThh:mm:ssZ` (horário UTC).	2025-05-01T00:00:00Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. O horário de término deve ser posterior ao horário de início. O horário segue o formato `YYYY-MM-DDThh:mm:ssZ` (horário UTC).	2025-05-23T01:01:00Z
LogType	string	Sim	O tipo de log.	HaSwitchLogList

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalRecords	integer	O número total de registros.	160
ItemsNumbers	integer	O número de itens na lista de logs na página atual.	10
PageNumber	integer	O número da página. O valor é maior que 0 e não excede o valor máximo do tipo de dados Integer. Valor padrão: 1.	1
DBInstanceName	string	O ID da instância.	pc-a*************
DBInstanceType	string	O tipo da instância. Valores válidos: polardb_mysql_rw: instância de leitura/gravação. polardb_mysql_ro: instância somente leitura. polardb_mysql_standby: instância standby.	polardb_mysql_rw
HaStatus	integer	Indica se existem registros de switchover primário/secundário. Valores válidos: 1: Não 0: Sim	1
HaLogItems	array<object>	A lista de logs de switchover primário/secundário.
	object	A lista de logs de switchover primário/secundário.
SwitchId	string	O ID do log de switchover primário/secundário.	e571f897-9b3c-4012-9470-88333832dec4
SwitchCauseCode	string	O código de causa do switchover.	Platform.Ha.AuroraService.ManualOperations
SwitchCauseDetail	string	A causa do switchover.	Platform.Ha.ManuallyTriggered
SwitchStartTime	string	O horário de início do switchover.	2025-05-20T03:09:45Z
SwitchFinishTime	string	O horário de término do switchover.	2025-05-20T03:09:56Z
RequestId	string	O ID da solicitação.	6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
PageSize	integer	O número de entradas retornadas por página. Valores válidos: 30 a 100. Valor padrão: 30.	30

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.