GetDataQualityEvaluationTask - DataWorks: Central de Documentação do Alibaba Cloud

Consulta os detalhes de uma tarefa de validação de qualidade de dados.

Nota

Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - CreateDataQualityScan para funcionalidade aprimorada e suporte contínuo. Embora a API descontinuada permaneça temporariamente acessível, nenhuma atualização ou correção de bugs será fornecida.

Descrição da operação

Disponível apenas com o DataWorks Basic Edition ou superior.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Não	O ID do monitoramento de qualidade de dados.	1006455182

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
DataQualityEvaluationTask	object	Os detalhes do monitoramento de qualidade de dados.
Target	object	O objeto de monitoramento de qualidade de dados.
Type	string	Monitoring object type. Table: Table.	Table
DatabaseType	string	Database type to which the table belongs: maxcompute hologres cdh analyticdb_for_mysql starrocks emr analyticdb_for_postgresql	maxcompute
TableGuid	string	Unique ID of the table in Data Map.	odps.meta_open_api_test_sz.test_partition_tbl
PartitionSpec	string	Partition range setting for data quality monitoring.	pt=$[yyyymmdd-1]
Description	string	A descrição da tarefa de monitoramento de qualidade.	The description of the quality monitoring task.
Trigger	object	A configuração de gatilho da tarefa de validação de qualidade de dados.
Type	string	Quality monitoring trigger type: ByManual: Manual trigger ByScheduledTaskInstance: Scheduled task trigger ByQualityNode: Quality node trigger	ByScheduledTaskInstance
TaskIds	array	List of scheduled task IDs. Valid when Type is ByScheduledTaskInstance.
	integer	Scheduled task ID.	30001
RuntimeConf	string	Configuração estendida. Uma string formatada em JSON. Tem efeito apenas para monitoramento de qualidade de dados do tipo EMR. queue: A fila YARN usada ao executar a validação de qualidade de dados do EMR. O padrão é a fila configurada para o projeto atual. sqlEngine: O mecanismo SQL usado ao executar a validação de dados do EMR. HIVE_SQL SPARK_SQL.	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Id	integer	O ID do monitoramento de qualidade de dados.	2178
Name	string	O nome da tarefa de monitoramento de qualidade.	OpenAPI create a data quality monitoring test
ProjectId	integer	O ID do workspace.	2626
Hooks	array<object>	As configurações de callback.
	object	Hook.
Type	string	Hook type. Currently, only one type is supported: BlockTaskInstance: Blocks the scheduled task from continuing to run. When data quality monitoring is triggered by a scheduled task, after the data quality monitoring completes, Hook.Condition is used to determine whether to block the scheduled task from continuing to run.	BlockTaskInstance
Condition	string	Hook trigger condition. When this condition is met, the hook action is triggered. Currently, only two types of conditional expressions are supported: Specify a single group of rule severity type and rule validation status, e.g., `${severity} == "High" AND ${status} == "Critical"`, which means the condition is met if any executed rule with severity High has a validation result of Critical. Specify multiple groups of rule severity types and rule validation statuses, e.g., `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`, which means the condition is met if any executed rule has severity High with validation result Critical, or severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the conditional expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	object	A configuração de assinatura de notificações.
Condition	string	Notification trigger condition. When this condition is met, the message notification is triggered. Currently, only two types of conditional expressions are supported: Specify a single group of rule severity type and rule validation status, e.g., `${severity} == "High" AND ${status} == "Critical"`, which means the condition is met if any executed rule with severity High has a validation result of Critical. Specify multiple groups of rule severity types and rule validation statuses, e.g., `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`, which means the condition is met if any executed rule has severity High with validation result Critical, or severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the conditional expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	array<object>	Notification settings.
	array<object>	Notification settings
NotificationReceivers	array<object>	Alert receiver settings.
	object	Alert receiver settings
ReceiverType	string	Additional parameter settings when sending alerts. JSON format. Supported keys are as follows: atAll: Whether to @everyone in the group when sending DingTalk alerts. Takes effect when ReceiverType is DingdingUrl. Valores válidos: WebhookUrl : Custom webhook URL FeishuUrl : Lark notification URL DingdingUrl : DingTalk group robot URL WeixinUrl : WeCom notification URL AliUid : User ID	DingdingUrl
Extension	string	Extended information.	{ "atAll": true }
ReceiverValues	array	Alert receiver.
	string	Receiver value. When the receiver type is Alibaba Cloud ID, the receiver value is the specific Alibaba Cloud user ID. When the receiver type is DingdingUrl, the receiver value is the specific alert URL of the DingTalk robot. When the receiver type is WeixinUrl, the receiver value is the specific alert URL of WeCom. When the receiver type is FeishuUrl, the receiver value is the specific alert URL of Lark. When the receiver type is WebhookUrl, the receiver value is the specific alert URL of the custom Webhook.	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	Notification method.
	object	Notification method
Channels	array	Notification method.
	string	Alert method Mail - Email Sms - SMS Phone - Phone Feishu - Lark Weixin - WeCom Dingding - DingTalk Webhook - Custom Webhook	Mail
DataSourceId	integer	O ID da fonte de dados usado pela tarefa de monitoramento de qualidade.	45238

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.