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

Consulta os logs de um cluster PolarDB, como logs de failover primário/secundário.

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

list

*DBCluster

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

Nenhuma

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ó no cluster PolarDB.	pi-*************
PageNumber	integer	Não	O número da página. O valor deve ser um número inteiro maior que 0. O valor padrão é 1.	1
PageSize	integer	Não	O tamanho da página. Valores válidos: 5 a 50. O valor padrão é 10.	10
StartTime	string	Não	O início do intervalo de tempo a ser consultado. O horário deve estar em UTC e formatado como `yyyy-MM-ddTHH:mm:ssZ`.	2023-08-20T16:00:00Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. O horário deve estar em UTC e formatado como `yyyy-MM-ddTHH:mm:ssZ`.	2023-09-20T16:00:00Z
LogType	string	Sim	O tipo de log. Valores válidos: HaSwitchLogList: Uma lista de logs de failover. HaSwitchLogInfo: Detalhes de um log de failover. SimulateSwitchLogs: Logs de simulação de failover. Valores válidos: HaSwitchLogList : HaSwitchLogList.	HaSwitchLogList
DescribeSimulateSwitchMode	string	Não	O modo para consultar registros de simulação. Valores válidos: 0: Consulta os registros de simulação de uma instância lógica. Você pode especificar o ID da simulação. 1: Consulta os registros de simulação de uma instância física com base em um `SimulateListId` especificado. 2: Consulta os registros da simulação em andamento mais recente.	0
SimulateListId	string	Não	O ID de um registro de simulação de instância lógica.	"95"
SimulateStatusList	string	Não	Filtra os resultados por um ou mais status de simulação. Especifique vários status como uma string separada por vírgulas. Valores válidos: 0: Aguardando agendamento 1: Bem-sucedido 2: Em execução 3: Falhou 4: Interrompido 5: Aguardando switchback 6: Cancelado	"0,1,2,3,4,5"
SimulateModeList	string	Não	Filtra os resultados por um ou mais modos de simulação. Especifique vários modos como uma string separada por vírgulas. Valores válidos: 0: A falha é injetada na zona de disponibilidade primária. 1: A falha é injetada na instância de banco de dados. 2: A falha é injetada no data center de recuperação de desastres.	0,1,2

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalRecords	integer	O número total de registros.	1
ItemsNumbers	integer	O número de itens de log na página atual.	1
PageNumber	integer	O número da página. Deve ser um número inteiro positivo que não exceda o valor máximo do tipo de dados Integer. Valor padrão: 1.	1
DBInstanceName	string	O ID do cluster.	pc-****************
DBInstanceType	string	O tipo de instância. Valores válidos: polardb_mysql_rw: instância de leitura e gravação. polardb_mysql_ro: instância somente leitura. polardb_mysql_standby: instância em standby.	polardb_mysql_rw
HaStatus	integer	Indica se existe um registro de failover. Valores válidos: 1: Não 0: Sim Valores válidos: 0 : 0 1 : 1	1
HaLogItems	array<object>	Uma lista de logs de failover.
	object	O log de failover.
SwitchId	string	O ID do log de failover.	e571f897-9b3c-4012-9470-88333832dec4
FromDBType	string	O tipo de instância antes do failover. Valores válidos: polardb_mysql_rw: instância de leitura e gravação. polardb_mysql_ro: instância somente leitura. polardb_mysql_standby: instância em standby.	polardb_mysql_rw
SwitchCauseCode	string	O código de erro para a causa do failover.	Platform.Ha.AuroraService.ManualOperations
SwitchCauseDetail	string	Detalhes sobre a causa do failover.	Platform.Ha.ManuallyTriggered
SwitchStartTime	string	O horário em que o failover começou. O horário está no formato `yyyy-MM-ddTHH:mm:ssZ` e é exibido em UTC.	2025-05-20T03:09:45Z
SwitchFinishTime	string	O horário em que o failover foi concluído. O horário está no formato `yyyy-MM-ddTHH:mm:ssZ` e é exibido em UTC.	2025-05-20T03:09:56Z
TotalSessions	integer	O número total de sessões durante o failover.	10000
AffectedSessions	integer	O número de sessões afetadas durante o failover.	100
SwitchType	integer	O tipo de failover.	0
RequestId	string	O ID da solicitação.	24A1990B-4F6E-482B-B8CB-75C612******
PageSize	integer	O número de entradas a serem retornadas em cada página. Valores válidos: 5 a 50. Valor padrão: 10.	10
SwitchListItems	array<object>	Uma lista de registros de simulação de falha.
	array<object>	O registro de simulação de falha.
SimulateListId	string	O ID do registro de simulação de falha.	23
SimulateMode	string	O modo de simulação de falha.	0
SimulateStatus	string	O status da simulação de falha. Valores válidos: 0: Pendente 1: Sucesso 2: Em execução 3: Falhou 4: Abortado 5: Aguardando rollback	2
StartTime	string	O horário em que a simulação de falha começou. O horário está no formato `yyyy-MM-ddTHH:mm:ssZ` e é exibido em UTC.	2025-02-25T01:05:00Z
EndTime	string	O horário em que a simulação de falha foi concluída. O horário está no formato `yyyy-MM-ddTHH:mm:ssZ` e é exibido em UTC.	2025-02-10T02:25:00Z
EventStartTime	string	O horário em que o evento do sistema começou. O horário está no formato `yyyy-MM-ddTHH:mm:ssZ` e é exibido em UTC.	2025-04-19T01:12:00Z
EventFinishTime	string	O horário em que o evento do sistema foi concluído. O horário está no formato `yyyy-MM-ddTHH:mm:ssZ` e é exibido em UTC.	2025-04-19T02:12:00Z
SimulateTaskId	string	O ID da tarefa de simulação de falha.	23
DBNodeCrashList	array	Os IDs dos nós nos quais simular uma falha. Nota Para uma simulação de falha no nível do nó, especifique o ID de um único nó. Para uma simulação de falha no nível da zona de disponibilidade, você pode omitir este parâmetro ou especificar os IDs de todos os nós na zona.
	string	O ID do nó.	pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t
SwitchLogItems	array<object>	Uma lista de logs de simulação de falha.
	array<object>	O log de simulação de falha.
SimulateListId	string	The simulation list ID.	96
SimulateLogId	string	The simulation log ID.	23
DBInstanceId	string	The cluster ID. Nota You can call the DescribeDBClusters operation to query the details of your clusters, including the cluster IDs.	pc-*************
SrcDbType	string	The source database type. Valid values: PolarDBMySQL: A major version upgrade of PolarDB for MySQL. RDS: A migration from RDS to PolarDB for MySQL.	PolarDBMySQL
DstDbType	string	The destination database type. Valid values: PolarDBMySQL: A major version upgrade of PolarDB for MySQL. RDS: A migration from RDS to PolarDB for MySQL.	PolarDBMySQL
SimulateStatus	string	The fault simulation status. Valid values: 0: Pending 1: Success 2: Running 3: Failed 4: Aborted 5: Awaiting rollback	1
EventStartTime	string	The time when the system event started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.	2025-04-19T01:12:00Z
EventFinishTime	string	The time when the system event was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.	2025-04-19T02:12:00Z
SwitchStepItems	array<object>	A list of fault simulation steps.
	object	The fault simulation step.
StepName	string	The name of the current step. You can call the DescribeHistoryTasks operation to query the current step of a specified task. A common value is do_pause, which indicates that the system waits for a specified period of time.	init_task_info
StartTime	string	The time when the step started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.	2025-04-19T02:12:00Z
SimulatePhase	string	The fault simulation phase. Valid values: PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION: The fault injection phase. PolarDB.MySQL.FaultSimulate.Phase.RECOVERY: The recovery phase. PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS: The post-processing phase.	PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
EndTime	string	The time when the step was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.	2025-08-14T02:07:00Z
TimeCost	string	The duration of the step in milliseconds.	1000
IsSuccess	string	Indicates whether the step was successful. Valid values: `true`: The step was successful. `false`: The step failed.	true
SwitchStepItems	array<object>	Uma lista de etapas de failover.
	object
SimulatePhase	string	The fault simulation phase. Valid values: PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION: The fault injection phase. PolarDB.MySQL.FaultSimulate.Phase.RECOVERY: The recovery phase. PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS: The post-processing phase.	PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
StepName	string	The name of the current step. You can call the DescribeHistoryTasks operation to query the current step of a specified task. A common value is do_pause, which indicates that the system waits for a specified period of time.	init_task_info
StartTime	string	The time when the step started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.	2025-07-16T02:12:00Z
EndTime	string	The time when the step was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.	2025-07-23T02:30:00Z
TimeCost	string	The duration of the step in milliseconds.	1000
IsSuccess	string	Indicates whether the step was successful. Valid values: `true`: The step was successful. `false`: The step failed.	true
DBNodeId	string	The cluster node ID. Nota This parameter is returned only when the `Key` parameter in the request is not set to `PolarDBDiskUsage`.	pi-*************
FaultInjectionType	string	O método de injeção de falha. Valores válidos: CrashSQLInjection: Injeta uma falha na instância usando `Crash SQL`.	CrashSQLInjection
SwitchLogItems	array<object>	Uma lista de logs de simulação de falha.
	array<object>	O log de simulação de falha.
SimulateListId	string	O ID da lista de simulação.	231
Simulatecode	string	O código de status da simulação de falha.	0
DBInstanceId	string	O ID do cluster. Nota Você pode chamar a operação DescribeDBClusters para consultar os detalhes dos seus clusters, incluindo os IDs dos clusters.	pc-*************
SrcDbType	string	O tipo de banco de dados de origem. Valores válidos: PolarDBMySQL: Uma atualização de versão principal do PolarDB for MySQL. RDS: Uma migração do RDS para o PolarDB for MySQL.	PolarDBMySQL
DstDbType	string	O tipo de banco de dados de destino. Valores válidos: PolarDBMySQL: Uma atualização de versão principal do PolarDB for MySQL. RDS: Uma migração do RDS para o PolarDB for MySQL.	PolarDBMySQL
SimulateStatus	string	O status da simulação de falha. Valores válidos: 0: Pendente 1: Sucesso 2: Em execução 3: Falhou 4: Abortado 5: Aguardando rollback	1
EventStartTime	string	O horário em que o evento do sistema começou. O horário está no formato `yyyy-MM-ddTHH:mm:ssZ` e é exibido em UTC.	2025-04-19T01:12:00Z
EventFinishTime	string	O horário em que o evento do sistema foi concluído. O horário está no formato `yyyy-MM-ddTHH:mm:ssZ` e é exibido em UTC.	2025-04-19T02:12:00Z
SwitchStepItems	array<object>	Uma lista de etapas de failover.
	object
StepName	string	The name of the step.	init_task_info
StepMsg	string	A message about the execution status of the step.	This step exec success
StartTime	string	The time when the step started. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.	2024-10-21T02:12:00Z
EndTime	string	The time when the step was complete. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.	2025-03-27T02:27:00Z
TimeCost	string	The duration of the step in milliseconds.	1000
IsSuccess	string	Indicates whether the step was successful. Valid values: `true`: The step was successful. `false`: The step failed.	true
SimulatePhase	string	The fault simulation phase. Valid values: PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION: The fault injection phase. PolarDB.MySQL.FaultSimulate.Phase.RECOVERY: The recovery phase. PolarDB.MySQL.FaultSimulate.Phase.POST_PROCESS: The post-processing phase.	PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
DBNodeId	string	The node ID. Nota You must specify either the `DBNodeId` or `DBClusterId` parameter. You can call the DescribeDBClusters operation to query the details of your clusters, including the node IDs.	pi-*************

Exemplos

Resposta de sucesso

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 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.