Obtenção de informações sobre uma tarefa

Função

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

Essa API estará indisponível em 31 de março de 2024. É aconselhável mudar as cargas de trabalho para a nova API (Obtenção de informações sobre uma tarefa com um ID especificado) antes disso.

• Saiba como autorizá-la e autenticá-la.
• Obtenha a região e o ponto de extremidade necessários.

URI

• Formato de URI

  GET https://{endpoint}/mysql/v3/{project_id}/jobs?id={id}

• Exemplo

  GET https://{endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

• Descrição do parâmetro

  Tabela 1 Descrição do parâmetro

  Nome	Obrigatório	Descrição
  project_id	Sim	ID do projeto de um locatário em uma região. Para obter esse valor, consulte Obtenção de um ID de projeto.
  id	Sim	ID da tarefa.

Solicitação

Nenhuma

Resposta

• Resposta normal

  Tabela 2 Descrição do parâmetro

  Nome	Tipo	Descrição
  job	Object	Informações da tarefa. Para mais detalhes, consulte Tabela 3.

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

  Nome	Tipo	Descrição
  id	String	ID da tarefa.
  name	String	Nome da tarefa.
  status	String	Status de execução da tarefa. Valor válido: Running: a tarefa está sendo executada. Completed: a tarefa foi executada com sucesso. Failed: a tarefa falha ao ser executada.
  created	String	Tempo de criação 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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
  ended	String	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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
  process	String	Progresso da execução da tarefa.
  instance	Object	Instância de banco de dados na qual a tarefa é executada. Para mais detalhes, consulte Tabela 4.
  entities	Object	As informações exibidas variam de acordo com as tarefas. Para mais detalhes, consulte Tabela 5.
  fail_reason	String	Informações sobre falha de tarefa.

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

  Nome	Tipo	Descrição
  id	String	ID da instância de BD.
  name	String	Nome da instância de BD.

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

  Nome	Tipo	Descrição
  instance	Object	Instância de banco de dados consultada na tarefa. Para mais detalhes, consulte Tabela 6.
  resource_ids	List<String>	ID do recurso envolvido numa tarefa.

  Tabela 6 Descrição da estrutura de dados do campo entities.instance

  Nome	Tipo	Descrição
  endpoint	String	Endereço de conexão da instância de banco de dados.
  type	String	Tipo de instância de BD.
  datastore	Object	Informações de BD. Para mais detalhes, consulte Tabela 7.

  Tabela 7 Descrição da estrutura de dados do campo datastore

  Nome	Tipo	Descrição
  type	String	Mecanismo de BD.
  version	String	Versão de BD.

  Tabela 8 Descrição da estrutura de dados do campo entities (vinculação ou desvinculação de um EIP)

  Nome	Tipo	Descrição
  public_ip	String	EIP usado na tarefa.

  

  No exemplo de resposta, algumas tarefas no centro de tarefas são usadas como exemplos.

• Exemplo de resposta normal

  {
    "job": {
      "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
      "name": " RestartGaussDBInstance",
      "status": "Completed",
      "created": "2018-08-06T10:41:14+0000",
      "ended": "2018-08-06T16:41:14+0000",
      "process": "",
      "instance": {
        "id": "a48e43ff268f4c0e879652d65e63d0fbin01",
        "name": "DO-NOT-TOUCH-mgr2-gaussdb"
      },
      "entities": {}
      }
  }

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.