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:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
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
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário em uma região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Sim |
String |
ID da tarefa. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Se o corpo de resposta a seguir for retornado para chamar a API usada para obter um token de usuário, a solicitação será bem-sucedida. Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token. |
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valor:
|
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
job |
GetJobInfoDetail object |
Informações da tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da tarefa. |
name |
String |
Nome da tarefa. |
status |
String |
Status de execução da tarefa. Valor:
|
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.
NOTA:
O valor fica vazio quando a instância de banco de dados está sendo criada. Depois que a instância de banco de dados é criada, o valor não está vazio. |
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.
NOTA:
O valor fica vazio quando a instância de banco de dados está sendo criada. Depois que a instância de banco de dados é criada, o valor não está vazio. |
process |
String |
Progresso da execução da tarefa. O andamento da execução (como 60%) é exibido somente quando a tarefa está sendo executada. Caso contrário, "" é retornado. |
instance |
GetJobInstanceInfoDetail object |
Informações de instância da tarefa com o ID especificado. |
entities |
Object |
As informações exibidas variam de acordo com as tarefas. |
fail_reason |
String |
Informações sobre falha de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da instância. |
name |
String |
Nome da instância. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
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.