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

Consulta uma lista de modelos de regras de qualidade de dados.

Nota

Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - ListDataQualityTemplates 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
ProjectId	integer	Sim	O ID do workspace do DataWorks.	10000
CreationSource	string	Sim	A origem de criação do modelo de regra. Este parâmetro é obrigatório. Valores válidos: System: modelo do sistema. UserDefined: modelo definido pelo usuário.	System
DirectoryPath	string	Não	O diretório de categorias onde o modelo personalizado está armazenado. Os níveis são separados por barras (/). Cada nome de nível pode ter até 1024 caracteres e não pode conter espaços em branco ou barras invertidas.	/ods/order_data
Name	string	Não	A correspondência aproximada para o nome da regra do modelo. Se o modelo for um modelo do sistema, a correspondência aproximada será feita com base no nome internacionalizado do modelo, conforme o idioma.	Table rows
PageNumber	integer	Sim	O tamanho da página para a consulta paginada. Valor padrão: 10.	10
PageSize	integer	Sim	O número da página para a consulta paginada. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros da resposta.
RequestId	string	O ID da solicitação.	691CA452-D37A-****
PagingInfo	object	O resultado paginado da consulta paginada de modelos de regras de qualidade de dados.
TotalCount	integer	O número total de entradas.	42
PageSize	integer	O tamanho da página.	10
PageNumber	integer	O número da página.	1
DataQualityRuleTemplates	array<object>	A lista de modelos de regras.
	array<object>	Os detalhes de um modelo de regra.
Code	string	O código do modelo de regra.	USER_DEFINED:123
Name	string	O nome do modelo de regra. Pode ser uma combinação de dígitos, letras, caracteres chineses e sinais de pontuação de meia largura ou largura total, com até 512 caracteres.	Table row Count Verification
ProjectId	integer	O ID do workspace do DataWorks.	2043
SamplingConfig	object	As configurações necessárias para a coleta de amostras.
Metric	string	O nome da métrica de amostragem. Count: o número de linhas da tabela Min: o valor mínimo do campo Max: o valor máximo do campo Avg: o valor médio do campo DistinctCount: o número de valores únicos do campo DistinctPercent: a proporção entre o número de valores únicos do campo e o número de linhas de dados DuplicatedCount: o número de valores duplicados do campo DuplicatedPercent: a proporção entre o número de valores duplicados do campo e o número de linhas de dados TableSize: o tamanho da tabela NullValueCount: o número de linhas nas quais o campo é nulo NullValuePercent: a proporção de linhas nas quais o campo é nulo GroupCount: cada valor e o número correspondente de linhas de dados após agregação por valor do campo CountNotIn: o número de linhas nas quais o valor de enumeração não corresponde CountDistinctNotIn: o número de valores únicos nos quais o valor de enumeração não corresponde UserDefinedSql: coleta amostras usando SQL personalizado.	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. Este parâmetro pode ter até 1.000 caracteres. Atualmente, 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 do limite. Fixed Fluctation FluctationDiscreate Auto Average Variance.	Fixed
ReferencedSamplesFilter	string	Alguns tipos de limites exigem que amostras de referência sejam consultadas e, em seguida, os valores das amostras de referência são agregados para obter o limite para comparação. Uma expressão é usada aqui para indicar o método de consulta das amostras de referência.	{ "bizdate": [ "-1", "-7", "-1m" ] }
VisibleScope	string	O escopo de disponibilidade do modelo: Tenant: disponível para todos os tenants 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 até 1.024 caracteres e não pode conter espaços em branco ou barras.	/ods/order_data

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "691CA452-D37A-****",
  "PagingInfo": {
    "TotalCount": 42,
    "PageSize": 10,
    "PageNumber": 1,
    "DataQualityRuleTemplates": [
      {
        "Code": "USER_DEFINED:123",
        "Name": "Table row Count Verification\n",
        "ProjectId": 2043,
        "SamplingConfig": {
          "Metric": "Max",
          "MetricParameters": "{\"Sql\": \"select count(1) from table;\"}\n",
          "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.