Obtención de información acerca de una tarea con un ID especificado
Función
Esta API se utiliza para obtener información sobre una tarea con un ID especificado en el centro de tareas.
- Antes de invocar a una API, debe entender la API de Autenticación.
Restricciones
- Los trabajos de RDS son asincrónicos. Después de generar un trabajo, se tarda varios segundos en consultar el ID del trabajo.
- Esta API se utiliza para consultar solo tareas asincrónicas del último mes en el centro de tareas.
- Se puede obtener información de las siguientes tareas asincrónicas: crear una instancia de base de datos única o primaria/en espera, crear una réplica de lectura, eliminar una instancia de base de datos, cambiar una instancia de base de datos única a instancia de base de datos primaria/en espera, cambiar una instancia de base de datos primaria/en espera, escalar el espacio de almacenamiento, enlazar o desvincular un EIP, restaurar datos a una nueva instancia de base de datos, migrar una instancia de base de datos de RDS for MySQL, actualizar una versión secundaria de una instancia de base de datos de RDS for MySQL, restaurar datos de tabla a un punto de tiempo especificado para una instancia de base de datos de RDS for MySQL, y cambiar una clase de instancia.
URI
- 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.
id
Sí
Especifica el ID de la tarea.
Solicitud
Respuesta
- Respuesta normal
Tabla 2 Descripción de parámetro Nombre
Tipo
Descripción
job
Object
Indica la 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 trabajo Nombre
Tipo
Descripción
id
String
Indica el ID del trabajo.
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%") 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.
entities
Object
La información mostrada varía en función de las tareas.
Para obtener información detallada, consulte lo siguiente:
NOTA:Para las tareas asincrónicas sin la descripción del campo de entities, se devuelve {}.
fail_reason
String
Indica la información de error que se muestra cuando se produce un error en una tarea.
Tabla 4 descripción de la estructura de datos de campo de instancias 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 de campo de entidades (creación de instancias de base de datos, cambio de instancias de base de datos individuales a primaria/en espera o creación de réplicas de lectura) Nombre
Tipo
Descripción
instance
Object
Indica la información sobre la instancia de base de datos consultada.
Para obtener más información, consulte Tabla 6.
resource_ids
List<String>
Indica el ID del recurso consultado.
Tabla 6 descripción de estructura de datos de campo de entities.instance Nombre
Tipo
Descripción
endpoint
String
Indica la dirección de conexión de la instancia de base de datos.
type
String
El valor es Single, Ha, o Replica, que indica la instancia de base de datos única, las instancias de base de datos primarias/en espera, y réplica de lectura, respectivamente.
datastore
Object
Indica la información de la base de datos. Para obtener más información, véase Tabla 7.
replica_of
String
Indica el ID de instancia de base de datos principal. Este parámetro sólo se devuelve cuando se crea una réplica de lectura.
Tabla 7 descripción de la estructura de datos del campo de datastore Nombre
Tipo
Descripción
type
String
Indica el motor de base de datos.
version
String
Indica la versión de la base de datos.
Tabla 8 descripción de la estructura de entidades (cambiar el tamaño de una instancia de base de datos) Nombre
Tipo
Descripción
volume
Object
Indica la información sobre el disco cambiado de tamaño.
Para obtener más información, véase Tabla 9.
resource_ids
List<String>
Indica el ID del recurso consultado.
Tabla 9 descripción de la estructura de datos de campo de volumen Nombre
Tipo
Descripción
type
String
Indica el tipo de volumen.
original_size
String
Indica el tamaño del volumen original en GB.
target_size
String
Indica el tamaño del volumen de destino en GB.
Tabla 10 descripción de la estructura de datos de campo de entidades (vinculación/desvinculación de EIP o activación/desactivación del acceso remoto) Nombre
Tipo
Descripción
public_ip
String
Indica la EIP enlazada a la instancia de base de datos.
Tabla 11 descripción de la estructura de datos del campo de entidades (conmutación primaria/en espera) Nombre
Tipo
Descripción
switch_strategy
String
Indica la política de conmutación principal/en espera.
En el ejemplo de respuesta, algunas tareas del centro de tareas se utilizan como ejemplos.
- Ejemplo de respuesta normal
Creación de una instancia de base de datos:
{ "job": { "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", "name": "CreateMysqlSingleHAInstance", "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-mysql-single" }, "entities": { "instance": { "endpoint": "192.168.1.203:3306", "type": "Single", "datastore": { "type": "mysql", "version": "5.7" } }, "resource_ids": ["a48e43ff268f4c0e879652d65e63d0fbin01.vm", "a48e43ff268f4c0e879652d65e63d0fbin01.volume"] } } }
Creación de una réplica de lectura:{ "job": { "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", "name": " CreateMysqlReplicaInstance", "status": "Completed", "created": "2018-08-06T10:41:14+0000", "ended": "2018-08-06T16:41:14+0000", "process": "", "instance": { "id": "288caaa9d05f4ec1a1f58de2e0945685in01", "name": "mysql-replica" }, "entities": { "instance": { "endpoint": "192.168.1.203:3306", "type": "replica", "datastore": { "type": "mysql", "version": "5.7" }, "replica_of": "a48e43ff268f4c0e879652d65e63d0fbin01" }, "resource_ids": ["288caaa9d05f4ec1a1f58de2e0945685in01.vm", "288caaa9d05f4ec1a1f58de2e0945685in01.volume"] } } }
Vinculación de una EIP:{ "job": { "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", "name": "MysqlBindEIP", "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-mysql-single" }, "entities": { "public_ip": "10.10.10.1" } } }
Reinicio de una instancia de base de datos:{ "job": { "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886", "name": " RestartMysqlInstance", "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-mysql-single" }, "entities": {} } }
Tarea que se está ejecutando:{ "job": { "id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886", "name": "CreateMysqlSingleHAInstance"," status": "Running", "created": "2018-08-06T10:41:14+0000", "process": "60% ", "instance": { "id": "a48e43ff268f4c0e879652d65e63d0fbin01", "name": "DO-NOT-TOUCH-mgr2-mysql-single" }, "entities": { "instance": { "type": "Single", "datastore": { "type": "mysql", "version": "5.7" } } } } }
No se puede ejecutar la tarea:{ "job": { "id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886", "name": "CreateMysqlSingleHAInstance", "status": "Failed", "created": "2018-08-06T10:41:14+0000", "ended": "2018-08-06T16:41:14+0000", "process": "", "instance": { "id": "a48e43ff268f4c0e879652d65e63d0fbin01", "name": "DO-NOT-TOUCH-mgr2-mysql-single" }, "entities": { "instance": { "type": "Single", "datastore": { "type": "mysql", "version": "5.7" } } }, "fail_reason": "createVM failed." } }
{ "job": { "id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886", "name": "CreatePostgresqlSingleHAInstance", "status": "Failed", "created": "2018-08-06T10:41:14+0000", "ended": "2018-08-06T16:41:14+0000", "process": "", "instance": { "id": "a48e43ff268f4c0e879652d65e63d0fbin01", "name": "DO-NOT-TOUCH-mgr2-postgresql-single" }, "entities": { "instance": { "type": "Single", "datastore": { "type": "postgresql", "version": "9.6" } } }, "fail_reason": "createVM failed." } }
- 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.