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

Atualiza uma regra de qualidade.

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 uma edição posterior para usar esta operação.

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	Sim	O ID da regra.	100001
Name	string	Não	O nome da regra. O nome pode conter dígitos, letras, caracteres chineses e marcas de pontuação de meia largura ou largura total. Pode ter até 255 caracteres de comprimento.	Table cannot be empty
Enabled	boolean	Não	Especifica se a regra está ativada.	true
Severity	string	Não	O nível de gravidade da regra para o negócio, que corresponde à regra forte ou fraca na página. Valores válidos: Normal High	High
Description	string	Não	A descrição da regra. Pode ter até 500 caracteres de comprimento.	this is a odps _sql task
ProjectId	integer	Sim	O ID do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do workspace para obter o ID do workspace.	10000
TemplateCode	string	Não	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 é opcional quando um modelo é usado. Valores válidos: Count: número de linhas na tabela Min: valor mínimo do campo Max: valor máximo do campo Avg: valor médio do campo DistinctCount: número de valores exclusivos no campo DistinctPercent: proporção do número de valores exclusivos no campo em relação ao número de linhas de dados DuplicatedCount: número de valores duplicados no campo DuplicatedPercent: proporção do número de valores duplicados no campo em relação ao número de linhas de dados TableSize: tamanho da tabela NullValueCount: número de linhas em que o campo é nulo NullValuePercent: proporção de linhas em que o campo é nulo GroupCount: número de linhas de dados correspondentes a cada valor após a agregação por valor de campo CountNotIn: número de linhas que não correspondem aos valores enumerados CountDistinctNotIn: número de valores exclusivos que não correspondem aos valores enumerados UserDefinedSql: coleta de amostras usando instruções SQL personalizadas	Min
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. Pode ter até 1.000 caracteres de comprimento. Apenas o MaxCompute é suportado.	SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;
SamplingFilter	string	Não	A condição usada para filtrar dados desnecessários durante a amostragem. Pode ter até 16.777.215 caracteres de comprimento.	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 é opcional 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 usa uma expressão para especificar 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 de limite. Para regras de flutuação, você deve usar uma expressão para especificar 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 Para regras de valor fixo, você também pode usar uma expressão para configurar o limite. Se ambos estiverem configurados, a expressão terá precedência sobre os parâmetros 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 de limite. Para regras de flutuação, você deve usar uma expressão para especificar 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 Para regras de valor fixo, você também pode usar uma expressão para configurar o limite. Se ambos estiverem configurados, a expressão terá precedência sobre os parâmetros 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 de limite. Para regras de flutuação, você deve usar uma expressão para especificar 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 Para regras de valor fixo, você também pode usar uma expressão para configurar o limite. Se ambos estiverem configurados, a expressão terá precedência sobre os parâmetros Operator e Value.	$checkValue > 0.05
ErrorHandlers	array<object>	Não	A lista de manipuladores de erros para problemas de verificação de regras de qualidade.
	object	Não	O manipulador de erros para problemas de verificação de regras de qualidade.
Type	string	Não	O tipo do manipulador de erros. 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 de erro.	SELECT * FROM tb_api_log WHERE id IS NULL

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	691CA452-D37A-4ED0-9441
Success	boolean	Indica se a atualização foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "691CA452-D37A-4ED0-9441\n",
  "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.