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

Consulta una lista paginada de tareas de monitoreo de calidad.

Nota

Esta API se marcó como obsoleta. Se recomienda migrar a dataworks-public(2024-05-18) - ListDataQualityScans 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 una edición 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
TableGuid	string	No	El ID único de la tabla en DataWorks Data Map.	odps.unit_test.tb_unit_test
Name	string	No	El nombre utilizado para la coincidencia aproximada de los nombres de las tareas de evaluación de calidad de datos.	Test
PageSize	integer	Sí	El tamaño de página para la paginación. Valor predeterminado: 10.	10
PageNumber	integer	Sí	El número de página para la paginación. Valor predeterminado: 1.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud de API.	691CA452-D37A-4ED0-****
PagingInfo	object	El resultado de la consulta paginada de las tareas de evaluación de calidad.
TotalCount	string	El número total de registros.	131
PageSize	string	El tamaño de página.	10
PageNumber	string	El número de página.	1
DataQualityEvaluationTasks	array<object>	Las tareas de evaluación de calidad.
	array<object>
Id	integer	El ID de la tarea de evaluación de calidad de datos.	10001
Name	string	El nombre de la tarea de evaluación de calidad de datos. El nombre puede contener dígitos, letras en inglés, caracteres chinos y signos de puntuación de ancho medio o completo. El nombre puede tener una longitud de hasta 255 caracteres.	Data quality verification task
Description	string	La descripción de la tarea de evaluación de calidad de datos. La descripción puede tener una longitud de hasta 65,535 caracteres.	This is a daily run data quality evaluation plan
ProjectId	integer	El ID del espacio de trabajo de DataWorks.	100
Target	object	El objeto monitoreado de la tarea de evaluación de calidad de datos.
Type	string	El tipo de objeto monitoreado. Valores válidos: Table	Table
DatabaseType	string	El tipo de base de datos del conjunto de datos de la tabla. Valores válidos: maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	El ID único de la tabla en DataWorks 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 activa la tarea de evaluación de calidad. Valores válidos: ByScheduledTaskInstance: Se activa cuando una instancia de nodo programado se ejecuta correctamente.	ByScheduledTaskInstance
TaskIds	array	Este parámetro surte efecto cuando el tipo se establece en ByScheduledTaskInstance. Especifica los ID de los nodos programados cuya ejecución correcta de la instancia puede activar la tarea.
	integer	El ID del nodo programado.	10001
RuntimeConf	string	La configuración de tiempo de ejecución para los orígenes de datos. Actualmente, solo se admite especificar la cola EMR YARN y el motor SQL para recopilar tablas EMR. Valores válidos del motor SQL: SPARK_SQL, KYUUBI, PRESTO_SQL y HIVE_SQL.	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Hooks	array<object>	La configuración de devoluciones de llamada durante el ciclo de vida de las instancias de tareas de evaluación de calidad de datos. Actualmente, solo se admite un hook que bloquea una instancia de nodo de programación.
	object	La configuración de devolución de llamada.
Type	string	El tipo de acción de seguimiento. Valores válidos: BlockTaskInstance: Bloquea la ejecución de una instancia de nodo de DataWorks.	BlockTaskInstance
Condition	string	La condición que activa el hook.	${severity} == "High" AND ${status} == "Critical"
Notifications	object	La configuración de alertas.
Condition	string	La condición que activa la notificación.	${severity} == "High"
Notifications	array<object>	La configuración de alertas.
	array<object>	El ajuste de alerta.
NotificationChannels	array<object>	Las configuraciones de canales de alerta.
	object	El canal de alerta.
Channels	array	El canal de alerta.
	string	El canal de alerta. Valores válidos: Mail: correo electrónico. Sms: mensaje de texto. Phone: llamada telefónica. Feishu: Lark. Weixin: WeChat. Dingding: DingTalk. Webhook: webhook personalizado.	Mail
NotificationReceivers	array<object>	Las configuraciones de destinatarios de alertas.
	object	El destinatario de la alerta.
ReceiverType	string	El tipo de destinatario de la alerta. Valores válidos: AliUid: UID de la cuenta de Alibaba Cloud. WebhookUrl: URL de webhook personalizado. DingdingUrl: URL del chatbot de DingTalk. FeishuUrl: URL del chatbot de Lark. WeixinUrl: URL del chatbot de WeCom.	AliUid
ReceiverValues	array	Los valores específicos de los destinatarios de la alerta.
	string	Los valores específicos de los destinatarios de la alerta.	user1
Extension	string	La información de extensión en formato JSON. Por ejemplo, los chatbots de DingTalk admiten mencionar a todos los miembros.	{"atAll":"true"}
DataSourceId	integer

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "691CA452-D37A-4ED0-****",
  "PagingInfo": {
    "TotalCount": "131",
    "PageSize": "10",
    "PageNumber": "1",
    "DataQualityEvaluationTasks": [
      {
        "Id": 10001,
        "Name": "Tarea de verificación de calidad de datos",
        "Description": "Este es un plan de evaluación de calidad de datos de ejecución diaria",
        "ProjectId": 100,
        "Target": {
          "Type": "Table",
          "DatabaseType": "maxcompute",
          "TableGuid": "odps.unit_test.tb_unit_test",
          "PartitionSpec": "ds=$[yyyymmdd-1]"
        },
        "Trigger": {
          "Type": "ByScheduledTaskInstance",
          "TaskIds": [
            10001
          ]
        },
        "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }",
        "Hooks": [
          {
            "Type": "BlockTaskInstance",
            "Condition": "${severity} == \"High\" AND ${status} == \"Critical\""
          }
        ],
        "Notifications": {
          "Condition": "${severity} == \"High\"",
          "Notifications": [
            {
              "NotificationChannels": [
                {
                  "Channels": [
                    "Mail"
                  ]
                }
              ],
              "NotificationReceivers": [
                {
                  "ReceiverType": "AliUid",
                  "ReceiverValues": [
                    "user1"
                  ],
                  "Extension": "{\"atAll\":\"true\"}"
                }
              ]
            }
          ]
        },
        "DataSourceId": 0
      }
    ]
  }
}

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.