Consulta de estados de tareas
Función
Esta interfaz se utiliza para consultar el estado de ejecución de una tarea, como la creación de ECS, la eliminación de ECS, la operación por lotes de ECS y la operación de NIC.
Después de entregar una tarea, como crear un BMS o adjuntar los discos, se devuelve job_id, en función del cual puede consultar el estado de ejecución de la tarea.
URI
GET /v1/{project_id}/jobs/{job_id}
Tabla 1 enumera los parámetros.
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 del proyecto, consulte Obtención de un ID de proyecto. |
job_id |
Sí |
Especifica el ID de la tarea. |
Solicitud
Respuesta
- Parámetros de respuesta
Parámetro
Tipo
Descripción
status
String
Especifica el estado de la tarea.
- SUCCESS: La tarea es exitosa.
- RUNNING: La tarea se está ejecutando.
- FAIL: Error en la tarea.
- INIT: Se está inicializando la tarea.
entities
Object
Especifica el objeto de tarea. Para obtener más información, véase Tabla 2.
La información mostrada varía según el tipo de tarea. Para las operaciones relacionadas con los BMS, se muestra server_id. Para las operaciones relacionadas con las NIC, se muestra nic_id. Si existen subtareas, también se muestran los detalles sobre las subtareas.
job_id
String
Especifica el ID de la tarea.
job_type
String
Especifica el tipo de tarea. El valor puede ser:
- baremetalBatchCreate: creación de los BMS en un lote
- baremetalBatchOperate: cambio del estado de energía de los BMS en un lote.
- baremetalVolumeBootReinstallOs: reinstalación del SO de un BMS que se aprovisiona rápidamente
- baremetalReinstallOs: reinstalación del SO de un BMS con los discos locales
- baremetalAttachVolume: adjunto a un disco
- baremetalDetachVolume: desvinculación de un disco
begin_time
String
Especifica la hora en que se inició el trabajo.
El formato de marca de tiempo es ISO 8601, por ejemplo 2019-04-25T20:04:47.591Z.
end_time
String
Especifica la hora a la que terminó el trabajo.
El formato de marca de tiempo es ISO 8601, por ejemplo 2019-04-26T20:04:47.591Z.
error_code
String
Especifica el código de error devuelto cuando se produce un error en la ejecución de una tarea.
fail_reason
String
Especifica la causa del error de ejecución de una tarea.
message
String
Especifica el mensaje devuelto cuando se produce un error.
code
String
Especifica el código de error devuelto cuando se produce un error.
Para obtener más información sobre los códigos de error, consulte la sección Códigos de estado.
Tabla 2 Descripción de la estructura de datos de campo entities Parámetro
Tipo
Descripción
sub_jobs_total
Integer
Especifica el número de subtareas. Si la tarea no tiene subtareas, el valor de este parámetro es 0.
sub_jobs
Array of objects
Especifica la información de ejecución de una subtarea. Si la tarea no tiene subtareas, el valor de este parámetro se deja en blanco. Para obtener más información, véase Tabla 3.
Tabla 3 Descripción de la estructura de datos de campo sub_jobs Parámetro
Tipo
Descripción
status
String
Especifica el estado de la tarea.
- SUCCESS: La tarea es exitosa.
- RUNNING: La tarea se está ejecutando.
- FAIL: Error en la tarea.
- INIT: Se está inicializando la tarea.
entities
Array of objects
Especifica el objeto de tarea. La información mostrada varía según el tipo de tarea. Para las operaciones relacionadas con BMS, se muestra server_id. Para las operaciones relacionadas con las NIC, se muestra nic_id.
Para obtener más información, véase Tabla 4.
job_id
String
Especifica el ID de la tarea.
job_type
String
Especifica el tipo de tarea. El valor puede ser:
- baremetalSingleCreate: creación de un BMS singular
- baremetalSingleOperate: cambio del estado de alimentación de un BMS singular
begin_time
String
Especifica la hora en que se inició el trabajo.
El formato de marca de tiempo es ISO 8601, por ejemplo 2019-04-25T20:04:47.591Z.
end_time
String
Especifica la hora a la que terminó el trabajo.
El formato de marca de tiempo es ISO 8601, por ejemplo 2019-04-26T20:04:47.591Z.
error_code
String
Especifica el código de error devuelto cuando se produce un error en la ejecución de una tarea.
fail_reason
String
Especifica la causa del error de ejecución de una tarea.
message
String
Especifica el mensaje devuelto cuando se produce un error.
code
String
Especifica el código de error devuelto cuando se produce un error.
Para obtener más información sobre los códigos de error, consulte la sección Códigos de estado.
- Ejemplo de la respuesta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
{ "status": "SUCCESS", "entities": { "sub_jobs_total": 1, "sub_jobs": [ { "status": "SUCCESS", "entities": { "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d" }, "job_id": "2c9eb2c5544cbf6101544f0635672b60", "job_type": "baremetalSingleCreate", "begin_time": "2019-04-25T20:04:47.591Z", "end_time": "2019-04-25T20:08:21.328Z", "error_code": null, "fail_reason": null } ] }, "job_id": "2c9eb2c5544cbf6101544f0602af2b4f", "job_type": "baremetalBatchCreate", "begin_time": "2019-04-25T20:04:34.604Z", "end_time": "2019-04-25T20:08:41.593Z", "error_code": null, "fail_reason": null }
Valores devueltos
Valores devueltos |
Descripción |
---|---|
200 |
La solicitud se ha procesado correctamente. |
Para obtener más información sobre otros valores devueltos, consulte Códigos de estado.
Códigos de error
Véase Códigos de error.