Todos os produtos
Search
Central de documentação

DataWorks:UpdateQualityRule

Última atualização: Sep 29, 2026

Chama UpdateQualityRule para atualizar as informações de uma regra de verificação 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.

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

BlockType

integer

Não

A força da regra de verificação de qualidade. A força indica a importância da regra. Valores válidos:\n- 1: regra forte.\n- 0: regra fraca.\nVocê pode definir regras importantes como regras fortes com base nos seus requisitos de negócios. Se uma regra forte for usada e um alerta vermelho for acionado, a tarefa de agendamento será bloqueada.

Valores válidos:

  • 0 :

    Regra fraca.

  • 1 :

    Regra forte.

0

EntityId

integer

Não

O ID da expressão de partição. Você pode chamar a operação ListQualityRules para obter o ID da expressão de partição.

123

Comment

string

Não

A descrição da regra de verificação de qualidade.

Verify the number of table rows

Checker

integer

Não

O ID do verificador.\n2: flutuação média de 7 dias.\n3: flutuação média de 30 dias.\n4: comparação de ciclo de 1 dia.\n5: comparação de ciclo de 7 dias.\n6: comparação de ciclo de 30 dias.\n7: flutuação de variância de 7 dias.\n8: flutuação de variância de 30 dias.\n9: comparação com um valor fixo.\n10: detecção de flutuação de 1, 7 e 30 dias.\n11: comparação com o ciclo anterior.\nVocê pode chamar a operação ListQualityRules para obter o ID do verificador.

9

ExpectValue

string

Não

O valor esperado do resultado da verificação.

300

Id

integer

Sim

O ID da regra de verificação de qualidade. Você pode chamar a operação ListQualityRules para obter o ID da regra.

1234

Trend

string

Não

A tendência do resultado da verificação. Valores válidos:\n- up: tendência de alta.\n- down: tendência de baixa.\n- abs: valor absoluto.

up

MethodName

string

Sim

O nome do método usado para coletar dados de amostra. Valores válidos: avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count e table_count-count_distinct.

table_count

Operator

string

Não

O operador de comparação. Valores válidos: >, >=, =, ≠, < e <=.\n\n> Quando Checker é definido como 9, Operator é um parâmetro obrigatório.

>

ProjectName

string

Sim

O nome do mecanismo ou da fonte de dados. Você pode fazer logon no console do DataWorks e acessar a página de gerenciamento de espaço de trabalho para obter o nome.

autotest

Property

string

Sim

O nome da coluna.

id

PropertyType

string

Não

O tipo da coluna.

bigint

RuleType

integer

Não

O tipo da regra. Valores válidos:\n- 0: regra de modelo do sistema.\n- 1: regra SQL personalizada.\n- 4: regra de modelo personalizada.

0

WhereCondition

string

Não

A condição de filtro ou instrução SQL personalizada usada pela tarefa de verificação.

dt=$[yyyymmdd]

CriticalThreshold

string

Não

O limite de alerta vermelho. Este valor indica o grau de desvio em relação ao valor de amostra esperado. Você pode personalizar esse limite com base nos seus requisitos de negócios. Se uma regra forte for usada e o limite vermelho for acionado, a tarefa de agendamento será bloqueada.

10

WarningThreshold

string

Não

O limite de alerta laranja. Este valor indica o grau de desvio em relação ao valor de amostra esperado. Você pode personalizar esse limite com base nos seus requisitos de negócios.

5

TemplateId

integer

Não

O ID do modelo de verificação. Você pode chamar a operação ListQualityRules para obter o ID do modelo de verificação.

7

RuleName

string

Não

O nome da regra de verificação de qualidade.

123

PredictType

integer

Não

Especifica se o limite é dinâmico. Valores válidos:\n- 0: limite não dinâmico.\n- 2: limite dinâmico.

0

OpenSwitch

boolean

Não

O status ativado ou desativado da regra, que controla se a regra de qualidade é executada no ambiente de produção.\n\n- true: Quando a tarefa de agendamento associada aos dados da tabela de saída da regra de qualidade de dados é executada, a verificação da regra de qualidade é acionada.\n\n- false: Quando a tarefa de agendamento associada aos dados da tabela de saída da regra de qualidade de dados é executada, a verificação da regra de qualidade não é acionada.

true

ProjectId

integer

Sim

O ID do espaço de trabalho do DataWorks.

26

TaskSetting

string

Não

As configurações de variáveis inseridas antes da regra personalizada, no formato x=a,y=b.

x=a,y=b

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

A estrutura da resposta.

HttpStatusCode

integer

O código de status HTTP.

200

Data

boolean

Indica se a regra de verificação de qualidade foi atualizada com sucesso.

true

ErrorMessage

string

A mensagem de erro.

You have no permission.

RequestId

string

O ID da solicitação. Você pode usar este ID para solucionar problemas.

576b9457-2cf5-4****

ErrorCode

string

O código de erro.

0

Success

boolean

Indica se a chamada foi bem-sucedida.

true

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "Você não tem permissão",
  "RequestId": "576b9457-2cf5-4****",
  "ErrorCode": "0",
  "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.