Consulta do status da tarefa
Função
Essa API é usada para consultar o status de execução de uma tarefa. Ela pode ser usada para consultar o status de execução de uma tarefa de criação de disco, expansão de capacidade ou exclusão.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v1/{project_id}/jobs/{job_id}
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| job_id | Sim | String | O ID da tarefa. |
| project_id | Sim | String | O ID do projeto. Para obter detalhes sobre como obter o ID de projeto, consulte Obtenção de um ID de projeto. |
Parâmetros de solicitação
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| X-Auth-Token | Sim | String | O token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. |
Parâmetros de resposta
Código de status: 200
| Parâmetro | Tipo | Descrição |
|---|---|---|
| status | String | O status da tarefa. SUCCESS: a tarefa foi bem sucedida. RUNNING: a tarefa está em andamento. FAIL: a tarefa falhou. INIT: a tarefa está sendo inicializada. Valores de enumeração:
|
| entities | JobEntities object | As informações de resposta à tarefa. |
| job_id | String | O ID da tarefa. |
| job_type | String | O tipo de tarefa.
|
| begin_time | String | A hora de início. |
| end_time | String | A hora de término. |
| error_code | String | O código de erro retornado se a execução da tarefa falhar. |
| fail_reason | String | A causa da falha na execução da tarefa. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| volume_type | String | O tipo de disco. |
| size | Integer | O tamanho do disco, em GiB. |
| volume_id | String | O ID do disco. |
| name | String | O nome do disco. |
| sub_jobs | Array of SubJob objects | As informações de uma subtarefa. Se houver uma subtarefa, outros campos em entities não serão retornados. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Estado | String | O status da subtarefa. SUCCESS: a tarefa foi bem sucedida. RUNNING: a tarefa está em andamento. FAIL: a tarefa falhou. INIT: a tarefa está sendo inicializada. Valores de enumeração:
|
| entities | SubJobEntities object | As informações de resposta da subtarefa. |
| job_id | String | O ID da subtarefa. |
| job_type | String | O tipo de subtarefa.
|
| begin_time | String | A hora de início. |
| end_time | String | A hora de término. |
| error_code | String | O código de erro retornado se a execução da subtarefa falhar. |
| fail_reason | String | A causa da falha na execução da subtarefa. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| volume_type | String | O tipo de disco. |
| size | Integer | O tamanho do disco, em GiB. |
| volume_id | String | O ID do disco. |
| name | String | O nome do disco. |
Código de status: 400
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error | Error object | A mensagem de erro retornada se ocorrer um erro. Para obter detalhes, consulte Parâmetros no campo error. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| code | String | O código de erro retornado se ocorrer um erro. Para os códigos de erro e seus significados, consulte Códigos de erro. |
| message | String | A mensagem de erro retornada se ocorrer um erro. |
Exemplo de solicitações
GET https://{endpoint}/v1/{project_id}/jobs/{job_id}
https://{endpoint}/v1/{project_id}/jobs/{job_id} Exemplo de respostas
Código de status: 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 status: 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
} Códigos de status
| Código de status | Descrição |
|---|---|
| 200 | OK |
| 400 | Bad Request |
Códigos de erro
Consulte Códigos de erro.
