ListDataQualityEvaluationTaskInstances - DataWorks - Centro de documentación de Alibaba Cloud

Realiza una consulta paginada de la lista de instancias de tareas de monitoreo de calidad.

Nota

Esta API se marcó como obsoleta. Se recomienda migrar a dataworks-public(2024-05-18) - ListDataQualityScanRuns para obtener funciones mejoradas y soporte continuo. Si bien la API obsoleta permanece accesible de forma temporal, no se entregarán nuevas actualizaciones ni correcciones de bugs.

Descripción de la operación

Debe adquirir DataWorks Basic Edition o superior para utilizar esta función.

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

dataworks:*

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks.	100
DataQualityEvaluationTaskId	integer	No	El ID de la tarea de evaluación de calidad de datos.	10000
TableGuid	string	No	El ID único de la tabla en Data Map.	odps.unit_test.tb_unit_test
CreateTimeFrom	integer	No	La hora de inicio más temprana de la instancia de la tarea de evaluación de calidad de datos.	1710239005403
CreateTimeTo	integer	No	La hora de inicio más reciente de la instancia de la tarea de evaluación de calidad de datos.	1710239005403
BizdateFrom	string	No	La fecha de inicio de negocio de la tarea de evaluación de calidad.	2024-04-01
BizdateTo	string	No	La fecha de fin de negocio de la tarea de evaluación de calidad.	2024-05-01
TriggerClientId	string	No	El TriggerClientId en TriggerContext.	1001
TriggerClient	string	No	El TriggerClient en TriggerContext.	CWF2
PageSize	integer	Sí	El tamaño de página para la consulta de paginación de la lista. Valor predeterminado: 10.	10
PageNumber	integer	Sí	El número de página para la consulta de paginación de la lista. Valor predeterminado: 1.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El valor de retorno.
RequestId	string	El ID de solicitud de la API.	691CA452-D37A-4ED****
PagingInfo	object	El resultado de la consulta paginada de instancias de tareas de evaluación de calidad.
PageNumber	integer	El número de página.	1
PageSize	integer	El tamaño de página.	10
TotalCount	integer	El número total de registros.	294
DataQualityEvaluationTaskInstances	array<object>	La TaskInstance activada correctamente.
	array<object>
Id	integer	El ID de la instancia de la tarea de verificación de calidad.	10001
CreateTime	integer	La hora de creación de la instancia de la tarea.	1710239005403
FinishTime	integer	La hora de finalización de la instancia de la tarea.	1710239005403
Status	string	El estado de ejecución actual. Running Error Passed Warned Critical	Critical
Parameters	string	La configuración de parámetros utilizada durante la ejecución real.	{ "bizdate": "20240517", "triggerTime": "1710239005403" }
TriggerContext	string	La información de contexto cuando se activa la instancia.	{ "TriggerClientId": 10001, "TriggerClient": "CWF2" }
ProjectId	integer	El ID del espacio de trabajo del proyecto de DataWorks.	100
Task	object	La instantánea de la tarea de evaluación de calidad de datos al inicio de la evaluación.
Id	integer	El ID de la tarea de evaluación de calidad de datos.	10001
Description	string	La descripción de la tarea de monitoreo de calidad.	Este es un plan de evaluación de calidad de datos de ejecución diaria
ProjectId	integer	El ID del espacio de trabajo del proyecto.	100
Target	object	El objeto de monitoreo de la tarea de evaluación de calidad de datos.
Type	string	El tipo del objeto de monitoreo. Table	Table
DatabaseType	string	Para un conjunto de datos de tipo tabla, el tipo de base de datos al que pertenece la tabla. maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	El ID único de la tabla en Data Map.	odps.unit_test.tb_unit_test
PartitionSpec	string	La configuración de particiones de la tabla particionada.	ds=$[yyyymmdd-1]
Trigger	object	La configuración del disparador de la tarea de evaluación de calidad de datos.
Type	string	El tipo de evento que puede activar la ejecución de la tarea de evaluación de calidad. ByScheduledTaskInstance: Una instancia programada se ejecuta correctamente.	ByScheduledTaskInstance
TaskIds	array	Los ID de los nodos de tareas programadas.
	integer	El ID del nodo de la tarea programada.	10000
RuntimeConf	string	Configuración utilizada al acceder a orígenes de datos. Actualmente, solo se admite especificar la cola YARN de EMR y especificar el motor SQL como SPARK_SQL\|KYUUBI\|PRESTO_SQL\|HIVE_SQL al recopilar tablas de EMR.	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Hooks	array<object>	La configuración de callbacks en el ciclo de vida de la instancia de la tarea de evaluación de calidad de datos. Actualmente, solo se admite un Hook para bloquear tareas programadas.
	object	Hook.
Type	string	El tipo de acción de procesamiento posterior. BlockTaskInstance: Bloquea la ejecución de la instancia de la tarea de DataWorks.	BlockTaskInstance
Condition	string	La condición de activación del Hook.	${severity} == "High" AND ${status} == "Critical"
Notifications	object	La configuración de suscripción a notificaciones.
Condition	string	La condición de activación de la notificación.	${severity} == "High"
Notifications	array<object>	La configuración de notificaciones.
	array<object>	La configuración de notificaciones.
NofiticationReceivers	array<object>	La configuración de destinatarios de alertas.
	object	La configuración de destinatarios de alertas.
ReceiverType	string	El tipo de destinatario de la alerta. AliUid - El UID de la cuenta de Alibaba Cloud WebhookUrl - Una URL de webhook personalizada DingdingUrl - La URL de un bot de DingTalk FeishuUrl - La URL de un bot de Lark WeixinUrl - La URL de un bot de WeCom	AliUid
Extension	string	La información de extensión, en formato JSON. Por ejemplo, un bot de DingTalk admite la mención a todos.	{"atAll":"true"}
ReceiverValues	array	El destinatario de la alerta.
	string	El valor específico del destinatario de la alerta.	10000001
NotificationChannels	array<object>	El método de alerta.
	object	El método de notificación.
Channels	array	El método de alerta.
	string	Mail - Correo electrónico Sms - SMS Phone - Llamada telefónica Feishu - Lark Weixin - WeChat Dingding - DingTalk Webhook - Webhook personalizado	Mail
Name	string	El nombre de la tarea de monitoreo de calidad.	Tarea de verificación de calidad

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "691CA452-D37A-4ED****",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 294,
    "DataQualityEvaluationTaskInstances": [
      {
        "Id": 10001,
        "CreateTime": 1710239005403,
        "FinishTime": 1710239005403,
        "Status": "Critical",
        "Parameters": "{\n  \"bizdate\": \"20240517\",\n  \"triggerTime\": \"1710239005403\"\n}",
        "TriggerContext": "{\n  \"TriggerClientId\": 10001,\n  \"TriggerClient\": \"CWF2\"\n}",
        "ProjectId": 100,
        "Task": {
          "Id": 10001,
          "Description": "This is a daily run data quality evaluation plan.",
          "ProjectId": 100,
          "Target": {
            "Type": "Table",
            "DatabaseType": "maxcompute",
            "TableGuid": "odps.unit_test.tb_unit_test",
            "PartitionSpec": "ds=$[yyyymmdd-1]"
          },
          "Trigger": {
            "Type": "ByScheduledTaskInstance",
            "TaskIds": [
              10000
            ]
          },
          "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }",
          "Hooks": [
            {
              "Type": "BlockTaskInstance",
              "Condition": "${severity} == \"High\" AND ${status} == \"Critical\""
            }
          ],
          "Notifications": {
            "Condition": "${severity} == \"High\"",
            "Notifications": [
              {
                "NofiticationReceivers": [
                  {
                    "ReceiverType": "AliUid",
                    "Extension": "{\"atAll\":\"true\"}",
                    "ReceiverValues": [
                      "10000001"
                    ]
                  }
                ],
                "NotificationChannels": [
                  {
                    "Channels": [
                      "Mail"
                    ]
                  }
                ]
              }
            ]
          },
          "Name": "Quality verification task"
        }
      }
    ]
  }
}

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.