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

Atualiza uma tarefa de verificação de qualidade de dados.

Nota

Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - UpdateDataQualityScan 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

Você deve adquirir o DataWorks Basic Edition ou superior para usar este recurso.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:UpdateDataQualityEvaluationTask

update

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Target	object	Não	O objeto monitorado para o monitoramento de qualidade de dados.
DatabaseType	string	Não	O tipo de banco de dados da tabela. Valores válidos: maxcompute hologres cdh analyticdb_for_mysql starrocks emr analyticdb_for_postgresql	maxcompute
TableGuid	string	Não	O ID exclusivo da tabela no DataWorks Data Map.	odsp.openapi.ods_d_openapi_log
PartitionSpec	string	Não	As configurações de partição da tabela particionada.	dt=$[yyyymmdd-1]
Description	string	Não	A descrição da tarefa de monitoramento de qualidade.	OpenAPI data quality monitoring test.
Name	string	Não	O nome da tarefa de monitoramento de qualidade.	OpenAPI data quality monitoring test.
RuntimeConf	string	Não	A configuração de extensão. Este parâmetro é uma string de caracteres no formato JSON e tem efeito apenas para o monitoramento de qualidade de dados do EMR. queue: a fila YARN usada quando você executa a validação de dados do EMR. Valor padrão: a fila configurada para o projeto atual. sqlEngine: o mecanismo SQL DPI usado quando você executa a validação de dados do EMR. Valores válidos: HIVE_SQL SPARK_SQL	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Trigger	object	Não	A configuração de gatilho da tarefa de verificação de qualidade de dados.
Type	string	Não	O tipo de gatilho da tarefa de monitoramento de qualidade. Valores válidos: ByScheduledTaskInstance: acionado por uma tarefa agendada associada ByManual: acionado manualmente	ByScheduledTaskInstance
TaskIds	array	Não	A lista de IDs de tarefas agendadas. Este parâmetro tem efeito apenas quando Type é definido como ByScheduledTaskInstance.
	integer	Não	O ID do nó da tarefa agendada.	1004979033
ProjectId	integer	Sim	O ID do espaço de trabalho.	10000
Hooks	array<object>	Não	As configurações de hook.
	object	Não	Hook.
Type	string	Não	A ação de hook executada após a conclusão da verificação de qualidade de dados. Valores válidos: BlockTaskInstance: bloqueia a tarefa agendada	ByScheduledTaskInstance
Condition	string	Não	A causa do hook. Quando essa causa é atendida, a ação de hook é acionada. Atualmente, apenas os dois tipos de expressões condicionais a seguir são suportados: Especifique apenas um grupo de níveis de gravidade de regra e status de verificação de regra, como `${severity} == "High" AND ${status} == "Critical"`. Isso indica que, se o resultado da verificação de uma regra executada com a gravidade High for Critical, a condição será atendida. Especifique vários grupos de níveis de gravidade de regra e status de verificação de regra, como `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. Isso indica que, se o resultado da verificação de uma regra executada com a gravidade High for Critical, o resultado da verificação de uma regra executada com a gravidade Normal for Critical, ou o resultado da verificação de uma regra executada com a gravidade Normal for Error, a condição será atendida. Os valores de enumeração de gravidade na expressão condicional são consistentes com aqueles em DataQualityRule, e os valores de enumeração de status são consistentes com aqueles em DataQualityResult.	${severity} == "High" AND ${status} == "Critical"
Notifications	object	Não	A configuração de assinatura de notificações.
Condition	string	Não	A causa da notificação. Quando essa causa é atendida, uma notificação de mensagem é acionada. Atualmente, apenas os dois tipos de expressões condicionais a seguir são suportados: Especifique apenas um grupo de níveis de gravidade de regra e status de verificação de regra, como `${severity} == "High" AND ${status} == "Critical"`. Isso indica que, se o resultado da verificação de uma regra executada com a gravidade High for Critical, a condição será atendida. Especifique vários grupos de níveis de gravidade de regra e status de verificação de regra, como `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. Isso indica que, se o resultado da verificação de uma regra executada com a gravidade High for Critical, o resultado da verificação de uma regra executada com a gravidade Normal for Critical, ou o resultado da verificação de uma regra executada com a gravidade Normal for Error, a condição será atendida. Os valores de enumeração de gravidade na expressão condicional são consistentes com aqueles em DataQualityRule, e os valores de enumeração de status são consistentes com aqueles em DataQualityResult.	${severity} == "High" AND ${status} == "Critical"
Notifications	array<object>	Não	As configurações de notificação.
	array<object>	Não	As configurações de notificação.
NotificationReceivers	array<object>	Não	As configurações de destinatários de alertas.
	object	Não	As configurações de destinatários de alertas.
ReceiverType	string	Não	O tipo de destinatário do alerta. Valores válidos: WebhookUrl : URL de webhook personalizado. FeishuUrl : URL de notificação do Lark. DingdingUrl : URL do chatbot do grupo do DingTalk. WeixinUrl : URL de notificação do WeChat. AliUid : ID de usuário do Alibaba Cloud.	DingdingUrl
Extension	string	Não	As configurações de parâmetros adicionais quando um alerta é enviado. Este parâmetro está no formato JSON. Chaves suportadas: atAll: especifica se deve mencionar @all no grupo ao enviar um alerta do DingTalk. Esta chave tem efeito apenas quando ReceiverType é definido como DingdingUrl.	{ "atAll": true }
ReceiverValues	array	Não	Os destinatários do alerta.
	string	Não	O valor do destinatário. Quando o tipo de destinatário é ID do Alibaba Cloud, o valor é o ID de usuário específico do Alibaba Cloud. Quando o tipo de destinatário é DingdingUrl, o valor é a URL de alerta específica do chatbot do DingTalk. Quando o tipo de destinatário é WeixinUrl, o valor é a URL de alerta específica do WeCom. Quando o tipo de destinatário é FeishuUrl, o valor é a URL de alerta específica do Lark. Quando o tipo de destinatário é WebhookUrl, o valor é a URL de alerta específica do webhook personalizado.	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	Não	Os métodos de notificação.
	object	Não	Os métodos de notificação.
Channels	array	Não	Os métodos de notificação.
	string	Não	O método de notificação. Valores válidos: Dingding: chatbot do grupo do DingTalk Mail: e-mail Weixin: notificação do WeChat Feishu: notificação do Lark Phone: chamada telefônica Sms: mensagem de texto Webhook: webhook personalizado	Mail
DataSourceId	integer	Não	O ID da fonte de dados. Você pode chamar a operação ListDataSources para obter o ID da fonte de dados.	358750
DataQualityRules	array<object>	Não	A lista de regras de qualidade de dados associadas ao monitoramento de qualidade de dados.
	array<object>	Não
Name	string	Não	O nome da regra de qualidade de dados.	OpenAPI test rules
Enabled	boolean	Não	Especifica se a regra de qualidade de dados está ativada.	true
Severity	string	Não	O nível de gravidade da regra para o negócio, que corresponde às regras fortes e fracas na página. Valores válidos: Normal Alto Valores válidos: High : Alto. Normal : Normal.	Normal
Description	string	Não	A descrição da regra de qualidade de dados.	OpenAPI test rules
TemplateCode	string	Não	O identificador exclusivo do modelo de regra referenciado pela regra.	SYSTEM:field:null_value:fixed:0
SamplingConfig	object	Não	Os parâmetros necessários para a coleta de amostras.
Metric	string	Não	O nome da métrica amostrada. Valores válidos: Count: o número de linhas na tabela Min: o valor mínimo do campo Max: o valor máximo do campo Avg: o valor médio do campo DistinctCount: o número de valores exclusivos no campo DistinctPercent: a proporção do número de valores exclusivos no campo em relação ao número total de linhas DuplicatedCount: o número de valores duplicados no campo DuplicatedPercent: a proporção do número de valores duplicados no campo em relação ao número total de linhas TableSize: o tamanho da tabela NullValueCount: o número de linhas em que o campo é nulo NullValuePercent: a proporção de linhas em que o campo é nulo GroupCount: o número de linhas correspondentes a cada valor após a agregação pelo valor do campo CountNotIn: o número de linhas que não correspondem aos valores enumerados CountDistinctNotIn: o número de valores exclusivos que não correspondem aos valores enumerados UserDefinedSql: coleta de amostras usando instruções SQL personalizadas	CountNotIn
MetricParameters	string	Não	Os parâmetros necessários para a coleta de amostras.	{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}
SettingConfig	string	Não	As instruções de configuração de parâmetros de tempo de execução inseridas antes da execução das instruções de amostragem. O comprimento máximo é de 1.000 caracteres. Apenas o MaxCompute é suportado.	odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True
SamplingFilter	string	Não	As condições usadas para filtrar dados desnecessários durante a amostragem. O comprimento máximo é de 16.777.215 caracteres.	status != 'Succeeded'
CheckingConfig	object	Não	As configurações de verificação de amostras.
Type	string	Não	O método de cálculo de limite. Valores válidos: Fluctation: verificação de intervalo de flutuação Auto: verificação de limite inteligente FluctationDiscreate: verificação de intervalo de flutuação de valor discreto Average: verificação de intervalo de flutuação média Fixed: verificação de valor fixo	Fixed
ReferencedSamplesFilter	string	Não	A expressão usada para especificar o método de consulta para amostras de referência. Alguns tipos de limite exigem a consulta de amostras de referência e a agregação de seus valores para derivar o limite de comparação.	{"bizdate": ["-1"]}
Thresholds	object	Não	As configurações de limite de verificação.
Expected	object	Não	As configurações de limite esperado.
Operator	string	Não	O operador de comparação. Valores válidos: > >= < <= != =	=
Value	string	Não	O valor do limite.	0
Expression	string	Não	A expressão do limite. Para regras de flutuação, você deve usar uma expressão para representar o limite de flutuação. Exemplos: Aumento de flutuação maior que 0,01: $checkValue > 0.01 Diminuição de flutuação maior que 0,01: $checkValue < -0.01 Valor absoluto da taxa de flutuação: abs($checkValue) > 0.01 As regras de valor fixo também podem usar expressões para configurar limites. Se ambos estiverem configurados, a expressão terá precedência sobre Operator e Value.	$checkValue > 0.01
Warned	object	Não	As configurações de limite para avisos normais.
Operator	string	Não	O operador de comparação. Valores válidos: > >= < <= != =	>
Value	string	Não	O valor do limite.	0.001
Expression	string	Não	A expressão do limite. Para regras de flutuação, você deve usar uma expressão para representar o limite de flutuação. Exemplos: Aumento de flutuação maior que 0,01: $checkValue > 0.01 Diminuição de flutuação maior que 0,01: $checkValue < -0.01 Valor absoluto da taxa de flutuação: abs($checkValue) > 0.01 As regras de valor fixo também podem usar expressões para configurar limites. Se ambos estiverem configurados, a expressão terá precedência sobre Operator e Value.	$checkValue > 0.01
Critical	object	Não	As configurações de limite para avisos críticos.
Operator	string	Não	O operador de comparação. Valores válidos: > >= < <= != =	>
Value	string	Não	O valor do limite.	0.01
Expression	string	Não	A expressão do limite. Para regras de flutuação, você deve usar uma expressão para representar o limite de flutuação. Exemplos: Aumento de flutuação maior que 0,01: $checkValue > 0.01 Diminuição de flutuação maior que 0,01: $checkValue < -0.01 Valor absoluto da taxa de flutuação: abs($checkValue) > 0.01 As regras de valor fixo também podem usar expressões para configurar limites. Se ambos estiverem configurados, a expressão terá precedência sobre Operator e Value.	$checkValue > 0.01
ErrorHandlers	array<object>	Não	Os manipuladores de erros para problemas de verificação de regras de qualidade.
	object	Não
Type	string	Não	O tipo de manipulador. Valores válidos: SaveErrorData: reter dados de erro	SaveErrorData
ErrorDataFilter	string	Não	A instrução SQL usada para filtrar dados de erro. Este parâmetro é obrigatório se a regra for uma regra SQL personalizada.	SELECT * FROM ods_d_openapi_log WHERE status = 'Error'
Id	integer	Não	O ID da regra de verificação. Você pode chamar a operação ListQualityRules para obter o ID da regra.	1022171560
Id	integer	Sim	O ID da tarefa de monitoramento de qualidade de dados.	7227061794

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	8abcb91f-d266-4073-b907-2ed670378ed1

Exemplos

Resposta de sucesso

JSON formato

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

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.