Consulta de estado de tarea

Función

Esta API se utiliza para consultar el estado de ejecución de las tareas, como el estado de creación de disco, expansión de capacidad y eliminación.

URI

• Formato URI

  GET /v1/{project_id}/jobs/{job_id}

• Descripción del parámetro

  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

En el ejemplo siguiente se muestra cómo consultar el estado de la tarea cuyo ID de tarea es ff808081692a62c70169b4dcf9514264.

• Solicitud de ejemplo

   GET https://{endpoint}/v1/{project_id}/jobs/ff808081692a62c70169b4dcf9514264

Respuesta

• Descripción del parámetro

  Parámetro	Tipo	Descripción
  status	String	Especifica el estado de la tarea. SUCCESS: La tarea se ejecuta correctamente. RUNNING: La tarea está en progreso. FAIL: La tarea falla. INIT: La tarea se está inicializando.
  entities	Object	Especifica la respuesta a la tarea. Para obtener más información, consulte •Parámetros en el campo de Entidades. El contenido de cada tipo de tarea es diferente.
  job_id	String	Especifica el ID de la tarea.
  job_type	String	Especifica el tipo de tarea. createVolume: crea un disco. batchCreateVolume: lote crea discos. deleteVolume: elimina un disco. extendVolume: expande la capacidad del disco. bulkDeleteVolume: el lote elimina los discos. deleteSingleVolume: elimina los discos uno por uno durante una eliminación por lotes.
  begin_time	String	Especifica la hora en que se inició la tarea. Formato de tiempo: AAAA-MM-DDTHH:MM:SS.SSS'Z'
  end_time	String	Especifica la hora en que terminó la tarea. Formato de tiempo: AAAA-MM-DDTHH:MM:SS.SSS'Z'
  error_code	String	Especifica el código de error devuelto cuando se produce un error en la ejecución de la tarea.
  fail_reason	String	Especifica la causa del error de ejecución de la tarea.
  error	Object	Especifica el mensaje de error devuelto cuando se produce un error. Para obtener más información, consulte Parámetros en el campo de error.

• Parámetro en el campo de entities

  Parámetro	Tipo	Descripción
  name	String	Especifica el nombre del disco EVS.
  size	Integer	Especifica el tamaño del disco, en GB.
  sub_jobs	Array of Objects	Especifica la información sobre un subtrabajo. Para obtener más información, consulte•Parámetros en el campo sub_jobs.
  volume_id	String	Especifica el ID de disco.
  volume_type	String	Especifica el tipo de disco.

• Parámetros en el campo sub_jobs

  Parámetro	Tipo	Descripción
  status	String	Especifica el estado de la tarea. SUCCESS: La tarea se ejecuta correctamente. RUNNING: La tarea está en progreso. FAIL: La tarea falla. INIT: La tarea se está inicializando.
  entities	Object	Especifica la respuesta a la tarea. Para obtener más información, consulte Parámetros en el campo de Entidades. El contenido de cada tipo de tarea es diferente.
  job_id	String	Especifica el ID de la tarea.
  job_type	String	Especifica el tipo de tarea. createVolume: crea un disco. batchCreateVolume: lote crea discos. deleteVolume: elimina un disco. extendVolume: expande la capacidad del disco. bulkDeleteVolume: el lote elimina los discos. deleteSingleVolume: elimina los discos uno por uno durante una eliminación por lotes.
  begin_time	String	Especifica la hora en que se inició la tarea. Formato de tiempo: AAAA-MM-DDTHH:MM:SS.SSS'Z'
  end_time	String	Especifica la hora en que terminó la tarea. Formato de tiempo: AAAA-MM-DDTHH:MM:SS.SSS'Z'
  error_code	String	Especifica el código de error devuelto cuando se produce un error en la ejecución de la tarea.
  fail_reason	String	Especifica la causa del error de ejecución de la tarea.

• Parámetro en el campo de entities

  Parámetro	Tipo	Descripción
  name	String	Especifica el nombre del disco EVS.
  size	Integer	Especifica el tamaño del disco, en GB.
  volume_id	String	Especifica el ID de disco.
  volume_type	String	Specifies the disk type.

• Parámetros en el campo de error

  Parámetro	Tipo	Descripción
  message	String	Especifica el mensaje de error 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 el código de error, consulte Códigos de error.

• Ejemplo de respuesta

  {
      "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": "", 
      "error_code": null, 
      "fail_reason": null
  }

  o

  {
      "status": "SUCCESS", 
      "entities": {
          "sub_jobs": [
              {
                  "status": "SUCCESS", 
                  "entities": {
                      "volume_id": "0b549095-4937-4849-8e4c-52aa027d64f7"
                  }, 
                  "job_id": "21917a8d52a19b040152a9f2f2e50041", 
                  "job_type": "createVolume", 
                  "begin_time": "2016-02-04T01:43:37.445Z", 
                  "end_time": "2016-02-04T01:44:02.239Z", 
                  "error_code": null, 
                  "fail_reason": null
              }, 
              {
                  "status": "SUCCESS", 
                  "entities": {
                      "volume_id": "e7bca1a2-d3ed-434f-86f4-a1f11aa80072"
                  }, 
                  "job_id": "21917a8d52a19b040152a9f2f2f60042", 
                  "job_type": "createVolume", 
                  "begin_time": "2016-02-04T01:43:37.462Z", 
                  "end_time": "2016-02-04T01:44:02.245Z", 
                  "error_code": null, 
                  "fail_reason": null
              }
          ]
      }, 
      "job_id": "21917a8d52a19b040152a9f2f1eb003e", 
      "job_type": "batchCreateVolume", 
      "begin_time": "2016-02-04T01:43:37.193Z", 
      "end_time": "2016-02-04T01:44:08.283Z", 
      "error_code": null, 
      "fail_reason": null
  }

  o

  {
      "error": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

Códigos de estado

• Normal

  200

Códigos de error

Para más detalles, consulte Códigos de error.