Consulta del estado de la 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, expansión de capacidad o eliminación.
Método de invocación
Para obtener más información, consulte Invocación de las API.
Información de autorización
Cada cuenta tiene todos los permisos necesarios para invocar todas las API, pero los usuarios de IAM deben tener asignados los permisos requeridos.
- Si está utilizando la autorización basada en roles/políticas, consulte Políticas de permisos y acciones admitidas para obtener más información sobre los permisos requeridos.
- Si está utilizando la autorización basada en políticas de identidad, no se requiere ningún permiso basado en políticas de identidad para invocar esta API.
URI
GET /v1/{project_id}/jobs/{job_id}
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| job_id | Sí | String | Definición El ID de la tarea. Restricciones N/D Rango N/D Valor predeterminado N/D |
| project_id | Sí | String | Definición El ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto. Restricciones N/D Rango N/D Valor predeterminado N/D |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | Definición El token de usuario. Puede obtenerlo invocando la API de IAM para obtener un token de usuario. El token es el valor de X-Subject-Token en el encabezado de respuesta. Restricciones N/D Rango N/D Valor predeterminado N/D |
Parámetros de respuesta
Código de estado: 200
| Parámetro | Tipo | Descripción |
|---|---|---|
| status | String | Definición El estado de la tarea. Rango
|
| entities | JobEntities object | Definición La información de respuesta de la tarea. Rango N/D |
| job_id | String | Definición El ID de la tarea. Rango N/D |
| job_type | String | Definición El tipo de tarea. Rango
|
| begin_time | String | Definición La hora de inicio. Rango N/D |
| end_time | String | Definición La hora de finalización. Rango N/D |
| error_code | String | Definición El código de error devuelto si la ejecución de la tarea falla. Rango N/D |
| fail_reason | String | Definición La causa del error de ejecución de la tarea. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| volume_type | String | Definición El tipo de disco. Rango N/D |
| size | Integer | Definición El tamaño del disco, en GiB. Rango N/D |
| volume_id | String | Definición El ID del disco. Rango N/D |
| name | String | Definición El nombre del disco. Rango N/D |
| sub_jobs | Array of SubJob objects | Definición La información de la subtarea. Si hay información de subtareas, no se devuelven otros campos de entities. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| status | String | Definición El estado de la subtarea. Rango
|
| entities | SubJobEntities object | Definición La información de respuesta a la subtarea. Rango N/A |
| job_id | String | Definición El ID de la subtarea. Rango N/D |
| job_type | String | Definición El tipo de subtarea. Rango
|
| begin_time | String | Definición La hora de inicio. Rango N/D |
| end_time | String | Definición La hora de finalización. Rango N/D |
| error_code | String | Definición El código de error devuelto si se produce un error en la ejecución de la subtarea. Rango N/D |
| fail_reason | String | Definición La causa del error en la ejecución de la subtarea. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| volume_type | String | Definición El tipo de disco. Rango N/D |
| size | Integer | Definición El tamaño del disco, en GiB. Rango N/D |
| volume_id | String | Definición El ID del disco. Rango N/D |
| name | String | Definición El nombre del disco. Rango N/D |
Código de estado: 400
| Parámetro | Tipo | Descripción |
|---|---|---|
| error | Error object | Definición El código de error devuelto si se produce un error. Para obtener más información sobre el código de error, consulte Códigos de error. Rango N/D |
| Parámetro | Tipo | Descripción |
|---|---|---|
| code | String | Definición El código de error devuelto si se produce un error. Rango Para obtener más información sobre el código de error, consulte Códigos de error. |
| message | String | Definición El mensaje de error devuelto si se produce un error. Rango N/D |
Ejemplos de solicitudes
GET https://{endpoint}/v1/{project_id}/jobs/{job_id}
https://{endpoint}/v1/{project_id}/jobs/{job_id} Ejemplos de respuestas
Código de estado: 200
OK
{
"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
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | OK |
| 400 | Bad Request |
Códigos de error
Consulte Códigos de error.