Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Elastic Cloud Server/ Referência de API/ As API (recomendado)/ Gerenciamento de status da tarefa/ Consulta do status de execução da tarefa

Atualizado em 2022-11-08 GMT+08:00

Consulta do status de execução da tarefa

Função

Essa API é usada para consultar o status de execução de uma tarefa de solicitação assíncrona.

Depois que uma tarefa de solicitação assíncrona é emitida, por exemplo, criar ou excluir um ECS, executar operações nos ECS em um lote ou executar operações nas NIC de ECS, uma ID de tarefa será retornada, com base na qual você pode consultar o status de execução da tarefa.

Para obter detalhes sobre como obter a ID da tarefa, consulte Respostas (Tarefa).

URI

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

Tabela 1 descreve os parâmetros no URI.

**Tabela 1** Descrição do parâmetro
Parâmetro	Obrigatório	Descrição
project_id	Sim	Especifica a ID do projeto. Para obter detalhes de como conseguir o ID de domínio, consulte Obtenção de um ID de projeto.
job_id	Sim	Especifica a ID de uma tarefa de solicitação assíncrona.

Solicitação

Nenhum

Resposta

Tabela 2 descreve os parâmetros de resposta.

**Tabela 2** Parâmetros de resposta
Parâmetro	Tipo	Descrição
status	String	Especifica o status da tarefa. SUCCESS: indica que a tarefa foi executada com sucesso. RUNNING: indica que a tarefa está em andamento. FAIL: indica que a tarefa falhou. INIT: indica que a tarefa está sendo inicializada. PENDING_PAYMENT: indica que um pedido anual/mensal deve ser pago. NOTA: O status PENDING_PAYMENT é exibido depois que a solicitação para criar um ECS anual/mensal ou modificar as especificações do ECS anual/mensal é enviada e antes que o pedido seja pago. Se o pedido for cancelado, o status não será atualizado automaticamente. A tarefa será automaticamente excluída 14 dias depois.
entities	Object	Especifica o objeto da tarefa. O valor desse parâmetro varia dependendo do tipo da tarefa. Se a tarefa for uma operação relacionada a ECS, o valor será server_id. Se a tarefa for uma operação NIC, o valor será nic_id. Se um subtrabalho estiver disponível, os detalhes sobre o subtrabalho serão exibidos. Para mais detalhes, consulte Tabela 3.
job_id	String	Especifica a ID de uma tarefa de solicitação assíncrona.
job_type	String	Especifica o tipo de uma tarefa de solicitação assíncrona.
begin_time	String	Especifica a hora em que a tarefa foi iniciada.
end_time	String	Especifica a hora em que a tarefa foi concluída.
error_code	String	Especifica o código de erro retornado quando a execução da tarefa falha. Depois que a tarefa é executada com sucesso, o valor deste parâmetro é nulo.
fail_reason	String	Especifica a causa da falha na execução da tarefa. Depois que a tarefa é executada com sucesso, o valor deste parâmetro é nulo.
message	String	Especifica a mensagem de erro devolvida quando ocorre um erro na solicitação para consultar uma tarefa.
code	String	Especifica o código de erro retornado quando ocorre um erro na solicitação para consultar uma tarefa. Para obter detalhes sobre código de erro, consulte Valores retornados para solicitações gerais.

**Tabela 3** descrição do campo **entities**
Parâmetro	Tipo	Descrição
sub_jobs_total	Integer	Especifica o número de subtarefas.
sub_jobs	Array of objects	Especifica as informações de execução de uma subtarefa. Para mais detalhes, consulte Tabela 4.

**Tabela 4** descrição do campo **sub_jobs**
Parâmetro	Tipo	Descrição
status	String	Especifica o status da tarefa. SUCCESS: indica que a tarefa foi executada com sucesso. RUNNING: indica que a tarefa está em andamento. FAIL: indica que a tarefa falhou. INIT: indica que a tarefa está sendo inicializada.
entities	Object	Especifica o objeto da tarefa. O valor desse parâmetro varia dependendo do tipo da tarefa. Se a tarefa for uma operação relacionada a ECS, o valor será server_id. Se a tarefa for uma operação NIC, o valor será nic_id. Para mais detalhes, consulte Tabela 5.
job_id	String	Especifica a ID da subtarefa.
job_type	String	Especifique o tipo de subtarefa.
begin_time	String	Especifica a hora em que a tarefa foi iniciada.
end_time	String	Especifica a hora em que a tarefa foi concluída.
error_code	String	Especifica o código de erro retornado quando a execução da tarefa falha. Depois que a tarefa é executada com sucesso, o valor deste parâmetro é null.
fail_reason	String	Especifica a causa da falha na execução da tarefa. Depois que a tarefa é executada com sucesso, o valor deste parâmetro é null.

**Tabela 5** descrição do campo **entities**
Parâmetro	Tipo	Descrição
server_id	String	Se a tarefa for uma operação relacionada a ECS, o valor será server_id.
nic_id	String	Se a tarefa for uma operação relacionada à NIC, o valor será nic_id.
errorcode_message	String	Indica a causa de uma falha de execução de subtarefa.

Exemplo de solicitação

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

Exemplo de resposta

{
    "status": "SUCCESS",
    "entities": {
        "sub_jobs_total": 1,
        "sub_jobs": [
            {
                "status": "SUCCESS",
                "entities": {
                    "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d"
                },
                "job_id": "2c9eb2c5544cbf6101544f0635672b60",
                "job_type": "createSingleServer",
                "begin_time": "2016-04-25T20:04:47.591Z",
                "end_time": "2016-04-25T20:08:21.328Z",
                "error_code": null,
                "fail_reason": null
            }
        ]
    },
    "job_id": "2c9eb2c5544cbf6101544f0602af2b4f",
    "job_type": "createServer",
    "begin_time": "2016-04-25T20:04:34.604Z",
    "end_time": "2016-04-25T20:08:41.593Z",
    "error_code": null,
    "fail_reason": null
}