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/Cloud Container Engine/Referência de API/APIs/Gerenciamento de cluster/Consulta de uma tarefa
Atualizado em 2024-09-10 GMT+08:00
Ver PDF
Compartilhar

Consulta de uma tarefa

Função

Essa API é usada para obter informações sobre uma tarefa por meio do ID da tarefa retornado após a entrega de uma solicitação de consulta.

  • O URL para gerenciamento de cluster está no formato https://Endpoint/uri. No URL, uri indica o caminho do recurso, ou seja, o caminho para o acesso à API.

  • Você pode chamar essa API quando:

    • Criando ou excluindo um cluster

    • Criando ou excluindo um nó

URI

GET /api/v3/projects/{project_id}/jobs/{job_id}

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto. Para obter detalhes sobre como obter o valor, consulte Como obter parâmetros no URI da API.

job_id

Sim

String

ID da tarefa. Para obter detalhes sobre como obter o valor, consulte Como obter parâmetros no URI da API.

Parâmetros de solicitação

Tabela 2 Parâmetros de cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

Content-Type

Sim

String

Tipo de corpo da mensagem (formato).

X-Auth-Token

Sim

String

As solicitações para chamar uma API podem ser autenticadas usando um token ou AK/SK. Se a autenticação baseada em token for usada, esse parâmetro é obrigatório e deve ser definido como um token de usuário. Para obter detalhes, consulte Obtenção de um token de usuário.

Parâmetros de resposta

Código de status: 200

Tabela 3 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

kind

String

Tipo de API. O valor é fixado em Job e não pode ser alterado.

apiVersion

String

Versão da API. O valor é fixado em v3 e não pode ser alterado.

metadata

JobMetadata object

Metadados da tarefa

spec

JobSpec object

Parâmetros detalhados da tarefa

status

JobStatus object

Status da tarefa

Tabela 4 JobSpec

Parâmetro

Tipo

Descrição

type

String

Tipo da tarefa. Um exemplo de valor é CreateCluster.

clusterUID

String

ID do cluster em que a tarefa é executada.

resourceID

String

ID do recurso no qual a tarefa é executada.

resourceName

String

Nome do recurso no qual a tarefa é executada.

extendParam

Map<String,String>

Parâmetros estendidos

subJobs

Array of Job objects

Lista de sub-tarefas.

  • A lista contém detalhes sobre todas as sub-tarefas.

  • Geralmente, uma tarefa de criação de cluster/nó consiste em várias sub-tarefas. A tarefa é concluída somente depois que todas as sub-tarefas são concluídas.

Tabela 5 Job

Parâmetro

Tipo

Descrição

kind

String

Tipo de API. O valor é fixado em Job e não pode ser alterado.

apiVersion

String

Versão da API. O valor é fixado em v3 e não pode ser alterado.

metadata

JobMetadata object

Metadados da tarefa

spec

JobSpec object

Parâmetros detalhados da tarefa

status

JobStatus object

Status da tarefa

Tabela 6 JobMetadata

Parâmetro

Tipo

Descrição

uid

String

ID da tarefa

creationTimestamp

String

Hora em que a tarefa foi criada

updateTimestamp

String

Hora em que a tarefa foi atualizada

Tabela 7 JobStatus

Parâmetro

Tipo

Descrição

phase

String

Status da tarefa. Valores possíveis:

  • JobPhaseInitializing JobPhase ="Initializing"

  • JobPhaseRunning JobPhase ="Running"

  • JobPhaseFailed JobPhase ="Failed"

  • JobPhaseSuccess JobPhase ="Success"

reason

String

Razão pela qual a tarefa está no estado atual.

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

O progresso da tarefa especificada é obtido com sucesso.

{
  "kind" : "Job",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "354331b2c-229a-11e8-9c75-0255ac100ceb",
    "creationTimestamp" : "2018-08-02 08:12:40.672772389 +0000 UTC",
    "updateTimestamp" : "2018-08-02 08:21:50.478108569 +0000 UTC"
  },
  "spec" : {
    "type" : "CreateCluster",
    "clusterUID" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
    "resourceID" : "6f4dcb2c-229a-11e8-9c75-0255ac100ceb",
    "resourceName" : "cluster-name",
    "extendParam" : {
      "serverID" : "bc467e3a-2338-11e8-825b-0255ac100c13"
    },
    "subJobs" : [ {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "fd474fab-9606-11e8-baa9-0255ac10215d",
        "creationTimestamp" : "2018-08-02 03:52:34.615819618 +0000 UTC",
        "updateTimestamp" : "2018-08-02 04:05:29.196243031 +0000 UTC"
      },
      "spec" : {
        "type" : "InstallMaster",
        "clusterUID" : "fcc72de0-9606-11e8-baa8-0255ac10215d",
        "resourceID" : "fd3b4ac0-9606-11e8-baa8-0255ac10215d",
        "extendParam" : {
          "serverID" : "fd3b4ac0-9606-11e8-baa8-0255ac10215d"
        }
      },
      "status" : {
        "phase" : "Success"
      }
    }, {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "fd474f82-9606-11e8-baa8-0255ac10215d",
        "creationTimestamp" : "2018-08-02 03:52:33.859150791 +0000 UTC",
        "updateTimestamp" : "2018-08-02 03:52:34.615655429 +0000 UTC"
      },
      "spec" : {
        "type" : "CreatePSMCert",
        "clusterUID" : "fcc72de0-9606-11e8-baa8-0255ac10215d"
      },
      "status" : {
        "phase" : "Success"
      }
    } ]
  },
  "status" : {
    "phase" : "Running",
    "reason" : ""
  }
}

Códigos de status

Código de status

Descrição

200

O progresso da tarefa especificada é obtido com sucesso.

Códigos de erro

Consulte Códigos de erro.

Tópico principal:Gerenciamento de cluster