Listado de tareas en segundo plano
Función
Esta API se utiliza para enumerar tareas en segundo plano.
Identificador de recursos uniforme (URI)
GET /v2/{project_id}/instances/{instance_id}/tasks
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. |
instance_id |
Sí |
String |
ID de instancia. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
offset |
No |
Integer |
offset, que es la posición en la que comienza la consulta. El valor debe ser mayor o igual a 0. |
limit |
No |
Integer |
Número de elementos mostrados en cada página. |
start_time |
No |
String |
Consultar hora de inicio (UTC). Formato: aaaaMMddHHmmss, por ejemplo, 20200609160000. |
end_time |
No |
String |
Consultar hora de finalización (UTC). Formato: aaaaMMddHHmmss, por ejemplo, 20200617155959. |
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
task_count |
String |
Número de tareas. |
tasks |
Array of SingleBackgroundTask objects |
Matriz de detalles de la tarea. |
updated_at |
String |
Hora de finalización de la tarea, en el formato 2020-06-17T07:38:42.503Z. |
created_at |
String |
Hora de inicio de la tarea, en el formato 2020-06-17T07:38:42.503Z. |
status |
String |
Estado de la tarea. Valores de enumeración:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de tarea en segundo plano. |
name |
String |
Nombre de tarea en segundo plano. Las opciones son las siguientes: ChangeInstanceSpec: modificación de las especificaciones BindEip para permitir el acceso público UnBindEip: desactivación del acceso público AddReplica: adición de réplicas DelReplica: eliminación de réplicas **AddWhitelist**: configuring an IP whitelist **UpdatePort**: changing the port **RemoveIpFromDns**: removing IP addresses |
details |
DetailsBody object |
Detalles. |
user_name |
String |
Nombre de usuario. |
user_id |
String |
ID de usuario. |
params |
String |
Parámetros de tarea. |
status |
String |
Estado de la tarea. |
created_at |
String |
Hora de inicio de la tarea, en el formato 2020-06-17T07:38:42.503Z. |
updated_at |
String |
Hora de finalización de la tarea, en el formato 2020-06-17T07:38:42.503Z. |
Parámetro |
Tipo |
Descripción |
---|---|---|
old_capacity |
String |
Capacidad antes de la modificación. Este parámetro sólo tiene un valor cuando se modifican las especificaciones. |
new_capacity |
String |
Capacidad después de la modificación. Este parámetro sólo tiene un valor cuando se modifican las especificaciones. |
enable_public_ip |
Boolean |
Si el acceso público está habilitado. Este parámetro sólo tiene un valor cuando el acceso público está habilitado. |
public_ip_id |
String |
ID de la dirección IP utilizada para el acceso público. Este parámetro sólo tiene un valor cuando el acceso público está habilitado. |
public_ip_address |
String |
Dirección IP utilizada para el acceso público. Este parámetro sólo tiene un valor cuando el acceso público está habilitado. |
enable_ssl |
Boolean |
Si SSL está habilitado. Este parámetro tiene un valor solo cuando SSL está habilitado. |
old_cache_mode |
String |
Tipo de caché antes de la modificación. Este parámetro sólo tiene un valor cuando se modifican las especificaciones. |
new_cache_mode |
String |
Tipo de caché después de la modificación. Este parámetro sólo tiene un valor cuando se modifican las especificaciones. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 404
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Solicitudes de ejemplo
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
Ejemplo de respuestas
Código de estado: 200
Tareas en segundo plano listadas correctamente.
{ "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 estado
Código de estado |
Descripción |
---|---|
200 |
Tareas en segundo plano listadas correctamente. |
400 |
Solicitud no válida. |
401 |
Información de autenticación no válida. |
403 |
La solicitud se rechaza. |
404 |
La página solicitada no se encuentra. |
500 |
Error interno del servicio. |
Códigos de error
Consulte Códigos de error.