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

Consulta os detalhes das tarefas de O&M.

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 à qual os eventos pendentes pertencem. Você pode chamar a operação DescribeRegions para consultar os IDs das regiões. Se você definir este parâmetro como all, todas as tarefas da conta atual serão consultadas, e o parâmetro TaskType também deverá ser definido como all.	cn-shanghai
TaskType	string	Sim	O tipo de tarefa. Valores válidos: rds_apsaradb_ha: alternância de nó primário/secundário. rds_apsaradb_transfer: migração de instância. rds_apsaradb_upgrade: atualização de versão secundária. Você pode obter os valores válidos na operação DescribeHistoryTasks. Se você definir este parâmetro como all, todas as tarefas da conta atual serão consultadas, e o parâmetro Region também deverá ser definido como all.	rds_apsaradb_ha
IsHistory	integer	Não	Especifica se devem ser retornadas tarefas históricas. Valores válidos: 0: retorna tarefas atuais. Este é o valor padrão. 1: retorna tarefas históricas.	0
PageSize	integer	Não	O número máximo de entradas a serem retornadas em cada página. O valor deve ser maior que 10. Valor padrão: 30.	30
PageNumber	integer	Não	O número da página. O valor deve ser maior que 0 e não exceder o valor máximo do tipo de dados Integer. 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.	0
RequestId	string	O ID da solicitação.	6FD47DC4-0750-5524-A89E-E7D559Cxxxxx
PageSize	integer	O número de entradas retornadas por página. Valor padrão: 30.	30
PageNumber	integer	O número da página. Valor padrão: 1.	1
Items	array<object>	A lista de tarefas.
	object
Status	integer	O status da tarefa. Valores válidos: 2: Aguardando que o usuário especifique um horário. 3: Aguardando processamento. 4: Processando. Após a tarefa entrar neste estado, o horário de switchover agendado não pode ser modificado. 5: Bem-sucedido. 6: Com falha. 7: Cancelado.	2
TaskParams	string	Os parâmetros da tarefa.	""
PrepareInterval	string	O tempo de preparação necessário entre o horário de início e o horário de switchover da tarefa de O&M. O formato é HH:mm:ss.	14:00:00
Deadline	string	O horário mais recente dentro do intervalo ajustável para o horário de execução da tarefa de O&M. O formato é `yyyy-MM-ddTHH:mm:ssZ` (horário UTC).	2023-03-29T13:59:59Z
StartTime	string	O horário de execução da tarefa de O&M. O formato é `yyyy-MM-ddTHH:mm:ssZ` (horário UTC).	2023-03-20T02:40:00Z
TaskType	string	O tipo de tarefa. Valores válidos: rds_apsaradb_ha: alternância de nó primário/secundário. rds_apsaradb_transfer: migração de instância. rds_apsaradb_upgrade: atualização de versão secundária.	rds_apsaradb_ha
ModifiedTime	string	O horário em que a tarefa de O&M foi modificada. O formato é `yyyy-MM-ddTHH:mm:ssZ` (horário UTC).	2023-02-24T08:18:53Z
InsName	string	O ID da instância.	dds-bp12721xxxx9b914
DbType	string	O tipo de banco de dados.	mongodb
Region	string	O ID da região.	cn-beijing
ResultInfo	string	As informações do resultado da execução.	""
CreatedTime	string	O horário em que a tarefa de O&M foi criada. O formato é `yyyy-MM-ddTHH:mm:ssZ` (horário UTC).	2024-11-06T13:11:08Z
Id	integer	O ID da tarefa.	50xx
SwitchTime	string	O horário de switchover da tarefa de O&M. O formato é `yyyy-MM-ddTHH:mm:ssZ` (horário 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.