Obtención de información acerca de una tarea con un ID especificado
Función
Esta API se utiliza para obtener información sobre una tarea con un ID especificado en el centro de tareas.
Restricciones
- Actualmente, solo se pueden consultar tareas asincrónicas en el centro de tareas de Edición DDS dentro de un mes.
- Después de generar un trabajo, se tarda varios segundos en consultar el ID del trabajo.
- Se pueden consultar las siguientes tareas asincrónicas: crear una instancia (nodo único, conjunto de réplicas o clúster), escalar el almacenamiento, cambiar la clase de instancia, escalar un nodo, reiniciar un nodo, realizar una conmutación primaria/en espera, cambiar una dirección IP privada, cambiar un grupo de seguridad, cambiar un puerto de base de datos, vincular o desvincular un EIP, cambiar el modo SSL y cambiar un zona de disponibilidad, habilitar la dirección IP de shard/config, crear una copia de respaldo física / copia de respaldo instantánea, restauración a una nueva instancia mediante una copia de respaldo, recuperación a un punto en el tiempo y restauración a nivel de base de datos/tabla a un punto de tiempo especificado.
Depuración
Puede depurar esta API en el Explorador de API.
URI
- Descripción del parámetro
Tabla 1 Descripción del parámetro Nombre
Obligatorio
Descripción
project_id
Sí
ID de proyecto de un inquilino en una región.
Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
id
Sí
ID de la tarea
Solicitudes
Ninguno
Respuestas
- Respuesta normal
Tabla 2 Descripción del parámetro Nombre
Tipo
Descripción
job
Object
Información de la tarea. Para más detalles, consulte Tabla 3.
Tabla 3 descripción de la estructura de datos del campo de job Nombre
Tipo
Descripción
id
String
ID de la tarea
name
String
Nombre de la tarea
status
String
Estado de ejecución de la tarea
Valor válido:- Running: La tarea se está ejecutando.
- Completed: la tarea se ejecuta correctamente.
- Failed: no se puede ejecutar la tarea.
created
String
Tiempo de creación en el formato "aaaa-mm-ddThh:mm:ssZ".
T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
ended
String
Hora de finalización en el formato "aaaa-mm-ddThh:mm:ssZ".
T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
progress
String
Progreso de la ejecución de tareas
NOTA:El progreso de la ejecución (como "60%", lo que indica que el progreso de la ejecución de la tarea es del 60%) solo se muestra cuando se está ejecutando la tarea. De lo contrario, se devuelve "".
instance
Object
Instancia en la que se ejecuta la tarea.
Para más detalles, consulte Tabla 4.
fail_reason
String
Información de error de tarea.
Tabla 4 descripción de la estructura de datos de campo de instancia Nombre
Tipo
Descripción
id
String
ID de la instancia
name
String
Nombre de instancia de BD
En el ejemplo de respuesta, algunas tareas del centro de tareas se utilizan como ejemplos.
- Ejemplo de respuesta normal
Una tarea se ejecuta correctamente.
{ "job": { "id": "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae", "name": "Create_MongoDB", "status": "Completed", "created": "2021-07-12T09:22:04+0000", "ended": "2021-07-12T10:10:13+0000", "progress": "", "instance": { "id": "d87f5b33049144ec95f0cab0a5f22cfbin02", "name": "dds-5ff4-sh" }, "fail_reason": null } }Se está ejecutando una tarea:
{ "job": { "id": "9d10bfd1-affb-49c3-b977-298950a8d6fa", "name": "Create_MongoDB", "status": "Running", "created": "2021-07-13T07:28:43+0000", "ended": "2021-07-13T07:28:53+0000", "progress": "9%", "instance": { "id": "cf538a2dd8ec4b26860b27060902712fin02", "name": "dds-3a98-wcc" }, "fail_reason": null } }No se puede ejecutar una tarea:
{ "job": { "id": "a03b1b8a-b756-467c-8a49-38720c3d23ec", "name": "Restore_MongoDB_Replica", "status": "Failed", "created": "2021-07-13T04:55:58+0000", "ended": "2021-07-13T05:20:04+0000", "progress": "", "instance": { "id": "7beb15d5db9c4742b7c817789244844ein02", "name": "lenn-v3-restore-4" }, "fail_reason": "Failed to upgrade the DB Agent." } }
Código de estado
Para obtener más información, consulte Código de estado.
Código de error
Para obtener más información, consulte Código de error.
