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

Cria um monitor de qualidade de dados.

Descrição da operação

Requer o DataWorks Basic Edition 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 espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do espaço de trabalho para obter o ID do espaço de trabalho. Este parâmetro é obrigatório para especificar o espaço de trabalho do DataWorks de destino para esta operação de API.	101
Owner	string	Não	O ID do usuário que possui o monitor de qualidade de dados.	95279527****
Spec	string	Não	Código de especificação do conteúdo do monitor de qualidade de dados. Para obter mais informações, consulte Descrição da configuração de especificação 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 do monitor de qualidade de dados.
	object	Não	A definição dos parâmetros de execução do monitor de qualidade de dados.
Value	string	Não	Os valores dos parâmetros.	$[yyyymmdd-1]
Name	string	Não	O nome do parâmetro.	triggerTime
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.	0525242e-d0ee-4bda-bc73-765d82f6a34a
Cu	number	Não	O número de CUs configuradas para a execução da tarefa.	0.25
Image	string	Não	O ID da imagem configurada para a execução da tarefa.	i-xxxxxx
ComputeResource	object	Não	O mecanismo de computação usado em tempo de execução. Se não for especificado, a fonte de dados definida na especificação será usada.
Name	string	Não	O nome do mecanismo de computação, que é um identificador exclusivo.	emr_first
Runtime	object	Não	Configurações adicionais para o monitor de qualidade de dados em tempo de execução.
Engine	string	Não	O tipo do mecanismo de computação. Apenas os mecanismos de computação EMR suportam essas configurações. 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.	spark.yarn.queue=dq_queue
HiveConf	object	Não	Parâmetros adicionais do mecanismo Hive. Atualmente, apenas o parâmetro mapreduce.job.queuename é suportado.	mapreduce.job.queuename=dq_queue
EnvType	string	Não	O ambiente do espaço de trabalho ao qual o mecanismo de computação pertence. Valores válidos: Prod: ambiente de produção. Dev: ambiente de desenvolvimento.	Dev
Trigger	object	Não	As configurações de acionamento da tarefa do monitor de qualidade de dados.
Type	string	Não	O modo de acionamento da tarefa de monitoramento. Valores válidos: ByManual: acionamento manual. Esta é a configuração padrão. BySchedule: acionado por uma instância de tarefa agendada.	BySchedule
TaskIds	array	Não	Se o modo de acionamento estiver definido como BySchedule, o ID da tarefa de agendamento deverá ser especificado.
	integer	Não	O ID da tarefa de agendamento.	1004979033
Hooks	array<object>	Não	As configurações de hook após a conclusão da execução do monitor de qualidade de dados.
	object	Não	As configurações de hook após a conclusão da execução do monitor de qualidade de dados.
Condition	string	Não	A condição de acionamento do hook. O hook será executado se a condição for atendida. Atualmente, apenas um tipo de sintaxe de expressão é suportado: Você pode especificar várias combinações de níveis de gravidade de regra e status de validação usando uma expressão 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' }`. Esta expressão significa que a condição é atendida se qualquer regra executada tiver um resultado de Fail com gravidade Normal, Error com gravidade High ou Warn com gravidade High. Na expressão de condição, os valores de gravidade e status são enums predefinidos. Os valores de gravidade devem corresponder aos definidos na especificação, e os valores de status devem corresponder aos do 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
ClientToken	string	Sim	O token de idempotência.	a-customized-uuid

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	0000-ABCD-EFG****
Id	integer	Retorna o ID da regra de compartilhamento de fonte de dados criada, que identifica exclusivamente a regra.	676303114031776

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0000-ABCD-EFG****",
  "Id": 676303114031776
}

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.