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

Actualiza una tarea de verificación de calidad de datos.

Nota

Esta API se marcó como obsoleta. Se recomienda migrar a dataworks-public(2024-05-18) - UpdateDataQualityScan 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 versión posterior 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:UpdateDataQualityEvaluationTask

update

*All resources.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Target	object	No	El objeto monitoreado para el monitoreo de calidad de datos.
DatabaseType	string	No	El tipo de base de datos de la tabla. Valores válidos: maxcompute hologres cdh analyticdb_for_mysql starrocks emr analyticdb_for_postgresql	maxcompute
TableGuid	string	No	El ID único de la tabla en DataWorks Data Map.	odsp.openapi.ods_d_openapi_log
PartitionSpec	string	No	La configuración de particiones de la tabla particionada.	dt=$[yyyymmdd-1]
Description	string	No	La descripción de la tarea de monitoreo de calidad.	OpenAPI data quality monitoring test.
Name	string	No	El nombre de la tarea de monitoreo de calidad.	OpenAPI data quality monitoring test.
RuntimeConf	string	No	La configuración de extensión. Este parámetro es una cadena de caracteres en formato JSON y solo surte efecto para el monitoreo de calidad de datos de EMR. queue: la cola de YARN que se utiliza al ejecutar la validación de datos de EMR. Valor predeterminado: la cola configurada para el proyecto actual. sqlEngine: el motor SQL DPI que se utiliza al ejecutar la validación de datos de EMR. Valores válidos: HIVE_SQL SPARK_SQL	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Trigger	object	No	La configuración del disparador de la tarea de verificación de calidad de datos.
Type	string	No	El tipo de disparador de la tarea de monitoreo de calidad. Valores válidos: ByScheduledTaskInstance: se dispara mediante una tarea programada asociada. ByManual: se dispara manualmente.	ByScheduledTaskInstance
TaskIds	array	No	La lista de ID de tareas programadas. Este parámetro solo surte efecto cuando Type se establece en ByScheduledTaskInstance.
	integer	No	El ID del nodo de la tarea programada.	1004979033
ProjectId	integer	Sí	El ID del espacio de trabajo.	10000
Hooks	array<object>	No	La configuración de los hooks.
	object	No	Hook.
Type	string	No	La acción del hook que se ejecuta después de que se completa la verificación de calidad de datos. Valores válidos: BlockTaskInstance: bloquea la tarea programada.	ByScheduledTaskInstance
Condition	string	No	La causa del hook. Cuando se cumple esta causa, se dispara la acción del hook. Actualmente, solo se admiten los siguientes dos tipos de expresiones condicionales: Especifique solo un grupo de niveles de gravedad de regla y estados de comprobación de regla, como `${severity} == "High" AND ${status} == "Critical"`. Esto indica que si el resultado de la comprobación de una regla que ejecuta con la gravedad High es Critical, se cumple la condición. Especifique varios grupos de niveles de gravedad de regla y estados de comprobación de regla, como `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. Esto indica que si el resultado de la comprobación de una regla que ejecuta con la gravedad High es Critical, el resultado de la comprobación de una regla que ejecuta con la gravedad Normal es Critical, o el resultado de la comprobación de una regla que ejecuta con la gravedad Normal es Error, se cumple la condición. Los valores de enumeración de severity en la expresión condicional son coherentes con los de DataQualityRule, y los valores de enumeración de status son coherentes con los de DataQualityResult.	${severity} == "High" AND ${status} == "Critical"
Notifications	object	No	La configuración de suscripción de notificaciones.
Condition	string	No	La causa de la notificación. Cuando se cumple esta causa, se dispara una notificación de mensaje. Actualmente, solo se admiten los siguientes dos tipos de expresiones condicionales: Especifique solo un grupo de niveles de gravedad de regla y estados de comprobación de regla, como `${severity} == "High" AND ${status} == "Critical"`. Esto indica que si el resultado de la comprobación de una regla que ejecuta con la gravedad High es Critical, se cumple la condición. Especifique varios grupos de niveles de gravedad de regla y estados de comprobación de regla, como `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. Esto indica que si el resultado de la comprobación de una regla que ejecuta con la gravedad High es Critical, el resultado de la comprobación de una regla que ejecuta con la gravedad Normal es Critical, o el resultado de la comprobación de una regla que ejecuta con la gravedad Normal es Error, se cumple la condición. Los valores de enumeración de severity en la expresión condicional son coherentes con los de DataQualityRule, y los valores de enumeración de status son coherentes con los de DataQualityResult.	${severity} == "High" AND ${status} == "Critical"
Notifications	array<object>	No	La configuración de notificaciones.
	array<object>	No	La configuración de notificaciones.
NotificationReceivers	array<object>	No	La configuración de destinatarios de alertas.
	object	No	La configuración de destinatarios de alertas.
ReceiverType	string	No	El tipo de destinatario de alerta. Valores válidos: WebhookUrl : URL de webhook personalizado. FeishuUrl : URL de notificación de Lark. DingdingUrl : URL de chatbot de grupo de DingTalk. WeixinUrl : URL de notificación de WeChat. AliUid : ID de usuario de Alibaba Cloud.	DingdingUrl
Extension	string	No	La configuración de parámetros adicionales cuando se envía una alerta. Este parámetro está en formato JSON. Claves admitidas: atAll: especifica si se debe mencionar a todos (@all) en el grupo al enviar una alerta de DingTalk. Esta clave solo surte efecto cuando ReceiverType se establece en DingdingUrl.	{ "atAll": true }
ReceiverValues	array	No	Los destinatarios de alertas.
	string	No	El valor del destinatario. Cuando el tipo de destinatario es ID de Alibaba Cloud, el valor es el ID de usuario específico de Alibaba Cloud. Cuando el tipo de destinatario es DingdingUrl, el valor es la URL de alerta específica del chatbot de DingTalk. Cuando el tipo de destinatario es WeixinUrl, el valor es la URL de alerta específica de WeCom. Cuando el tipo de destinatario es FeishuUrl, el valor es la URL de alerta específica de Lark. Cuando el tipo de destinatario es WebhookUrl, el valor es la URL de alerta específica del webhook personalizado.	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	No	Los métodos de notificación.
	object	No	Los métodos de notificación.
Channels	array	No	Los métodos de notificación.
	string	No	El método de notificación. Valores válidos: Dingding: chatbot de grupo de DingTalk Mail: correo electrónico Weixin: notificación de WeChat Feishu: notificación de Lark Phone: llamada telefónica Sms: mensaje de texto Webhook: webhook personalizado	Mail
DataSourceId	integer	No	El ID del origen de datos. Puede llamar a la operación ListDataSources para obtener el ID del origen de datos.	358750
DataQualityRules	array<object>	No	La lista de reglas de calidad de datos asociadas con el monitoreo de la calidad de datos.
	array<object>	No
Name	string	No	El nombre de la regla de calidad de datos.	OpenAPI test rules
Enabled	boolean	No	Especifica si la regla de calidad de datos está habilitada.	true
Severity	string	No	El nivel de gravedad de la regla para el negocio, que corresponde a las reglas fuertes y débiles en la página. Valores válidos: Normal High Valores válidos: High : Alta. Normal : Normal.	Normal
Description	string	No	La descripción de la regla de calidad de datos.	OpenAPI test rules
TemplateCode	string	No	El identificador único de la plantilla de regla a la que hace referencia la regla.	SYSTEM:field:null_value:fixed:0
SamplingConfig	object	No	Los parámetros requeridos para la recolección de muestras.
Metric	string	No	El nombre de la métrica muestreada. Valores válidos: Count: el número de filas en la tabla Min: el valor mínimo del campo Max: el valor máximo del campo Avg: el valor promedio del campo DistinctCount: el número de valores únicos en el campo DistinctPercent: la proporción del número de valores únicos en el campo respecto al número total de filas DuplicatedCount: el número de valores duplicados en el campo DuplicatedPercent: la proporción del número de valores duplicados en el campo respecto al número total de filas TableSize: el tamaño de la tabla NullValueCount: el número de filas donde el campo es nulo NullValuePercent: la proporción de filas donde el campo es nulo GroupCount: el número de filas correspondientes a cada valor después de la agregación por valor de campo CountNotIn: el número de filas que no coinciden con los valores enumerados CountDistinctNotIn: el número de valores únicos que no coinciden con los valores enumerados UserDefinedSql: recolección de muestras mediante el uso de instrucciones SQL personalizadas	CountNotIn
MetricParameters	string	No	Los parámetros requeridos para la recolección de muestras.	{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}
SettingConfig	string	No	Las instrucciones de configuración de parámetros de tiempo de ejecución insertadas antes de la ejecución de las instrucciones de muestreo. La longitud máxima es de 1,000 caracteres. Solo se admite MaxCompute.	odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True
SamplingFilter	string	No	Las condiciones utilizadas para filtrar los datos no necesarios durante el muestreo. La longitud máxima es de 16,777,215 caracteres.	status != 'Succeeded'
CheckingConfig	object	No	La configuración de verificación de muestras.
Type	string	No	El método de cálculo de umbral. Valores válidos: Fluctation: verificación de rango de fluctuación Auto: verificación de umbral inteligente FluctationDiscreate: verificación de rango de fluctuación de valores discretos Average: verificación de rango de fluctuación promedio Fixed: verificación de valor fijo	Fixed
ReferencedSamplesFilter	string	No	La expresión utilizada para especificar el método de consulta para las muestras de referencia. Algunos tipos de umbral requieren consultar muestras de referencia y agregar sus valores para derivar el umbral de comparación.	{"bizdate": ["-1"]}
Thresholds	object	No	La configuración de umbrales de verificación.
Expected	object	No	La configuración de umbral esperado.
Operator	string	No	El operador de comparación. Valores válidos: > >= < <= != =	=
Value	string	No	El valor de umbral.	0
Expression	string	No	La expresión de umbral. Para las reglas de fluctuación, debe usar una expresión para representar el umbral de fluctuación. Ejemplos: Aumento de fluctuación mayor que 0.01: $checkValue > 0.01 Disminución de fluctuación mayor que 0.01: $checkValue < -0.01 Valor absoluto de la tasa de fluctuación: abs($checkValue) > 0.01 Las reglas de valor fijo también pueden usar expresiones para configurar umbrales. Si se configuran ambas, la expresión tiene prioridad sobre Operator y Value.	$checkValue > 0.01
Warned	object	No	La configuración de umbral para advertencias normales.
Operator	string	No	El operador de comparación. Valores válidos: > >= < <= != =	>
Value	string	No	El valor de umbral.	0.001
Expression	string	No	La expresión de umbral. Para las reglas de fluctuación, debe usar una expresión para representar el umbral de fluctuación. Ejemplos: Aumento de fluctuación mayor que 0.01: $checkValue > 0.01 Disminución de fluctuación mayor que 0.01: $checkValue < -0.01 Valor absoluto de la tasa de fluctuación: abs($checkValue) > 0.01 Las reglas de valor fijo también pueden usar expresiones para configurar umbrales. Si se configuran ambas, la expresión tiene prioridad sobre Operator y Value.	$checkValue > 0.01
Critical	object	No	La configuración de umbral para advertencias críticas.
Operator	string	No	El operador de comparación. Valores válidos: > >= < <= != =	>
Value	string	No	El valor de umbral.	0.01
Expression	string	No	La expresión de umbral. Para las reglas de fluctuación, debe usar una expresión para representar el umbral de fluctuación. Ejemplos: Aumento de fluctuación mayor que 0.01: $checkValue > 0.01 Disminución de fluctuación mayor que 0.01: $checkValue < -0.01 Valor absoluto de la tasa de fluctuación: abs($checkValue) > 0.01 Las reglas de valor fijo también pueden usar expresiones para configurar umbrales. Si se configuran ambas, la expresión tiene prioridad sobre Operator y Value.	$checkValue > 0.01
ErrorHandlers	array<object>	No	Los controladores de errores para los problemas de verificación de reglas de calidad.
	object	No
Type	string	No	El tipo de controlador. Valores válidos: SaveErrorData: conservar datos de error	SaveErrorData
ErrorDataFilter	string	No	La instrucción SQL utilizada para filtrar datos de error. Este parámetro es obligatorio si la regla es una regla SQL personalizada.	SELECT * FROM ods_d_openapi_log WHERE status = 'Error'
Id	integer	No	El ID de la regla de verificación. Puede llamar a la operación ListQualityRules para obtener el ID de la regla.	1022171560
Id	integer	Sí	El ID de la tarea de monitoreo de calidad de datos.	7227061794

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
Success	boolean	Indica si la solicitud se realizó correctamente.	true
RequestId	string	El ID de la solicitud. Puede usar el ID para localizar registros y solucionar problemas.	8abcb91f-d266-4073-b907-2ed670378ed1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1"
}

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.