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

Cria uma regra de qualidade.

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

Você deve adquirir o DataWorks Basic Edition ou uma edição posterior 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

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
Name	string	Sim	O nome da regra.	The table cannot be empty.
ProjectId	integer	Sim	O ID do espaço de trabalho do DataWorks.	10726
Enabled	boolean	Não	Especifica se a regra de qualidade está ativada.	true
Severity	string	Não	O nível de gravidade da regra para operações de negócios, que corresponde a regras fortes e fracas na página. Valores válidos: Normal High	Normal
Description	string	Não	A descrição da regra. A descrição pode ter até 500 caracteres.	this is a odps _sql task
Target	object	Sim	O objeto monitorado pela regra.
Type	string	Não	O tipo de objeto monitorado. Valores válidos: Table	Table
DatabaseType	string	Sim	O tipo de banco de dados ao qual a tabela pertence. Este parâmetro é obrigatório quando o conjunto de dados é do tipo tabela. Valores válidos: maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	Sim	O ID exclusivo da tabela à qual a regra se aplica no Data Map.	odps.unit_test.tb_unit_test
PartitionSpec	string	Não	As configurações de partição da tabela particionada.	ds=$[yyyymmdd-1]
TemplateCode	string	Sim	O identificador exclusivo do modelo de regra referenciado pela regra.	SYSTEM:table:table_count:fixed
SamplingConfig	object	Não	As configurações necessárias para a coleta de amostras.
Metric	string	Não	O nome da métrica de amostragem. Este parâmetro não é obrigatório quando um modelo é usado. 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 por valor de 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.	Count
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 que são inseridas e executadas antes da execução das instruções de amostragem. As instruções podem ter até 1.000 caracteres. Apenas o MaxCompute é suportado.	SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;
SamplingFilter	string	Não	As condições usadas para filtrar dados desnecessários durante a amostragem. As condições podem ter até 16.777.215 caracteres.	id IS NULL
CheckingConfig	object	Não	As configurações de verificação de amostras.
Type	string	Não	O método de cálculo de limite. Este parâmetro não é obrigatório quando um modelo é usado. Valores válidos: Fixed Fluctation FluctationDiscreate Auto Average Variance	Fixed
ReferencedSamplesFilter	string	Não	Para alguns tipos de limites, as amostras de referência devem ser consultadas, e os valores das amostras de referência são agregados para obter o limite para comparação. Este parâmetro especifica uma expressão que representa o método de consulta para as amostras de referência.	{ "bizdate": [ "-1", "-7", "-1m" ] }
Thresholds	object	Não	As configurações de limite.
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.	100.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 Você também pode usar uma expressão para configurar o limite para regras de valor fixo. 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 comuns.
Operator	string	Não	O operador de comparação. Valores válidos: > >= < <= != =	>
Value	string	Não	O valor do limite.	100.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 Você também pode usar uma expressão para configurar o limite para regras de valor fixo. 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.	100.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 Você também pode usar uma expressão para configurar o limite para regras de valor fixo. Se ambos estiverem configurados, a expressão terá precedência sobre Operator e Value.	$checkValue > 0.05
ErrorHandlers	array<object>	Não	A lista de manipuladores para problemas de verificação de regras de qualidade.
	object	Não	O manipulador para problemas de verificação de regras de qualidade.
Type	string	Não	O tipo de manipulador. Valores válidos: SaveErrorData	SaveErrorData
ErrorDataFilter	string	Não	Se a regra for uma regra SQL personalizada, você deve especificar uma instrução SQL para filtrar os dados problemáticos.	SELECT * FROM tb_api_log WHERE id IS NULL

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O valor de retorno.
RequestId	string	O ID da solicitação de API.	691CA452-D37A-4ED0-9441
Id	integer	O ID da regra.	19715

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "691CA452-D37A-4ED0-9441\n",
  "Id": 19715
}

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.