Consulta de estado de ejecución de tareas
Función
Esta API se utiliza para consultar el estado de ejecución de una tarea de solicitud asincrónica.
Después de emitir una tarea de solicitud asincrónica, por ejemplo, crear o eliminar un ECS, realizar operaciones en ECS por lotes o realizar operaciones en NIC de ECS, se devolverá un ID de tarea, basado en el cual se puede consultar el estado de ejecución de la tarea.
Para obtener más información sobre cómo obtener el ID de tarea, consulte Respuestas (tarea).
URI
GET /v1/{project_id}/jobs/{job_id}
Parámetro |
Obligatorio |
Descripción |
---|---|---|
project_id |
Sí |
Especifica el ID del proyecto. Para obtener más información sobre cómo obtener el ID, consulte Obtención de un ID de proyecto. |
job_id |
Sí |
Especifica el identificador de una tarea de solicitud asincrónica. |
Solicitud
No hay
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
Especifica el estado de la tarea.
|
entities |
Object |
Especifica el objeto de la tarea. El valor de este parámetro varía dependiendo del tipo de tarea. Si la tarea es una operación relacionada con el ECS, el valor es server_id. Si la tarea es una operación NIC, el valor es nic_id. Si hay un subtrabajo disponible, se muestran los detalles sobre el subtrabajo. Para más detalles, consulte Tabla 3. |
job_id |
String |
Especifica el ID de una tarea de solicitud asincrónica. |
job_type |
String |
Especifica el tipo de tarea de solicitud asincrónica. |
begin_time |
String |
Especifica la hora en la que se inició la tarea. |
end_time |
String |
Especifica la hora en que terminó la tarea. |
error_code |
String |
Especifica el código de error devuelto cuando se produce un error en la ejecución de la tarea. Una vez que la tarea se ejecuta correctamente, el valor de este parámetro es null. |
fail_reason |
String |
Especifica la causa del error de ejecución de la tarea. Una vez que la tarea se ejecuta correctamente, el valor de este parámetro es null. |
message |
String |
Especifica el mensaje de error que se devuelve cuando se produce un error en la solicitud para consultar una tarea. |
code |
String |
Especifica el código de error devuelto cuando se produce un error en la solicitud para consultar una tarea. Para obtener más información sobre el código de error, consulte Valores devueltos para solicitudes generales. |
Parámetro |
Tipo |
Descripción |
---|---|---|
sub_jobs_total |
Integer |
Especifica el número de subtareas. |
sub_jobs |
Array of objects |
Especifica la información de ejecución de una subtarea. Para más detalles, consulte Tabla 4. |
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
Especifica el estado de la tarea.
|
entities |
Object |
Especifica el objeto de la tarea. El valor de este parámetro varía dependiendo del tipo de tarea. Si la tarea es una operación relacionada con el ECS, el valor es server_id. Si la tarea es una operación NIC, el valor es nic_id. Para más detalles, consulte Tabla 5. |
job_id |
String |
Especifica el ID de subtarea. |
job_type |
String |
Especifique el tipo de subtarea. |
begin_time |
String |
Especifica la hora en la que se inició la tarea. |
end_time |
String |
Especifica la hora en que terminó la tarea. |
error_code |
String |
Especifica el código de error devuelto cuando se produce un error en la ejecución de la tarea. Una vez que la tarea se ejecuta correctamente, el valor de este parámetro es null. |
fail_reason |
String |
Especifica la causa del error de ejecución de la tarea. Una vez que la tarea se ejecuta correctamente, el valor de este parámetro es null. |
Parámetro |
Tipo |
Descripción |
---|---|---|
server_id |
String |
Si la tarea es una operación relacionada con el ECS, el valor es server_id. |
nic_id |
String |
Si la tarea es una operación relacionada con NIC, el valor es nic_id. |
errorcode_message |
String |
Indica la causa del error de ejecución de una subtarea. |
Ejemplo de la solicitud
GET https://{endpoint}/v1/{project_id}/jobs/{job_id}
Ejemplo de la respuesta
{ "status": "SUCCESS", "entities": { "sub_jobs_total": 1, "sub_jobs": [ { "status": "SUCCESS", "entities": { "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d" }, "job_id": "2c9eb2c5544cbf6101544f0635672b60", "job_type": "createSingleServer", "begin_time": "2016-04-25T20:04:47.591Z", "end_time": "2016-04-25T20:08:21.328Z", "error_code": null, "fail_reason": null } ] }, "job_id": "2c9eb2c5544cbf6101544f0602af2b4f", "job_type": "createServer", "begin_time": "2016-04-25T20:04:34.604Z", "end_time": "2016-04-25T20:08:41.593Z", "error_code": null, "fail_reason": null }
Valores devueltos
Códigos de error
Consulte Códigos de error