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

Consulta as informações detalhadas sobre as tarefas de uma instância do ApsaraDB for MongoDB.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Region	string	Sim	O ID da região da instância. Nota Se você definir o parâmetro Region como all, todas as tarefas criadas na sua conta Alibaba Cloud serão consultadas. Nesse caso, você deve definir o parâmetro taskType como all.	cn-shanghai
TaskType	string	Sim	O tipo da tarefa. Valores válidos: rds_apsaradb_ha: switchover entre primária e réplica rds_apsaradb_transfer: migração de instância rds_apsaradb_upgrade: atualização de versão secundária	rds_apsaradb_ha
IsHistory	integer	Não	Especifica se devem ser retornadas as tarefas históricas. Valor padrão: 0. Valores válidos: 0: retorna a tarefa atual. 1: retorna as tarefas históricas.	0
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Especifique um valor maior que 10. Valor padrão: 30.	30
PageNumber	integer	Não	O número da página a ser retornada. O valor deve ser um número inteiro maior que 0. Valor padrão: 1.	1
ProductId	string	Não	O ID do produto.	MongoDB

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalRecordCount	integer	O número total de entradas retornadas.	0
RequestId	string	O ID da solicitação.	6FD47DC4-0750-5524-A89E-E7D559Cxxxxx
PageSize	integer	O número de entradas retornadas por página.	30
PageNumber	integer	O número da página retornada.	1
Items	array<object>	A lista de tarefas.
	object
Status	integer	O estado da tarefa. Valores válidos: 2: A tarefa está aguardando os usuários especificarem um horário de switchover. 3: A tarefa está aguardando para ser executada. 4: A tarefa está sendo executada. Se a tarefa estiver neste estado, a operação ModifyActiveOperationTask não poderá ser chamada para modificar o horário de switchover agendado. 5: A tarefa foi executada. 6: A tarefa falhou. 7: A tarefa foi cancelada.	2
TaskParams	string	Os parâmetros da tarefa.	""
PrepareInterval	string	O período de preparação necessário entre o horário de início da tarefa e o horário de switchover. O horário é exibido no formato HH:mm:ss.	14:00:00
Deadline	string	O prazo antes do qual o horário de execução da tarefa pode ser modificado. O horário em UTC é exibido no formato yyyy-MM-ddTHH:mm:ssZ.	2023-03-29T13:59:59Z
StartTime	string	O horário em que a tarefa foi executada. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddThh:mm:ssZ. O horário é exibido em UTC.	2023-03-20T02:40:00Z
TaskType	string	O tipo da tarefa. Valores válidos: rds_apsaradb_ha: switchover entre primária e réplica rds_apsaradb_transfer: migração de instância rds_apsaradb_upgrade: atualização de versão secundária all: todos os tipos	rds_apsaradb_ha
ModifiedTime	string	O horário em que a tarefa foi modificada. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddThh:mm:ssZ. O horário é exibido em UTC.	2023-02-24T08:18:53Z
InsName	string	O ID da instância.	dds-bp12721xxxx9b914
DbType	string	O tipo de banco de dados da instância.	mongodb
Region	string	A região da instância.	cn-beijing
ResultInfo	string	As informações do resultado.	""
CreatedTime	string	O horário em que a tarefa foi criada. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddThh:mm:ssZ. O horário é exibido em UTC.	2024-11-06T13:11:08Z
Id	integer	O ID da tarefa.	50xx
SwitchTime	string	O horário em que o sistema executa a operação de switchover. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddThh:mm:ssZ. O horário é exibido em UTC.	2024-11-06T14:11:08Z

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalRecordCount": 0,
  "RequestId": "6FD47DC4-0750-5524-A89E-E7D559Cxxxxx",
  "PageSize": 30,
  "PageNumber": 1,
  "Items": [
    {
      "Status": 2,
      "TaskParams": "\"\"",
      "PrepareInterval": "14:00:00",
      "Deadline": "2023-03-29T13:59:59Z",
      "StartTime": "2023-03-20T02:40:00Z",
      "TaskType": "rds_apsaradb_ha",
      "ModifiedTime": "2023-02-24T08:18:53Z",
      "InsName": "dds-bp12721xxxx9b914",
      "DbType": "mongodb",
      "Region": "cn-beijing",
      "ResultInfo": "\"\"",
      "CreatedTime": "2024-11-06T13:11:08Z",
      "Id": 0,
      "SwitchTime": "2024-11-06T14:11:08Z\n"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	RequiredParam.NotFound	Required input param is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.