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.
Atualizado em 2023-03-20 GMT+08:00

Consulta do status de tarefas

Função

Essa interface é usada para consultar o status de execução de uma tarefa, como criação do ECS, exclusão do ECS, operação em lote do ECS e operação da NIC.

Depois que uma tarefa, como criar um BMS ou anexar discos, é entregue, job_id é retornado, com base no qual você pode consultar o status de execução da tarefa.

URI

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

A Tabela 1 lista os parâmetros.

Tabela 1 Descrição do parâmetro

Parâmetro

Obrigatório

Descrição

project_id

Sim

Especifica o 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 da tarefa.

Solicitação

  • Parâmetros de solicitação

    Nenhum

  • Exemplo de solicitação
    1
    GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/jobs/2c9eb2c5544cbf6101544f0635672b60
    

Resposta

  • Parâmetros de resposta

    Parâmetro

    Tipo

    Descrição

    status

    String

    Especifica o status da tarefa.

    • SUCCESS: a tarefa é bem sucedida.
    • RUNNING: a tarefa está em execução.
    • FAIL: a tarefa falhou.
    • INIT: a tarefa está sendo inicializada.

    entities

    Object

    Especifica o objeto de tarefa. Para mais detalhes, consulte Tabela 2.

    As informações exibidas variam de acordo com o tipo de tarefa. Para operações relacionadas a BMSs, server_id é exibido. Para operações relacionadas a NICs, nic_id é exibido. Se existirem subtarefas, os detalhes sobre as subtarefas também serão exibidos.

    job_id

    String

    Especifica o ID da tarefa.

    job_type

    String

    Especifica o tipo de tarefa. O valor pode ser:

    • baremetalBatchCreate: criar BMSs em um lote
    • baremetalBatchOperate: alterar o status de energia de BMSs em um lote.
    • baremetalVolumeBootReinstallOs: reinstalar o SO de um BMS que é provisionado rapidamente
    • baremetalReinstallOs: reinstalar o sistema operacional de um BMS com discos locais
    • baremetalAttachVolume: anexar um disco
    • baremetalDetachVolume: desanexar um disco

    begin_time

    String

    Especifica a hora em que o trabalho foi iniciado.

    O formato de carimbo de data/hora é ISO 8601, por exemplo, 2019-04-25T20:04:47.591Z.

    end_time

    String

    Especifica a hora em que o trabalho terminou.

    O formato de carimbo de data/hora é ISO 8601, por exemplo, 2019-04-26T20:04:47.591Z.

    error_code

    String

    Especifica o código de erro retornado em caso de falha na execução de uma tarefa.

    fail_reason

    String

    Especifica a causa de uma falha na execução da tarefa.

    message

    String

    Especifica a mensagem retornada quando ocorre um erro.

    code

    String

    Especifica o código de erro retornado quando ocorre um erro.

    Para obter detalhes sobre códigos de erro, consulte a seção Códigos de status.

    Tabela 2 Descrição da estrutura de dados do campo entities

    Parâmetro

    Tipo

    Descrição

    sub_jobs_total

    Integer

    Especifica o número de subtarefas. Se a tarefa não tiver subtarefas, o valor deste parâmetro é 0.

    sub_jobs

    Array of objects

    Especifica as informações de execução sobre uma subtarefa. Se a tarefa não tiver subtarefas, o valor desse parâmetro será deixado em branco. Para mais detalhes, consulte Tabela 3.

    Tabela 3 Descrição da estrutura de dados do campo sub_jobs

    Parâmetro

    Tipo

    Descrição

    status

    String

    Especifica o status da tarefa.

    • SUCCESS: a tarefa é bem sucedida.
    • RUNNING: a tarefa está em execução.
    • FAIL: a tarefa falhou.
    • INIT: a tarefa está sendo inicializada.

    entities

    Array of objects

    Especifica o objeto de tarefa. As informações exibidas variam de acordo com o tipo de tarefa. Para operações relacionadas aos BMSs, server_id é exibido. Para operações relacionadas a NICs, nic_id é exibido.

    Para mais detalhes, consulte Tabela 4.

    job_id

    String

    Especifica a ID da tarefa.

    job_type

    String

    Especifica o tipo de tarefa. O valor pode ser:

    • baremetalSingleCreate: criar um único BMS
    • baremetalSingleOperate: alterar o status de energia de um único BMS

    begin_time

    String

    Especifica a hora em que o trabalho foi iniciado.

    O formato de carimbo de data/hora é ISO 8601, por exemplo, 2019-04-25T20:04:47.591Z.

    end_time

    String

    Especifica a hora em que o trabalho terminou.

    O formato de carimbo de data/hora é ISO 8601, por exemplo, 2019-04-26T20:04:47.591Z.

    error_code

    String

    Especifica o código de erro retornado em caso de falha na execução de uma tarefa.

    fail_reason

    String

    Especifica a causa de uma falha na execução da tarefa.

    message

    String

    Especifica a mensagem retornada quando ocorre um erro.

    code

    String

    Especifica o código de erro retornado quando ocorre um erro.

    Para obter detalhes sobre códigos de erro, consulte a seção Códigos de status.

    Tabela 4 Descrição da estrutura de dados do campo entities

    Parâmetro

    Tipo

    Descrição

    server_id

    String

    Se a tarefa for uma operação relacionada ao BMS, server_id será exibido.

    nic_id

    String

    Se a tarefa for uma operação relacionada à NIC, o valor será nic_id.

  • Exemplo de resposta
     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 retornados

Valores normais

Valores retornados

Descrição

200

A solicitação foi processada com sucesso.

Para obter detalhes sobre outros valores retornados, consulte Códigos de status.

Códigos de erro

Consulte Códigos de erro.