Obtención de tareas programadas
Función
Esta API se utiliza para obtener las tareas programadas. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
GET /v3/{project_id}/scheduled-jobs
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
offset |
No |
String |
Desplazamiento de índice. La consulta comienza desde el primer dato. El valor predeterminado es 0. El valor debe ser un número y no puede ser un número negativo. |
|
limit |
No |
String |
Número de registros a consultar. El valor predeterminado es 10. |
|
status |
No |
String |
Estado de ejecución de tareas. Valores:
|
|
start_time |
No |
String |
Hora de inicio en el formato "yyyy-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. |
|
end_time |
No |
String |
Hora de finalización en el formato "yyyy-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. |
|
job_id |
No |
String |
ID de la tarea. |
|
job_name |
No |
String |
Tipo de programación de tareas. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. |
|
X-Language |
No |
String |
Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
schedules |
Array of ScheduleTask objects |
Detalles de la tarea. |
|
total_count |
Integer |
Número total de registros. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
job_id |
String |
ID de la tarea. |
|
instance_id |
String |
ID de instancia, que es compatible con el formato UUID. |
|
instance_name |
String |
Nombre de instancia. |
|
instance_status |
String |
Estado de la instancia. Valores:
|
|
project_id |
String |
ID de proyecto de un tenant en una región. |
|
job_name |
String |
Nombre de la tarea. Valores:
|
|
create_time |
String |
Hora de creación de la tarea en el formato "yyyy-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. |
|
start_time |
String |
Hora de inicio de la tarea en el formato "yyyy-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. |
|
end_time |
String |
Hora de finalización de la tarea en el formato "yyyy-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. |
|
job_status |
String |
Estado de ejecución de tareas. Valores:
|
|
datastore_type |
String |
Tipo de base de datos. |
|
target_config |
Object |
Información de configuración de instancia, como especificaciones. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de la solicitud
Obtención de tareas programadas
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/scheduled-jobs?offset=1&limit=10
Ejemplo de respuesta
Código de estado: 200
Operación exitosa.
{
"schedules" : [ {
"job_id" : "56d3c1138dcf4f1da73b0170700c78d0",
"instance_id" : "79bc540dd4d6432784894a981fdfacfcin07",
"instance_name" : "gauss-f821",
"instance_status" : "BUILD",
"project_id" : "053f533ead80d5102f0cc012e8d468a4",
"job_name" : "UpgradeGaussDBforMySQLDatabaseVersion",
"create_time" : "2018-08-06T10:41:14+0000",
"start_time" : "2018-08-06T10:41:14+0000",
"end_time" : "2018-08-06T10:41:14+0000",
"job_status" : "Completed",
"datastore_type" : "gaussdb-mysql",
"target_config" : {
"flavor" : "gaussdb.mysql.xlarge.arm.4",
"mem" : "16",
"cpu" : "4"
}
} ],
"total_count" : 1
}
Código de estado
Para más detalles, véase Códigos de estado.
Código de error
Para más detalles, véase Códigos de error.