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

Consulta los detalles de una tarea de validación de calidad de datos.

Nota

Esta API se marcó como obsoleta. Se recomienda migrar a dataworks-public(2024-05-18) - CreateDataQualityScan 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

Disponible solo con DataWorks Basic Edition o superior.

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

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	integer	No	El ID del monitoreo de calidad de datos.	1006455182

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
DataQualityEvaluationTask	object	Los detalles del monitoreo de calidad de datos.
Target	object	El objeto de monitoreo de calidad de datos.
Type	string	El tipo de objeto de monitoreo. Table: Tabla.	Table
DatabaseType	string	El tipo de base de datos a la que pertenece la tabla: maxcompute hologres cdh analyticdb_for_mysql starrocks emr analyticdb_for_postgresql	maxcompute
TableGuid	string	El ID único de la tabla en Data Map.	odps.meta_open_api_test_sz.test_partition_tbl
PartitionSpec	string	La configuración del rango de partición para el monitoreo de calidad de datos.	pt=$[yyyymmdd-1]
Description	string	La descripción de la tarea de monitoreo de calidad.	La descripción de la tarea de monitoreo de calidad
Trigger	object	La configuración del disparador de la tarea de validación de calidad de datos.
Type	string	El tipo de disparador del monitoreo de calidad: ByManual: Disparador manual ByScheduledTaskInstance: Disparador por tarea programada ByQualityNode: Disparador por nodo de calidad	ByScheduledTaskInstance
TaskIds	array	La lista de ID de tareas programadas. Válido cuando Type es ByScheduledTaskInstance.
	integer	El ID de la tarea programada.	30001
RuntimeConf	string	La configuración extendida. Una cadena con formato JSON. Solo surte efecto para el monitoreo de calidad de datos de tipo EMR. queue: La cola de YARN utilizada al ejecutar la validación de calidad de datos de EMR. El valor predeterminado es la cola configurada para el proyecto actual. sqlEngine: El motor SQL utilizado al ejecutar la validación de datos de EMR. HIVE_SQL SPARK_SQL	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Id	integer	El ID del monitoreo de calidad de datos.	2178
Name	string	El nombre de la tarea de monitoreo de calidad.	OpenAPI crea una prueba de monitoreo de calidad de datos
ProjectId	integer	El ID del espacio de trabajo.	2626
Hooks	array<object>	La configuración de callbacks.
	object	El hook.
Type	string	El tipo de hook. Actualmente, solo se admite un tipo: BlockTaskInstance: Bloquea la continuación de la ejecución de la tarea programada. Cuando el monitoreo de calidad de datos es activado por una tarea programada, una vez que finaliza el monitoreo, se utiliza Hook.Condition para determinar si se debe bloquear la continuación de la ejecución de la tarea programada.	BlockTaskInstance
Condition	string	La condición de activación del hook. Cuando se cumple esta condición, se activa la acción del hook. Actualmente, solo se admiten dos tipos de expresiones condicionales: Especificar un solo grupo de tipo de severidad de regla y estado de validación de regla, por ejemplo, `${severity} == "High" AND ${status} == "Critical"`, lo que significa que la condición se cumple si cualquier regla ejecutada con severidad High tiene un resultado de validación Critical. Especificar múltiples grupos de tipos de severidad de regla y estados de validación de regla, por ejemplo, `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`, lo que significa que la condición se cumple si cualquier regla ejecutada tiene severidad High con resultado de validación Critical, o severidad Normal con resultado de validación Critical, o severidad Normal con resultado de validación Error. La enumeración de severidad en la expresión condicional coincide con la enumeración de severidad en DataQualityRule, y la enumeración de estado coincide con el estado en DataQualityResult.	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	object	La configuración de suscripción a notificaciones.
Condition	string	La condición de activación de notificación. Cuando se cumple esta condición, se activa la notificación de mensaje. Actualmente, solo se admiten dos tipos de expresiones condicionales: Especificar un solo grupo de tipo de severidad de regla y estado de validación de regla, por ejemplo, `${severity} == "High" AND ${status} == "Critical"`, lo que significa que la condición se cumple si cualquier regla ejecutada con severidad High tiene un resultado de validación Critical. Especificar múltiples grupos de tipos de severidad de regla y estados de validación de regla, por ejemplo, `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`, lo que significa que la condición se cumple si cualquier regla ejecutada tiene severidad High con resultado de validación Critical, o severidad Normal con resultado de validación Critical, o severidad Normal con resultado de validación Error. La enumeración de severidad en la expresión condicional coincide con la enumeración de severidad en DataQualityRule, y la enumeración de estado coincide con el estado en DataQualityResult.	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	array<object>	La configuración de notificaciones.
	array<object>	La configuración de notificaciones.
NotificationReceivers	array<object>	La configuración de receptores de alertas.
	object	La configuración de receptores de alertas.
ReceiverType	string	Configuración de parámetros adicionales al enviar alertas. Formato JSON. Las claves admitidas son las siguientes: atAll: Indica si se debe mencionar a todos (@everyone) en el grupo al enviar alertas de DingTalk. Surte efecto cuando ReceiverType es DingdingUrl. Valores válidos: WebhookUrl : URL de webhook personalizado. FeishuUrl : URL de notificación de Lark. DingdingUrl : URL de robot de grupo de DingTalk. WeixinUrl : URL de notificación de WeCom. AliUid : ID de usuario.	DingdingUrl
Extension	string	La información extendida.	{ "atAll": true }
ReceiverValues	array	El receptor de alertas.
	string	El valor del receptor. Cuando el tipo de receptor es ID de Alibaba Cloud, el valor del receptor es el ID de usuario específico de Alibaba Cloud. Cuando el tipo de receptor es DingdingUrl, el valor del receptor es la URL de alerta específica del robot de DingTalk. Cuando el tipo de receptor es WeixinUrl, el valor del receptor es la URL de alerta específica de WeCom. Cuando el tipo de receptor es FeishuUrl, el valor del receptor es la URL de alerta específica de Lark. Cuando el tipo de receptor es WebhookUrl, el valor del receptor es la URL de alerta específica del webhook personalizado.	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	El método de notificación.
	object	El método de notificación.
Channels	array	El método de notificación.
	string	El método de alerta. Mail - Correo electrónico Sms - SMS Phone - Teléfono Feishu - Lark Weixin - WeCom Dingding - DingTalk Webhook - Webhook personalizado	Mail
DataSourceId	integer	El ID del origen de datos utilizado por la tarea de evaluación de calidad de datos.	45238

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF",
  "DataQualityEvaluationTask": {
    "Target": {
      "Type": "Table",
      "DatabaseType": "maxcompute",
      "TableGuid": "odps.meta_open_api_test_sz.test_partition_tbl",
      "PartitionSpec": "pt=$[yyyymmdd-1]"
    },
    "Description": "The description of the quality monitoring task.",
    "Trigger": {
      "Type": "ByScheduledTaskInstance",
      "TaskIds": [
        30001
      ]
    },
    "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }\n",
    "Id": 2178,
    "Name": "OpenAPI create a data quality monitoring test",
    "ProjectId": 2626,
    "Hooks": [
      {
        "Type": "BlockTaskInstance",
        "Condition": "(${severity} == \"High\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Error\")"
      }
    ],
    "Notifications": {
      "Condition": "(${severity} == \"High\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Error\")",
      "Notifications": [
        {
          "NotificationReceivers": [
            {
              "ReceiverType": "DingdingUrl",
              "Extension": "{  \"atAll\": true }\n",
              "ReceiverValues": [
                "https://api.fc.aliyuncs.com/webhook\n"
              ]
            }
          ],
          "NotificationChannels": [
            {
              "Channels": [
                "Mail"
              ]
            }
          ]
        }
      ]
    },
    "DataSourceId": 45238
  }
}

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.