Obtenção de tarefas instantâneas
Função
Essa API é usada para obter as tarefas instantâneas. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/immediate-jobs
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
status |
Não |
String |
Status de execução da tarefa. Valor:
|
job_name |
Não |
String |
Nome da tarefa. Valor: Valor:
|
job_id |
Não |
String |
ID da tarefa. |
offset |
Não |
String |
Deslocamento do índice. A consulta começa a partir da primeira parte dos dados. O valor padrão é 1. O valor deve ser um número e não pode ser um número negativo. |
limit |
Não |
String |
Número de registros a serem consultados. Valor: 10 (valor padrão), 20 ou 50. |
start_time |
Não |
String |
Hora de início 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. |
end_time |
Não |
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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. |
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 |
---|---|---|
jobs |
Array of TaskDetailInfo objects |
Detalhes da tarefa. |
total_count |
Integer |
Número total de tarefas. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
instance_id |
String |
ID da instância. |
instance_name |
String |
Nome da instância. |
instance_status |
String |
Status da instância. Valor:
|
job_id |
String |
ID da tarefa. |
order_id |
String |
ID do pedido. |
job_name |
String |
Nome da tarefa. Valor:
|
status |
String |
Status de execução da tarefa. Valor:
|
process |
String |
Progresso da tarefa. |
created_time |
String |
Hora de criação da tarefa 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. |
ended_time |
String |
Hora de término da tarefa 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. |
fail_reason |
String |
Causa da falha da tarefa. |
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 das tarefas instantâneas
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/immediate-jobs
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "jobs" : [ { "instance_id" : "ede953923f06448d9be8686ef0c1378ein07", "instance_name" : "gauss-1234", "instance_status" : "deleted", "job_id" : "7155730b-a60b-4dc0-9f89-3f55897f29d6", "order_id" : "", "job_name" : "CloseGaussDBforMySQLProxy", "status" : "Completed", "process" : "", "created_time" : "2018-08-06T10:41:14+0000", "ended_time" : "2018-08-06T12:41:14+0000", "fail_reason" : "Single task exception." } ], "total_count" : 1 }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.