Todos os produtos
Search

Este produto

    DataWorks:CreateDataQualityRuleTemplate

    Central de documentação

    DataWorks:CreateDataQualityRuleTemplate

    Última atualização: Sep 29, 2026

    Cria um modelo de regra.

    Nota

    Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - CreateDataQualityTemplate 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 superior 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 do modelo de regra. O nome pode conter dígitos, letras, caracteres chineses e sinais de pontuação de meia largura ou largura completa. O nome pode ter até 512 caracteres de comprimento.

    Table row Count Verification

    ProjectId

    integer

    Sim

    O ID do espaço de trabalho do DataWorks.

    12345
    VisibleScope

    string

    Não

    O escopo de visibilidade do modelo. Valores válidos:

    • Tenant: disponível para todo o tenant.

    • Project: disponível apenas no projeto atual.

    Valores válidos:

    • Project :

      Disponível apenas no projeto atual.

    • Tenant :

      Disponível para todo o tenant.

    Project
    DirectoryPath

    string

    Não

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

    /ods/order_data

    SamplingConfig

    object

    Sim

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

    Metric

    string

    Não

    O nome da métrica de amostragem. 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 em uma coluna.

    • DistinctPercent: a proporção de valores distintos em relação ao número total de linhas.

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

    • DuplicatedPercent: a proporção de valores duplicados em relação ao número total de linhas.

    • TableSize: o tamanho da tabela.

    • NullValueCount: o número de linhas em que o valor da coluna é nulo.

    • NullValuePercent: a proporção de linhas em que o valor da coluna é nulo.

    • GroupCount: a contagem de linhas para cada valor após a agregação pelo valor da coluna.

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

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

    • UserDefinedSql: coleta de amostras por meio de uma instrução SQL personalizada.

    Count
    MetricParameters

    string

    Sim

    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 a serem executadas antes da instrução de amostragem. O valor pode ter até 1000 caracteres de comprimento. Atualmente, apenas o MaxCompute é suportado.

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

    CheckingConfig

    object

    Não

    As configurações de verificação de amostras.

    Type

    string

    Sim

    O método de cálculo de limite. Valores válidos:

    • Fixed

    • Fluctation

    • FluctationDiscreate

    • Auto

    • Average

    • Variance

    Fixed
    ReferencedSamplesFilter

    string

    Não

    Uma expressão que especifica como consultar amostras de referência. Alguns tipos de limite exigem a consulta de amostras de referência e, em seguida, a agregação de seus valores para derivar o limite para comparação.

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

    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

    Code

    string

    O código do modelo de regra.

    UserDefined:3001

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "691CA452-D37A-4ED0-9441\n",
  "Code": "UserDefined:3001"
}

    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.