Obtención de información de tareas de una instancia de base de datos de SQL Server especificada en un intervalo de tiempo especificado
Función
Esta API se utiliza para obtener la lista de información de tareas de un ID de instancia de base de datos de SQL Server especificado dentro de un intervalo de tiempo especificado.
- Antes de invocar a una API, debe entender la API de Autenticación.
Restricciones
- Esta API se utiliza para consultar tareas asincrónicas del último mes en el centro de tareas.
- Se puede obtener información de las siguientes tareas asincrónicas: creación de instancias de base de datos únicas o primarias/en espera, creación de réplicas de lectura, cambio de instancias de base de datos únicas a instancias primarias/en espera, conmutación de instancias de base de datos primarias/en espera, ampliación del espacio de almacenamiento, creación de copias de seguridad automatizadas o manuales, restaurar datos a instancias de base de datos originales, existentes o nuevas.
URI
- Formato de URI
GET /v3/{project_id}/instances/{instance_id}/tasklist/detail?start_time={start_time}&end_time={end_time}
- Descripción de parámetro
Tabla 1 Descripción de parámetro Nombre
Obligatorio
Descripción
project_id
Sí
Especifica el ID de proyecto de un tenant en una región.
Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
instance_id
Sí
Especifica el ID de instancia de base de datos.
start_time
Sí
Especifica la hora de inicio en el formato de marca de tiempo UTC.
end_time
No
Especifica la hora de finalización en el formato de marca de tiempo UTC.
Solicitud
Respuesta
- Respuesta normal
Tabla 2 Descripción de parámetro Nombre
Tipo
Descripción
jobs
Object
Indica la información de la tarea. Para obtener más información, consulte Tabla 3.
count
Integer
Indica el número total de tareas.
Tabla 3 descripción de la estructura de datos de campo de trabajos Nombre
Tipo
Descripción
id
String
Indica el ID de la tarea.
name
String
Indica el nombre de la tarea.
status
String
Indica el estado de ejecución de la tarea.
Valor:- Running: La tarea se está ejecutando.
- Completed: La tarea se ejecuta correctamente.
- Failed: No se puede ejecutar la tarea.
created
String
Indica la hora de creación en el formato "aaaa-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, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
ended
String
Indica la hora de finalización en el formato "aaaa-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, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.
process
String
Indica el progreso de la ejecución de la tarea.
NOTA:El progreso de la ejecución (como "60", lo que indica que el progreso de la ejecución de la tarea es del 60%) solo se muestra cuando se está ejecutando la tarea. De lo contrario, se devuelve "".
instance
Object
Indica la información de la instancia de base de datos en la que se ejecuta la tarea.
Para obtener más información, consulte Tabla 4.
task_detail
String
La información mostrada varía en función de las tareas.
Para obtener información detallada, consulte lo siguiente:
NOTA:Este campo no se muestra para las tareas asincrónicas que no contienen el campo task_detail.
fail_reason
String
Indica la información de error que se muestra cuando se produce un error en una tarea.
entities
Object
La información mostrada varía en función de las tareas.
Tabla 4 descripción de la estructura de datos de campo de instancia Nombre
Tipo
Descripción
id
String
Indica el ID de instancia de base de datos.
name
String
Indica el nombre de la instancia de base de datos.
Tabla 5 Descripción de la estructura de datos del campo Task_detail (restauración de datos en instancias de base de datos originales, existentes o nuevas, o restauración de datos a nivel de tabla en un punto de tiempo especificado) Nombre
Tipo
Descripción
sourceInstanceId
String
Indica el ID de la instancia de base de datos original en la que se restauran los datos de copia de respaldo.
targetInstanceId
String
Indica el ID de la instancia de base de datos de destino en la que se restauran los datos de copia de respaldo.
backupId
String
Indica el ID del archivo de copia de respaldo.
restoreTime
String
Indica el punto de tiempo en el que se restauran los datos a nivel de tabla.
type
String
Indica el tipo de tarea.
dbNames
List<String>
Indica el nombre de la base de datos.
Tabla 6 Descripción de la estructura de datos del campo task_detail (creación de copias de seguridad automáticas o manuales) Nombre
Tipo
Descripción
instanceId
String
Indica el ID de la instancia de base de datos que se va a realizar una copia de seguridad.
name
String
Indica el nombre de la tarea.
description
String
Indica la descripción de la tarea.
dbNames
String
Indica el nombre de los datos que se van a realizar una copia de respaldo.
En el ejemplo de respuesta, algunos detalles de la tarea devueltos se utilizan como ejemplos.
- Ejemplo de respuesta normal
Creación de copias de respaldo automatizadas o manuales:
{ "jobs": [ { "id": "aa4e3386-af27-436e-99f5-7cfefa21c37a", "name": "BackupDbSqlserverInInstance", "status": "Completed", "created": "2020-07-20T16:10:07+0000", "ended": "2020-07-20T16:14:39+0000", "process": "", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" }, "task_detail": "{\"instanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\",\"name\":\"sqlserver-rds-8d43-0004-20200719161130675\"}" } ], "count":1 }
Restauración de datos a instancias de base de datos originales, existentes o nuevas, o restaurar datos a nivel de tabla a un punto de tiempo especificado:{ "jobs": [ { "id": "11bef2cb-2924-4727-a9c2-b6fec61fc03a", "name": "SingleDbRestoreSqlserverInInstance", "status": "Failed", "created": "2020-07-21T01:38:00+0000", "ended": "2020-07-21T01:39:59+0000", "process": "", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" }, "task_detail": "{\"backupId\":\"83c76e6852c145779dc153d8299ee0e1br04\",\"dbNames\":\"backeeeeee\",\"sourceInstanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\",\"targetInstanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\"}" } ], "count":1 }
Otros tipos de tareas:{ "jobs":[ { "id":"11bef2cb-2924-4727-a9c2-b6fec61fc03a", "name":"SingleDbRestoreSqlserverInInstance", "status":"Complete", "created":"2020-07-21T01:38:00+0000", "ended":"2020-07-21T01:39:59+0000", "process":"", "instance":{ "id":"9a09052dfa824caea36f583bc3e5684ein04", "name":"rds-8d43-0004" } } ], "count":1 }
Tarea que se está ejecutando:{ "jobs":[ { "id": "32291a2e-882b-4266-b7c0-89dae34d2a9d", "name": "CreateSqlserverSingleHAInstance", "status": "Running", "created": "2020-07-14T15:02:29+0000", "ended": "2020-07-14T15:16:18+0000", "process": "50", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" } } ], "count":1 }
No se puede ejecutar la tarea:{ "jobs":[ { "id": "32291a2e-882b-4266-b7c0-89dae34d2a9d", "name": "CreateSqlserverSingleHAInstance", "status": "Failed", "created": "2020-07-14T15:02:29+0000", "ended": "2020-07-14T15:16:18+0000", "process": "", "instance": { "id": "9a09052dfa824caea36f583bc3e5684ein04", "name": "rds-8d43-0004" }, "fail_reason": "createVM failed." } ], "count":1 }
- Respuesta anormal
Para obtener más información, consulte Resultados de solicitud anormales.
Código de estado
- Normal
- Anormal
Para obtener más información, consulte Códigos de estado.
Código de error
Para obtener más información, consulte Códigos de error.