Obtención de información acerca de una tarea
Función
Esta API se utiliza para obtener información de tareas del centro de tareas. Antes de invocar a esta API:
Esta API no estará disponible el 31 de marzo de 2024. Se recomienda cambiar las cargas de trabajo a la nueva API (Obtención de información acerca de una tarea con un ID especificado) antes de esa fecha.
- Aprender cómo autorizar y autenticarla.
- Obtener los región y punto de conexión requeridos.
URI
- Formato de URI
- Ejemplo
GET https://{endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514
- Descripción de parámetro
Tabla 1 Descripción de parámetro Nombre
Obligatorio
Descripción
project_id
Sí
ID de proyecto de un tenant en una región.
Para obtener este valor, consulte Obtención de un ID de proyecto.
id
Sí
ID de tarea.
Solicitud
Ninguna
Respuesta
- Respuesta normal
Tabla 2 Descripción de parámetro Nombre
Tipo
Descripción
job
Object
Información de la tarea. Para obtener más información, consulte Tabla 3.
Tabla 3 descripción de la estructura de datos del campo de job Nombre
Tipo
Descripción
id
String
ID de tarea.
name
String
Nombre de la tarea.
status
String
Estado de ejecución de tareas.
Valores válidos:- Running: La tarea se está ejecutando.
- Completed: La tarea se ejecuta correctamente.
- Failed: No se puede ejecutar la tarea.
created
String
Tiempo de creació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, en la zona horaria de Beijing, el desplazamiento de la zona horaria se muestra como +0800.
ended
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, en la zona horaria de Beijing, el desplazamiento de la zona horaria se muestra como +0800.
process
String
Progreso de la ejecución de tareas.
instance
Object
instancia de base de datos en la que se ejecuta la tarea.
Para obtener más información, consulte Tabla 4.
entities
Object
La información mostrada varía en función de las tareas.
Para obtener más información, consulte Tabla 5.
fail_reason
String
Información de error de tarea.
Tabla 4 descripción de la estructura de datos de campo de instancias Nombre
Tipo
Descripción
id
String
ID de instancia de base de datos.
name
String
Nombre de instancia de base de datos.
Tabla 5 descripción de la estructura de datos de campo de entidades Nombre
Tipo
Descripción
instance
Object
Instancia de base de datos consultada en la tarea.
Para obtener más información, consulte Tabla 6.
resource_ids
List<String>
ID de recurso involucrado en una tarea.
Tabla 6 descripción de estructura de datos de campo de entities.instance Nombre
Tipo
Descripción
endpoint
String
Dirección de conexión de instancia de base de datos.
type
String
Tipo de instancia de base de datos.
datastore
Object
Información de la base de datos. Para obtener más información, consulte Tabla 7.
Tabla 7 descripción de la estructura de datos del campo del almacén de datos Nombre
Tipo
Descripción
type
String
Motor de base de datos.
version
String
Versión de base de datos.
Tabla 8 descripción de la estructura de datos de campo de entidades (vinculación o desvinculación de una EIP) Nombre
Tipo
Descripción
public_ip
String
EIP utilizado en la tarea.
En el ejemplo de respuesta, algunas tareas del centro de tareas se utilizan como ejemplos.
- Ejemplo de respuesta normal
{ "job": { "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", "name": " RestartGaussDBInstance", "status": "Completed", "created": "2018-08-06T10:41:14+0000", "ended": "2018-08-06T16:41:14+0000", "process": "", "instance": { "id": "a48e43ff268f4c0e879652d65e63d0fbin01", "name": "DO-NOT-TOUCH-mgr2-gaussdb" }, "entities": {} } }
Código de estado
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.