DescribeActiveOperationTask - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Consulta la información detallada sobre las tareas de una instancia de ApsaraDB for MongoDB.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dds:DescribeActiveOperationTask

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Region	string	Sí	El ID de región de la instancia. Nota Si establece el parámetro Region en all, se consultan todas las tareas creadas dentro de su cuenta de Alibaba Cloud. En este caso, debe establecer el parámetro taskType en all.	cn-shanghai
TaskType	string	Sí	El tipo de tarea. Valores válidos: rds_apsaradb_ha: conmutación entre principal y réplica rds_apsaradb_transfer: migración de instancia rds_apsaradb_upgrade: actualización de versión menor	rds_apsaradb_ha
IsHistory	integer	No	Especifica si se deben devolver las tareas históricas. Valor predeterminado: 0. Valores válidos: 0: devuelve la tarea actual. 1: devuelve las tareas históricas.	0
PageSize	integer	No	El número de entradas a devolver en cada página. Especifique un valor mayor que 10. Valor predeterminado: 30.	30
PageNumber	integer	No	El número de la página a devolver. El valor debe ser un número entero mayor que 0. Valor predeterminado: 1.	1
ProductId	string	No	El ID del producto.	MongoDB

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
TotalRecordCount	integer	El número total de entradas devueltas.	0
RequestId	string	El ID de la solicitud.	6FD47DC4-0750-5524-A89E-E7D559Cxxxxx
PageSize	integer	El número de entradas devueltas por página.	30
PageNumber	integer	El número de la página devuelta.	1
Items	array<object>	La lista de tareas.
	object
Status	integer	El estado de la tarea. Valores válidos: 2: La tarea está esperando que los usuarios especifiquen una hora de conmutación. 3: La tarea está esperando ser ejecutada. 4: La tarea se está ejecutando. Si la tarea se encuentra en este estado, no se puede llamar a la operación ModifyActiveOperationTask para modificar la hora de conmutación programada. 5: La tarea se ha ejecutado. 6: La tarea falló. 7: La tarea se canceló.	2
TaskParams	string	Los parámetros de la tarea.	""
PrepareInterval	string	El período de preparación requerido entre la hora de inicio de la tarea y la hora de conmutación. La hora se muestra en formato HH:mm:ss.	14:00:00
Deadline	string	La fecha límite antes de la cual se puede modificar la hora para ejecutar la tarea. La hora en UTC se muestra en formato yyyy-MM-ddTHH:mm:ssZ.	2023-03-29T13:59:59Z
StartTime	string	La hora en que se ejecutó la tarea. La hora sigue el estándar ISO 8601 en formato yyyy-MM-ddThh:mm:ssZ. La hora se muestra en UTC.	2023-03-20T02:40:00Z
TaskType	string	El tipo de tarea. Valores válidos: rds_apsaradb_ha: conmutación entre principal y réplica rds_apsaradb_transfer: migración de instancia rds_apsaradb_upgrade: actualización de versión menor all: todos los tipos	rds_apsaradb_ha
ModifiedTime	string	La hora en que se modificó la tarea. La hora sigue el estándar ISO 8601 en formato yyyy-MM-ddThh:mm:ssZ. La hora se muestra en UTC.	2023-02-24T08:18:53Z
InsName	string	El ID de la instancia.	dds-bp12721xxxx9b914
DbType	string	El tipo de base de datos de la instancia.	mongodb
Region	string	La región de la instancia.	cn-beijing
ResultInfo	string	La información del resultado.	""
CreatedTime	string	La hora en que se creó la tarea. La hora sigue el estándar ISO 8601 en formato yyyy-MM-ddThh:mm:ssZ. La hora se muestra en UTC.	2024-11-06T13:11:08Z
Id	integer	El ID de la tarea.	50xx
SwitchTime	string	La hora en que el sistema ejecuta la operación de conmutación. La hora sigue el estándar ISO 8601 en formato yyyy-MM-ddThh:mm:ssZ. La hora se muestra en UTC.	2024-11-06T14:11:08Z

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	RequiredParam.NotFound	Required input param is not found.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.