Listagem de tarefas em segundo plano
Função
Essa API é usada para listar tarefas em segundo plano.
URI
GET /v2/{project_id}/instances/{instance_id}/tasks
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. |
instance_id |
Sim |
String |
ID da instância. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
offset |
Não |
Integer |
Deslocamento, que é a posição onde a consulta começa. O valor deve ser superior ou igual a 0. |
limit |
Não |
Integer |
Número de itens exibidos em cada página. |
start_time |
Não |
String |
Hora de início da consulta (UTC). Formato: aaaaMMddHHmmss, por exemplo, 20200609160000. |
end_time |
Não |
String |
Hora final da consulta (UTC). Formato: aaaaMMddHHmmss, por exemplo, 20200617155959. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
task_count |
String |
Número de tarefas. |
tasks |
Array of SingleBackgroundTask objects |
Matriz de detalhes da tarefa. |
updated_at |
String |
Hora de término da tarefa, no formato 2020-06-17T07:38:42.503Z. |
created_at |
String |
Hora de início da tarefa, no formato 2020-06-17T07:38:42.503Z. |
status |
String |
Status da tarefa. Valores de enumeração:
|
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da tarefa em segundo plano. |
name |
String |
Nome da tarefa em segundo plano. As opções são as seguintes: ChangeInstanceSpec: modificação das especificações BindEip: Possibilitando o acesso público UnBindEip: desativação do acesso público AddReplica: adição de réplicas DelReplica: exclusão de réplicas **AddWhitelist**: configuring an IP whitelist **UpdatePort**: changing the port **RemoveIpFromDns**: removing IP addresses |
details |
DetailsBody object |
Detalhes. |
user_name |
String |
Nome de usuário. |
user_id |
String |
ID do usuário. |
params |
String |
Parâmetros da tarefa. |
status |
String |
Status da tarefa. |
created_at |
String |
Hora de início da tarefa, no formato 2020-06-17T07:38:42.503Z. |
updated_at |
String |
Hora de término da tarefa, no formato 2020-06-17T07:38:42.503Z. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
old_capacity |
String |
Capacidade antes da modificação. Este parâmetro tem um valor somente quando as especificações são modificadas. |
new_capacity |
String |
Capacidade após a modificação. Este parâmetro tem um valor somente quando as especificações são modificadas. |
enable_public_ip |
Boolean |
Se o acesso público está ativado. Este parâmetro tem um valor somente quando o acesso público está habilitado. |
public_ip_id |
String |
ID do endereço IP usado para acesso público. Este parâmetro tem um valor somente quando o acesso público está habilitado. |
public_ip_address |
String |
Endereço IP usado para acesso público. Este parâmetro tem um valor somente quando o acesso público está habilitado. |
enable_ssl |
Boolean |
Se o SSL está ativado. Esse parâmetro tem um valor somente quando o SSL está habilitado. |
old_cache_mode |
String |
Tipo de cache antes da modificação. Este parâmetro tem um valor somente quando as especificações são modificadas. |
new_cache_mode |
String |
Tipo de cache após a modificação. Este parâmetro tem um valor somente quando as especificações são modificadas. |
Código de estado: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 401
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 403
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 404
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Exemplos de solicitações
GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks?offset=0&limit=10&begin_time=20200609160000&end_time=20200617155959
Exemplo de respostas
Código de estado: 200
Tarefas em segundo plano listadas com sucesso.
{ "task_count" : 1, "tasks" : [ { "id" : "8abf6e1e72c12e7c0172c15b508500aa", "name" : "ChangeInstanceSpec", "user_name" : "paas_dcs_a00421997_02", "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7", "details" : { "old_cache_mode" : "single", "new_cache_mode" : "single", "old_capacity" : 0.125, "new_capacity" : 0.25 } } ], "status" : "SUCCESS", "created_at" : "2020-06-17T08:18:06.597Z", "updated_at" : "2020-06-17T08:18:10.106Z" }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Tarefas em segundo plano listadas com sucesso. |
400 |
Pedido inválido. |
401 |
Informações de autenticação inválidas. |
403 |
O pedido é rejeitado. |
404 |
O recurso solicitado não foi encontrado. |
500 |
Erro de serviço interno. |
Códigos de erro
Consulte Códigos de erro.