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/ TaurusDB/ Referência de API/ APIs (recomendadas)/ Central de tarefas/ Obtenção de informações sobre uma tarefa com um ID especificado
Atualizado em 2025-05-23 GMT+08:00
Ver PDF
Compartilhar

Obtenção de informações sobre uma tarefa com um ID especificado

Função

Essa API é usada para obter informações de tarefas da central de tarefas. Antes de chamar essa API:

Restrições

  • Essa API é usada para consultar tarefas assíncronas do último mês na central de tarefas.
  • Depois que um trabalho é gerado, leva vários segundos para consultar o ID do trabalho.

URI

GET /v3/{project_id}/jobs

Tabela 1 Parâmetros de URI

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

Explicação:

ID do projeto de um locatário numa região.

Para obter esse valor, consulte Obtenção de um ID de projeto.

Restrições:

Nenhuma

Intervalo de valores:

O valor pode conter 32 caracteres. Apenas letras e dígitos são permitidos.

Valor padrão:

Nenhum
Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

id

Sim

String

Explicação:

ID da tarefa.

Para obter esse valor, consulte Obtenção de tarefas instantâneas e Obtenção de tarefas agendadas.

Restrições:

Nenhuma

Intervalo de valores:

Nenhum

Valor padrão:

Nenhum

Parâmetros de solicitação

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

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Explicaçã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 valor do token.

Restrições:

Nenhuma

Intervalo de valores:

Nenhum

Valor padrão:

Nenhum

X-Language

Não

String

Explicação:

Tipo de linguagem da solicitação.

Restrições:

Nenhuma

Intervalo de valores:

  • en-us
  • zh-cn

Valor padrão:

en-us

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

job

GetJobInfoDetail object

Explicação:

Informações da tarefa.
Tabela 5 GetJobInfoDetail

Parâmetro

Tipo

Descrição

id

String

Explicação:

ID da tarefa.

Intervalo de valores:

O valor é o mesmo que o do parâmetro de entrada.

name

String

Explicação:

Nome da tarefa.

Intervalo de valores:

Nenhum

status

String

Explicação:

Status de execução da tarefa.

Intervalo de valores:

  • Pending: a tarefa está atrasada e não é executada.
  • Running: a tarefa está sendo executada.
  • Completed: a tarefa foi executada com sucesso.
  • Failed: a tarefa falhou ao ser executada.

created

String

Explicação:

Hora de criação. O formato é aaaa-mm-ddThh:mm:ssZ. T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

Intervalo de valores:

Nenhum

ended

String

Explicação:

Hora de término no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

Intervalo de valores:

Nenhum

process

String

Explicação:

Progresso da execução da tarefa.

Intervalo de valores:

O andamento da execução (como 60%) é exibido somente quando a tarefa está sendo executada. Caso contrário, "" é retornado.

instance

GetJobInstanceInfoDetail object

Explicação:

Informações de instância da tarefa com o ID especificado.

entities

Object

Explicação:

As informações exibidas variam de acordo com as tarefas.

fail_reason

String

Explicação:

Informações sobre falha de tarefa.

Intervalo de valores:

Nenhum
Tabela 6 GetJobInstanceInfoDetail

Parâmetro

Tipo

Descrição

id

String

Explicação:

ID da instância, que identifica exclusivamente uma instância.

Intervalo de valores:

O valor pode conter 36 caracteres com um sufixo de in07. Apenas letras e dígitos são permitidos.

name

String

Explicação:

Nome da instância.

Intervalo de valores:

O nome deve começar com uma letra e consistir de 4 a 64 caracteres. Somente letras (diferenciando maiúsculas de minúsculas), dígitos, hifens (-) e sublinhados (_) são permitidos.

Código de status: 400

Tabela 7 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 8 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitação

Obtenção de informações sobre uma tarefa com um ID especificado

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

Exemplo de resposta

Código de status: 200

No exemplo de resposta, algumas tarefas na central de tarefas são usadas como exemplos.

Bem-sucedido.

{
  "job" : {
    "id" : "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
    "name" : "CreateGaussDBforMySQLInstance",
    "status" : "Completed",
    "created" : "2018-08-06T10:41:14+0800",
    "ended" : "2018-08-06T16:41:14+0000",
    "process" : "",
    "instance" : {
      "id" : "a48e43ff268f4c0e879652d65e63d0fbin07",
      "name" : "DO-NOT-TOUCH-mgr2-mysql-single"
    },
    "entities" : {
      "instance" : {
        "endpoint" : "192.168.1.203:3306",
        "type" : "Cluster",
        "datastore" : {
          "type" : "gaussdb-mysql",
          "version" : "8.0"
        }
      },
      "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ]
    }
  }
}

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.

Tópico principal: Central de tarefas