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

Obtiene los detalles de una instancia de tarea de verificación de calidad de datos.

Nota

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

Se requiere DataWorks Basic Edition o una edición superior para utilizar esta operació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:*

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	integer	Sí	El ID de la instancia de la tarea de monitoreo de calidad de datos.	7227550902

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud. Se utiliza para localizar registros y solucionar problemas.	8abcb91f-d266-4073-b907-2ed67****
DataQualityEvaluationTaskInstance	object	Los detalles de la instancia de monitoreo de calidad de datos.
Status	string	El estado de la instancia de la tarea de monitoreo de calidad de datos. Valores válidos: Running: La verificación está en curso. Error: Una verificación de regla encontró un error. Passed: Todas las verificaciones de reglas se aprobaron. Warned: Una regla activó un umbral de alerta normal. Critical: Una regla activó un umbral de alerta crítica.	Passed
Task	object	La tarea de monitoreo de calidad de datos.
Name	string	El nombre de la tarea de monitoreo de calidad de datos.	Data quality OpenAPI monitoring test
Notifications	object	La configuración de notificaciones.
Condition	string	La causa que activa una notificación. Cuando se cumple esta condición, se envía una notificación por mensaje. Solo se admiten dos tipos de expresiones condicionales: Especificar una sola combinación de gravedad de regla y estado de verificación de regla. Por ejemplo, `${severity} == "High" AND ${status} == "Critical"` significa que la condición se cumple si alguna regla con gravedad High tiene un resultado de verificación de Critical. Especificar múltiples combinaciones de gravedad de regla y estado de verificación de regla. Por ejemplo, `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")` significa que la condición se cumple si alguna regla con gravedad High tiene un resultado de verificación de Critical, o si alguna regla con gravedad Normal tiene un resultado de verificación de Critical, o si alguna regla con gravedad Normal tiene un resultado de verificación de Error. Los valores de enumeración de gravedad en la expresión condicional coinciden con los valores de enumeración de gravedad en DataQualityRule, y los valores de enumeración de estado coinciden con los valores de estado en DataQualityResult.	${severity} == "High" AND ${status} == "Critical"
Notifications	array<object>	Los métodos de alerta.
	array<object>
NotificationReceivers	array<object>	Los destinatarios de la notificación.
	object
ReceiverType	string	El tipo de destinatario de la alerta.	DingdingUrl
Extension	string	La configuración de parámetros adicionales para enviar alertas, en formato JSON. Se admiten las siguientes claves: atAll: Especifica si se debe mencionar a todos (@everyone) en el grupo al enviar una alerta de DingTalk. Este parámetro solo surte efecto cuando ReceiverType se establece en DingdingUrl.	{ "atAll": true }
ReceiverValues	array	Los destinatarios de la alerta.
	string	El valor del destinatario. Si el tipo de destinatario es Alibaba Cloud ID, el valor es el ID de usuario de Alibaba Cloud. Si el tipo de destinatario es DingdingUrl, el valor es la URL del webhook del chatbot de DingTalk. Si el tipo de destinatario es WeixinUrl, el valor es la URL del webhook del chatbot de WeCom. Si el tipo de destinatario es FeishuUrl, el valor es la URL del webhook del chatbot de Lark. Si el tipo de destinatario es WebhookUrl, el valor es la URL del webhook de un webhook personalizado.	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	Los canales de notificación.
	object
Channels	array	Los canales de notificación.
	string	El método 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
Hooks	array<object>	La configuración de callbacks.
	object
Type	string	El tipo de hook. Solo se admite un tipo: BlockTaskInstance: Bloquea la continuación de la ejecución del nodo de programación. Si la tarea de monitoreo de calidad de datos es activada por un nodo de programación, después de que finaliza la tarea de monitoreo de calidad de datos, el sistema determina si debe bloquear la continuación de la ejecución del nodo de programación según Hook.Condition.	BlockTaskInstance
Condition	string	La causa que activa la acción del hook. Cuando se cumple esta condición, se activa la acción del hook. Solo se admiten dos tipos de expresiones condicionales: Especificar una sola combinación de gravedad de regla y estado de verificación de regla. Por ejemplo, `${severity} == "High" AND ${status} == "Critical"` significa que la condición se cumple si alguna regla con gravedad High tiene un resultado de verificación de Critical. Especificar múltiples combinaciones de gravedad de regla y estado de verificación de regla. Por ejemplo, `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")` significa que la condición se cumple si alguna regla con gravedad High tiene un resultado de verificación de Critical, o si alguna regla con gravedad Normal tiene un resultado de verificación de Critical, o si alguna regla con gravedad Normal tiene un resultado de verificación de Error. Los valores de enumeración de gravedad en la expresión condicional coinciden con los valores de enumeración de gravedad en DataQualityRule, y los valores de enumeración de estado coinciden con los valores de estado en DataQualityResult.	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
RuntimeConf	string	La configuración de extensión, una cadena de caracteres en formato JSON. Este parámetro solo surte efecto para tareas de monitoreo de calidad de datos de tipo EMR. queue: La cola de YARN utilizada para ejecutar la validación de datos de EMR. El valor predeterminado es la cola configurada para el proyecto actual. sqlEngine: El motor SQL utilizado para ejecutar la validación de datos de EMR. Valores válidos: HIVE_SQL SPARK_SQL.	{ "queue": "default" }
Trigger	object	La configuración del disparador de la tarea de verificación de calidad de datos.
Type	string	El tipo de disparador de la tarea de monitoreo de calidad. Valores válidos: ByManual: Disparador manual. Este es el valor predeterminado. ByScheduledTaskInstance: Activado por un nodo de programación asociado.	ByScheduledTaskInstance
TaskIds	array	La lista de ID de nodos de programación. Este parámetro solo es válido cuando Type se establece en ByScheduledTaskInstance.
	integer	El ID del nodo de programación.	70006236752324
Target	object	El objeto monitoreado de la tarea de verificación de calidad de datos. Consulte el ejemplo de DataQualityTarget.
Type	string	El tipo de objeto monitoreado. Valores válidos: Table: tabla.	Table
DatabaseType	string	El tipo de base de datos a la que pertenece la tabla.	maxcompute
TableGuid	string	El ID único de la tabla en DataWorks Data Map.	odps.api_trace.ods_d_api_log
PartitionSpec	string	El rango de particiones a monitorear.	pt=$[yyyymmdd-1]
Description	string	La descripción de la tarea de monitoreo de calidad de datos.	OpenAPI quality monitoring test
Id	integer	El ID de la tarea de monitoreo de calidad de datos.	28544990
ProjectId	integer	El ID del espacio de trabajo.	20629
Parameters	string	Los parámetros de ejecución para la verificación de calidad de datos, en formato JSON. Están disponibles las siguientes claves: triggerTime: la marca de tiempo en milisegundos de la hora de activación. Esta es la hora base para la expresión $[yyyymmdd] en el rango de datos de la tarea de monitoreo de calidad de datos. Esta clave es obligatoria.	{ "triggerTime": 1733284062000 }
FinishTime	integer	La hora de finalización de la ejecución de la instancia.	1716344665000
TriggerContext	string	La información de contexto cuando se activa la instancia, en formato JSON. Se pueden incluir las siguientes claves: TriggerClient: el origen de activación de la instancia de monitoreo de calidad de datos, como CWF2 (sistema de programación). Es posible que se agreguen más valores en el futuro. TriggerClientId: el ID de un recurso empresarial específico en el sistema de origen. Por ejemplo, cuando TriggerClient es CWF2, este campo registra el ID de la tarea de programación.	{ "triggerClient": "CWF2", "triggerClientId": 70001238945 }
CreateTime	integer	La hora de creación.	1716344665000
Id	integer	El ID de la instancia de monitoreo de calidad de datos.	7234231689
ProjectId	integer	El ID del espacio de trabajo.	98330
Results	array<object>
	array<object>
Id	integer
Status	string
CreateTime	integer
TaskInstanceId	integer
Sample	string
Details	array<object>
	object
ReferencedValue	string
CheckedValue	string
Status	string
Rule	object
Id	integer
Name	string
ProjectId	integer
Enabled	boolean
Severity	string
Description	string
TemplateCode	string
Target	object
Type	string
DatabaseType	string
TableGuid	string
SamplingConfig	object
Metric	string
MetricParameters	string
SettingConfig	string
SamplingFilter	string
CheckingConfig	object
Type	string
ReferencedSamplesFilter	string
Thresholds	object
Expected	object
Value	string
Operator	string
Expression	string
Warned	object
Value	string
Operator	string
Expression	string
Critical	object
Value	string
Operator	string
Expression	string
ErrorHandlers	array<object>
	object
Type	string
ErrorDataFilter	string

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "8abcb91f-d266-4073-b907-2ed67****",
  "DataQualityEvaluationTaskInstance": {
    "Status": "Passed",
    "Task": {
      "Name": "Data quality OpenAPI monitoring test\n",
      "Notifications": {
        "Condition": "${severity} == \"High\" AND ${status} == \"Critical\"",
        "Notifications": [
          {
            "NotificationReceivers": [
              {
                "ReceiverType": "DingdingUrl",
                "Extension": "{ \"atAll\": true }",
                "ReceiverValues": [
                  "https://api.fc.aliyuncs.com/webhook"
                ]
              }
            ],
            "NotificationChannels": [
              {
                "Channels": [
                  "Mail"
                ]
              }
            ]
          }
        ]
      },
      "Hooks": [
        {
          "Type": "BlockTaskInstance",
          "Condition": "(${severity} == \"High\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Error\")"
        }
      ],
      "RuntimeConf": "{ \"queue\": \"default\" }",
      "Trigger": {
        "Type": "ByScheduledTaskInstance",
        "TaskIds": [
          70006236752324
        ]
      },
      "Target": {
        "Type": "Table",
        "DatabaseType": "maxcompute",
        "TableGuid": "odps.api_trace.ods_d_api_log",
        "PartitionSpec": "pt=$[yyyymmdd-1]"
      },
      "Description": "OpenAPI quality monitoring test",
      "Id": 28544990,
      "ProjectId": 20629
    },
    "Parameters": "{ \"triggerTime\": 1733284062000 }\n",
    "FinishTime": 1716344665000,
    "TriggerContext": "{ \"triggerClient\": \"CWF2\", \"triggerClientId\": 70001238945 }",
    "CreateTime": 1716344665000,
    "Id": 7234231689,
    "ProjectId": 98330,
    "Results": [
      {
        "Id": 0,
        "Status": "",
        "CreateTime": 0,
        "TaskInstanceId": 0,
        "Sample": "",
        "Details": [
          {
            "ReferencedValue": "",
            "CheckedValue": "",
            "Status": ""
          }
        ],
        "Rule": {
          "Id": 0,
          "Name": "",
          "ProjectId": 0,
          "Enabled": false,
          "Severity": "",
          "Description": "",
          "TemplateCode": "",
          "Target": {
            "Type": "",
            "DatabaseType": "",
            "TableGuid": ""
          },
          "SamplingConfig": {
            "Metric": "",
            "MetricParameters": "",
            "SettingConfig": "",
            "SamplingFilter": ""
          },
          "CheckingConfig": {
            "Type": "",
            "ReferencedSamplesFilter": "",
            "Thresholds": {
              "Expected": {
                "Value": "",
                "Operator": "",
                "Expression": ""
              },
              "Warned": {
                "Value": "",
                "Operator": "",
                "Expression": ""
              },
              "Critical": {
                "Value": "",
                "Operator": "",
                "Expression": ""
              }
            }
          },
          "ErrorHandlers": [
            {
              "Type": "",
              "ErrorDataFilter": ""
            }
          ]
        }
      }
    ]
  }
}

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.