Todos os produtos
Search

Este produto

    DataWorks:GetDataQualityRuleTemplate

    Central de documentação

    DataWorks:GetDataQualityRuleTemplate

    Última atualização: Sep 29, 2026

    Consulta os detalhes de um modelo de regra de qualidade de dados.

    Nota

    Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - GetDataQualityTemplate 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 invocar esta operação apenas se tiver adquirido o DataWorks Basic Edition ou uma edição mais avançada.

    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

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os dados retornados.

    RequestId

    string

    O ID da solicitação.

    691CA452-D37A-4E****
    DataQualityRuleTemplate

    object

    Os detalhes do modelo de regra.

    Code

    string

    O código do modelo de regra.

    USER_DEFINED:123
    Name

    string

    O nome do modelo de regra. O nome pode ser uma combinação de dígitos, letras, caracteres chineses e marcas de pontuação de meia largura ou largura total. O nome pode ter no máximo 512 caracteres.

    Table row Count Verification
    ProjectId

    integer

    O ID do workspace do DataWorks.

    4020
    SamplingConfig

    object

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

    Metric

    string

    O nome da métrica a ser amostrada:

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

    • Min: o valor mínimo da coluna.

    • Max: o valor máximo da coluna.

    • Avg: o valor médio da coluna.

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

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

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

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

    • TableSize: o tamanho da tabela.

    • NullValueCount: o número de linhas em que a coluna é nula.

    • NullValuePercent: a porcentagem de linhas em que a coluna é nula.

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

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

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

    • UserDefinedSql: coleta amostras usando uma instrução SQL personalizada.

    Max
    MetricParameters

    string

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

    {"SQL": "select count(1) from table;"}
    SettingConfig

    string

    As instruções de configuração de parâmetros de tempo de execução que são inseridas e executadas antes da execução da instrução de amostragem específica. A configuração pode ter no máximo 1.000 caracteres. Apenas o MaxCompute é suportado.

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

    CheckingConfig

    object

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

    Type

    string

    O método de cálculo de limite:

    • Fixed

    • Fluctation

    • FluctationDiscreate

    • Auto

    • Average

    • Variance

    Fixed
    ReferencedSamplesFilter

    string

    Alguns tipos de limites exigem que você consulte amostras de referência e agregue os valores das amostras de referência para obter o limite para comparação. Uma expressão é usada para indicar o método de consulta das amostras de referência.

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

    VisibleScope

    string

    O escopo no qual o modelo está disponível:

    • Tenant: disponível para todo o tenant.

    • Project: disponível apenas no projeto atual.

    Project
    DirectoryPath

    string

    O diretório de categorias no qual o modelo personalizado está armazenado. Os níveis são separados por barras (/). Cada nome de nível pode ter no máximo 1.024 caracteres e não pode conter caracteres de espaço em branco ou barras (/).

    /ods/order_data

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "691CA452-D37A-4E****",
  "DataQualityRuleTemplate": {
    "Code": "USER_DEFINED:123",
    "Name": "Table row Count Verification",
    "ProjectId": 4020,
    "SamplingConfig": {
      "Metric": "Max",
      "MetricParameters": "{\"SQL\": \"select count(1) from table;\"}",
      "SettingConfig": "SET odps.sql.udf.timeout=600s; \nSET odps.sql.python.version=cp27;\n"
    },
    "CheckingConfig": {
      "Type": "Fixed",
      "ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }\n"
    },
    "VisibleScope": "Project",
    "DirectoryPath": "/ods/order_data"
  }
}

    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.