Consulta de estado de tarea
Función
Esta API se utiliza para consultar el estado de ejecución de una tarea. Se puede utilizar para consultar el estado de ejecución de una tarea de creación de disco, de expansión de capacidad o de eliminación.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v1/{project_id}/jobs/{job_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
job_id |
Sí |
String |
El ID de la tarea. |
project_id |
Sí |
String |
El ID del proyecto. Para obtener más información sobre cómo obtener el ID de proyecto, consulte Obtención de un ID de proyecto. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
El token del usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
El estado de la tarea. SUCCESS: La tarea se realizó correctamente. RUNNING: La tarea está en progreso. FAIL: El error en la tarea. INIT: Se está inicializando la tarea. Valores de enumeración:
|
entities |
JobEntities object |
La información de respuesta a la tarea. |
job_id |
String |
El ID de la tarea. |
job_type |
String |
El tipo de tarea.
|
begin_time |
String |
La hora de inicio. |
end_time |
String |
El tiempo final. |
error_code |
String |
El código de error devuelto si se produce un error en la ejecución de la tarea. |
fail_reason |
String |
La causa del error de ejecución de la tarea. |
Parámetro |
Tipo |
Descripción |
---|---|---|
volume_type |
String |
El tipo de disco. |
size |
Integer |
El tamaño del disco, en GiB. |
volume_id |
String |
El ID del disco. |
name |
String |
El nombre del disco. |
sub_jobs |
Array of SubJob objects |
La información de una subtarea. Si hay una subtarea, no se devuelven otros campos de entities. |
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
El estado de la subtarea. SUCCESS: La tarea se realizó correctamente. RUNNING: La tarea está en progreso. FAIL: El error en la tarea. INIT: Se está inicializando la tarea. Valores de enumeración:
|
entities |
SubJobEntities object |
La información de respuesta a la subtarea. |
job_id |
String |
El ID de la subtarea. |
job_type |
String |
El tipo de subtarea.
|
begin_time |
String |
La hora de inicio. |
end_time |
String |
El tiempo final. |
error_code |
String |
El código de error devuelto si se produce un error en la ejecución de la subtarea. |
fail_reason |
String |
La causa del error de ejecución de la subtarea. |
Parámetro |
Tipo |
Descripción |
---|---|---|
volume_type |
String |
El tipo de disco. |
size |
Integer |
El tamaño del disco, en GiB. |
volume_id |
String |
El ID del disco. |
name |
String |
El nombre del disco. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
El mensaje de error devuelto si se produce un error. Para obtener más detalles, consulte Parámetros en el campo error. |
Parámetro |
Tipo |
Descripción |
---|---|---|
code |
String |
El código de error devuelto si se produce un error. Para conocer los códigos de error y sus significados, véase Códigos de error. |
message |
String |
El mensaje de error devuelto si se produce un error. |
Ejemplo de solicitudes
GET https://{endpoint}/v1/{project_id}/jobs/{job_id} https://{endpoint}/v1/{project_id}/jobs/{job_id}
Ejemplo de respuestas
Código de estado: 200
Aceptar
{ "status" : "RUNNING", "entities" : { "volume_id" : "bdf1bb37-f20f-4266-9a04-f43e0a127376" }, "job_id" : "4010a32d535527910153552b492c0002", "job_type" : "createVolume", "begin_time" : "2016-03-08T07:40:13.219Z", "end_time" : "" }
Código de estado: 400
Error en la solicitud
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Aceptar |
400 |
Error en la solicitud |
Códigos de error
Consulte Códigos de error.