DescribeDBInstanceSwitchLog - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Consulta os logs de alternância primário/secundário de uma instância do ApsaraDB for MongoDB.

Descrição da operação

Antes de chamar esta operação, certifique-se de que a instância do ApsaraDB for MongoDB atenda aos seguintes requisitos:

A instância é uma instância de conjunto de réplicas ou cluster fragmentado.
A instância usa discos físicos locais para armazenar dados.

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

dds:DescribeDBInstanceSwitchLog

list

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
StartTime	string	Não	O início do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato aaaa-mm-ddThh:mmZ. A hora deve estar em UTC.	2023-05-27T02:46Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato aaaa-mm-ddThh:mmZ. A hora deve estar em UTC. A hora de término deve ser posterior à hora de início.	2023-05-28T02:00Z
PageNumber	integer	Não	O número da página a ser retornada. O valor deve ser um número inteiro maior que 0 e menor ou igual ao valor máximo suportado pelo tipo de dados inteiro. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30, 50 e 100. Valor padrão: 30.	30
DBInstanceId	string	Não	O ID da instância.	dds-uf68f1b5a57exxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	ECBCA991-XXXX-XXXX-834C-B3E8007F33AA
DBInstanceId	string	O ID da instância.	dds-uf68f1b5a57exxxx
TotalCount	integer	O número de entradas de alternância primário/secundário.	1
PageSize	integer	O número de entradas retornadas em cada página.	30
PageNumber	integer	O número da página retornada.	1
LogItems	array<object>	Os logs de alternância primário/secundário.
	object
SwitchStatus	string	O status da alternância. Valores válidos: 1 e 0. O valor 1 indica uma alternância primário/secundário bem-sucedida e o valor 0 indica uma alternância primário/secundário com falha.	1
SwitchTime	string	O momento em que uma alternância primário/secundário foi realizada. A hora segue o padrão ISO 8601 no formato aaaa-mm-ddThh:mm:ssZ. A hora é exibida em UTC.	2023-02-07T18:00:00Z
SwitchCode	string	O código que indica o motivo de uma alternância primário/secundário. Valores válidos: USER_CONSOLE_OPERATION: A alternância é realizada manualmente. OPERATION_AND_MAINTENANCE: Existem riscos potenciais. MACHINE_DOWNTIME: O host está offline. PRIMARY_UNHEALTHY: Ocorre uma exceção no nó primário da instância. SECONDARY_UNHEALTHY: Ocorre uma exceção no nó secundário da instância. MULTIPLE_NODE_FAILURES: Ocorre uma exceção em vários nós da instância.	USER_CONSOLE_OPERATION
NodeId	string	O ID da instância de conjunto de réplicas ou o ID do nó no qual uma alternância primário/secundário é realizada.	NodeId-example-id-****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "ECBCA991-XXXX-XXXX-834C-B3E8007F33AA",
  "DBInstanceId": "dds-uf68f1b5a57exxxx",
  "TotalCount": 1,
  "PageSize": 30,
  "PageNumber": 1,
  "LogItems": [
    {
      "SwitchStatus": "1",
      "SwitchTime": "2023-02-07T18:00:00Z",
      "SwitchCode": "USER_CONSOLE_OPERATION",
      "NodeId": "NodeId-example-id-****"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameterCombination	The end time must be greater than the start time	The start time must be earlier than the end time.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.