ListDBTaskSQLJob - Data Management - Centro de documentación de Alibaba Cloud

Consulta una lista de tareas SQL.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dms:ListDBTaskSQLJob

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBTaskGroupId	integer	Sí	El ID del grupo de tareas SQL. Puede llamar a la operación GetStructSyncJobDetail para obtener este parámetro.	132****
PageNumber	integer	No	El número de la página a devolver.	1
PageSize	integer	No	El número de entradas a devolver en cada página.	20
Tid	integer	No	El ID del inquilino. Nota : Para ver el ID del inquilino, inicie sesión en la consola de Data Management (DMS) y pase el puntero sobre la imagen de perfil en la esquina superior derecha. Para obtener más información, consulte Gestionar inquilinos de DMS.	1***

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	F6C47680-8D2D-43A4-8902-F2740D71A398
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
DBTaskSQLJobList	array<object>	La lista de las tareas SQL.
	object	La tarea SQL.
JobId	integer	El ID de la tarea SQL.	12****
JobType	string	El tipo de la tarea SQL.	STRUCT_SYNC
Comment	string	La descripción de la tarea SQL.	test
DbSearchName	string	El nombre que se utiliza para buscar la base de datos.	test@xxx:3306[test]
DbId	integer	El ID de la base de datos.	43214523
Logic	boolean	Indica si la base de datos es una base de datos lógica. Valores válidos: true: La base de datos es una base de datos lógica. false: La base de datos es una base de datos lógica.	false
CreateTime	string	La hora en que se creó la tarea SQL.	2021-02-18 17:49:20
LastExecTime	string	La hora en que se ejecutó por última vez la tarea SQL.	2021-02-18 17:49:31
DbTaskGroupId	integer	El ID del grupo de tareas SQL.	432****
Status	string	El estado de la tarea SQL. Valores válidos: INIT: La tarea SQL se inicializó. PENDING: La tarea SQL estaba en espera de ejecución. BE_SCHEDULED: La tarea SQL estaba en espera de programación. FAIL: La tarea SQL falló. SUCCESS: La tarea SQL se completó correctamente. PAUSE: La tarea SQL se pausó. DELETE: La tarea SQL se eliminó. RUNNING: La tarea SQL se estaba ejecutando.	SUCCESS
Transactional	boolean	Indica si la tarea SQL se ejecuta como una transacción. Valores válidos: true: La tarea SQL se ejecuta como una transacción. false: La tarea SQL no se ejecuta como una transacción.	false
TotalCount	integer	El número total de tareas SQL.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "F6C47680-8D2D-43A4-8902-F2740D71A398",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DBTaskSQLJobList": [
    {
      "JobId": 0,
      "JobType": "STRUCT_SYNC",
      "Comment": "test",
      "DbSearchName": "test@xxx:3306[test]",
      "DbId": 43214523,
      "Logic": false,
      "CreateTime": "2021-02-18 17:49:20",
      "LastExecTime": "2021-02-18 17:49:31",
      "DbTaskGroupId": 0,
      "Status": "SUCCESS",
      "Transactional": false
    }
  ],
  "TotalCount": 1
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.