Obtención de información acerca de una tarea con un ID especificado
Función
Esta API se utiliza para obtener información de tareas del centro de tareas. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
Restricciones
- Esta API se utiliza para consultar tareas asincrónicas del último mes en el centro de tareas.
- Después de generar un trabajo, se tarda varios segundos en consultar el ID del trabajo.
URI
GET /v3/{project_id}/jobs
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Explicación: ID de proyecto de un tenant en una región. Para obtener este valor, vea Obtención de un ID de proyecto. Restricciones: Ninguna Rango de valor: El valor puede contener 32 caracteres. Solo se permiten letras y dígitos. Valor predeterminado: Ninguno |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
Sí |
String |
Explicación: ID de tarea. Para obtener este valor, consulte Obtención de tareas instantáneas y Obtención de tareas programadas. Restricciones: Ninguna Rango de valor: Ninguno Valor predeterminado: Ninguno |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Explicación: Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. Restricciones: Ninguna Rango de valor: Ninguna Valor predeterminado: Ninguna |
X-Language |
No |
String |
Explicación: Tipo de idioma de solicitud. Restricciones: Ninguna Rango de valor:
Valor predeterminado: en-us |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
job |
GetJobInfoDetail object |
Explicación: Información de la tarea. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Explicación: ID de tarea. Rango de valor: El valor es el mismo que el del parámetro de entrada. |
name |
String |
Explicación: Nombre de la tarea. Rango de valor: Ninguno |
status |
String |
Explicación: Estado de ejecución de tareas. Rango de valor:
|
created |
String |
Explicación: Tiempo de creación. El formato es 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, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. Rango de valor: Ninguno |
ended |
String |
Explicación: Hora de finalización en 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, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. Rango de valor: Ninguno |
process |
String |
Explicación: Progreso de la ejecución de tareas. Rango de valor: El progreso de la ejecución (como el 60%) solo se muestra cuando se está ejecutando la tarea. De lo contrario, se devuelve "". |
instance |
GetJobInstanceInfoDetail object |
Explicación: Información de instancia de la tarea con el ID especificado. |
entities |
Object |
Explicación: La información mostrada varía en función de las tareas. |
fail_reason |
String |
Explicación: Información de error de tarea. Rango de valor: Ninguno |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Explicación: ID de instancia, que identifica de forma única una instancia. Rango de valor: El valor puede contener 36 caracteres con el sufijo de in07. Solo se permiten letras y dígitos. |
name |
String |
Explicación: Nombre de instancia. Rango de valor: El nombre debe comenzar con una letra y debe contener entre 4 y 64 caracteres. Solo se permiten letras (distinguen mayúsculas de minúsculas), dígitos, guiones (-) y guiones bajos (_). |
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. |
Solicitud de ejemplo
Obtención de información acerca de una tarea con un ID especificado
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514
Ejemplo de la respuesta
Código de estado: 200

En el ejemplo de respuesta, algunas tareas del centro de tareas se utilizan como ejemplos.
Operación exitosa.
{ "job" : { "id" : "31b8ae23-c687-4d80-b7b4-42a66c9bb886", "name" : "CreateGaussDBforMySQLInstance", "status" : "Completed", "created" : "2018-08-06T10:41:14+0800", "ended" : "2018-08-06T16:41:14+0000", "process" : "", "instance" : { "id" : "a48e43ff268f4c0e879652d65e63d0fbin07", "name" : "DO-NOT-TOUCH-mgr2-mysql-single" }, "entities" : { "instance" : { "endpoint" : "192.168.1.203:3306", "type" : "Cluster", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" } }, "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ] } } }
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.