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

Atualiza um monitor de qualidade de dados.

Descrição da operação

É necessária a edição Basic do DataWorks ou uma edição 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.

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Description	string	Não	A descrição do monitor de qualidade de dados.	Daily data quality scanning of ods tables.
ProjectId	integer	Não	O ID do workspace do DataWorks onde o monitor de qualidade de dados reside. Você pode obter o ID do workspace chamando a operação ListProjects.	101
Id	integer	Não	O ID do monitor de qualidade de dados.	10001
Owner	string	Não	O ID de usuário do proprietário do monitor de qualidade de dados.	231263586109857423
Spec	string	Não	O código Spec do conteúdo de monitoramento de qualidade de dados. Para mais informações, consulte Descrição da configuração do Spec de qualidade de dados.	{ "datasets": [ { "type": "Table", "dataSource": { "name": "odps_first", "envType": "Prod" }, "tables": [ "ods_d_user_info" ], "filter": "pt = $[yyyymmdd-1]" } ], "rules": [ { "assertion": "row_count > 0" }, { "templateId": "SYSTEM:field:null_value:fixed", "pass": "when = 0", "name": "The id cannot be empty.", "severity": "High", "identity": "a-customized-data-quality-rule-uuid" } ] }
Parameters	array<object>	Não	A definição dos parâmetros de execução para o monitor de qualidade de dados.
	object	Não	As informações do parâmetro.
Value	string	Não	O valor do parâmetro.	smtp.qiye.aliyun.com
Name	string	Não	O nome do parâmetro.	temp_237669.zip_byBwm_1734661241752
RuntimeResource	object	Não	O grupo de recursos usado durante a execução do monitor de qualidade de dados.
Id	string	Não	O ID do grupo de recursos.	20315
Cu	number	Não	O consumo de CU configurado para a execução da tarefa.	0.25
Image	string	Não	O ID da imagem da configuração de tempo de execução da tarefa.	i-xxxxxx
ComputeResource	object	Não	O mecanismo de computação usado durante a execução. Se não for especificado, a conexão da fonte de dados definida no Spec será usada.
Name	string	Não	O nome do mecanismo de computação, que é um identificador exclusivo.	auto_createAlertRule_Finished_1kUTk6
Runtime	object	Não	As configurações adicionais para o mecanismo de computação.
Engine	string	Não	O tipo de mecanismo. Essas configurações são suportadas apenas para o mecanismo de computação EMR. Valores válidos: Hive: Hive SQL Spark: Spark SQL Kyuubi	Hive
SparkConf	object	Não	Parâmetros adicionais do mecanismo Spark. Atualmente, apenas o parâmetro spark.yarn.queue é suportado para configurar a fila.	spark.yarn.queue=dq_queue
HiveConf	object	Não	Parâmetros adicionais do mecanismo Hive. Atualmente, apenas o parâmetro mapreduce.job.queuename é suportado para configurar a fila.	mapreduce.job.queuename=dq_queue
EnvType	string	Não	O ambiente de workspace do mecanismo de computação. Valores válidos: Prod Dev	Prod
Trigger	object	Não	As configurações de gatilho para o monitor de qualidade de dados.
Type	string	Não	O modo de gatilho do monitor de qualidade de dados. Valores válidos: ByManual: Acionado manualmente. Configuração padrão. BySchedule: Acionado por uma instância de tarefa agendada.	BySchedule
TaskIds	array	Não	Se o modo de gatilho for BySchedule, o ID da tarefa de agendamento que aciona o monitor deve ser configurado.
	integer	Não	O ID da tarefa de agendamento.	30001
Hooks	array<object>	Não	A configuração de hook após a interrupção do monitor de qualidade de dados.
	object	Não	A configuração de hook após a interrupção do monitor de qualidade de dados.
Condition	string	Não	A condição de acionamento do hook. Quando essa condição é atendida, o hook é acionado. Formato de expressão válido: Especifica várias combinações de níveis de gravidade de regra e status de validação de regra, como `results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' \|\| r.status == 'Error' && r.rule.severity == 'High' \|\| r.status == 'Warn' && r.rule.severity == 'High' }`. Isso significa que o hook é acionado se qualquer regra executada tiver Fail com gravidade Normal, Error com gravidade High ou Warn com gravidade High. Os valores de gravidade devem corresponder àqueles definidos no Spec. Os valores de status devem corresponder àqueles em DataQualityResult.	results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' \|\| r.status == 'Error' && r.rule.severity == 'High' \|\| r.status == 'Warn' && r.rule.severity == 'High' }
Type	string	Não	O tipo do hook. Valores válidos: BlockTaskInstance: Bloqueia o agendamento da instância da tarefa.	BlockTaskInstance
Name	string	Não	O nome do monitor de qualidade de dados.	data_quality_scan_001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	22C97E95-F023-56B5-8852-B1A77A1****
Success	boolean	Indica se a chamada foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A1****",
  "Success": true
}

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.