Todos os produtos
Search

Este produto

    DataWorks:UpdateDataQualityRuleTemplate

    Central de documentação

    DataWorks:UpdateDataQualityRuleTemplate

    Última atualização: Sep 29, 2026

    Atualiza um modelo de regra de qualidade de dados.

    Nota

    Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - UpdateDataQualityTemplate 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ê pode chamar esta operação somente após adquirir 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.

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    Code

    string

    Sim

    O código do modelo de regra.

    USER_DEFINED:123
    Name

    string

    Não

    O nome do modelo de regra. O nome pode conter dígitos, letras, caracteres chineses e caracteres de pontuação de meia largura e largura total. O nome pode ter até 512 caracteres.

    Table row Count Verification

    ProjectId

    integer

    Sim

    O ID do workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Gerenciamento de Workspaces para obter o ID.

    Este parâmetro especifica o workspace do DataWorks usado para esta chamada de API.

    10000
    DirectoryPath

    string

    Não

    O diretório de categoria no qual o modelo personalizado é armazenado. Os níveis são separados por barras (/). O nome de cada nível pode ter até 1024 caracteres e não pode conter caracteres de espaço em branco ou barras (/).

    /ods/order_data
    SamplingConfig

    object

    Não

    As configurações necessárias para a coleta de amostras.

    Metric

    string

    Não

    O nome da métrica a ser amostrada. Valores válidos:

    • Count: o número de linhas da tabela.

    • Min: o valor mínimo de uma coluna.

    • Max: o valor máximo de uma coluna.

    • Avg: o valor médio de uma coluna.

    • DistinctCount: o número de valores distintos de uma coluna.

    • DistinctPercent: a proporção do número de valores distintos de uma coluna em relação ao número de linhas de dados.

    • DuplicatedCount: o número de valores duplicados de uma coluna.

    • DuplicatedPercent: a proporção do número de valores duplicados de uma coluna em relação ao número de linhas de dados.

    • TableSize: o tamanho da tabela.

    • NullValueCount: o número de linhas nas quais a coluna é nula.

    • NullValuePercent: a porcentagem de linhas nas quais a coluna é nula.

    • GroupCount: o número de linhas de dados correspondentes a cada valor após a agregação dos valores da coluna.

    • CountNotIn: o número de linhas cujos valores não correspondem aos valores enumerados.

    • CountDistinctNotIn: o número de valores distintos que não correspondem aos valores enumerados.

    • UserDefinedSql: coleta de amostras usando SQL personalizado.

    Max
    MetricParameters

    string

    Não

    Os parâmetros necessários para a coleta de amostras.

    {"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. Somente o MaxCompute é suportado.

    SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;

    CheckingConfig

    object

    Não

    As configurações para validação de amostras.

    Type

    string

    Não

    O tipo do objeto monitorado. Valores válidos:

    • Table

    Table
    ReferencedSamplesFilter

    string

    Não

    Para alguns tipos de limites, você deve consultar amostras de referência e, em seguida, agregar os valores das amostras de referência para obter o limite usado para comparação. Uma expressão é usada aqui para indicar o método de consulta de amostras de referência.

    { "bizdate": [ "-1", "-7", "-1m" ] }

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os dados retornados.

    RequestId

    string

    O ID da solicitação.

    691CA452-D37A-4ED0-****

    Success

    boolean

    Indica se a atualização foi bem-sucedida.

    true

    Exemplos

    Resposta de sucesso

    JSON formato

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