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

Consulta os detalhes de uma regra de qualidade de dados.

Nota

Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - GetDataQualityScan 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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:*

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Sim	O ID da regra.	19715

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação de API.	691CA452-D37A-4ED0-****
DataQualityRule	object	Os detalhes da regra.
Id	integer	O ID da regra.	16033
Name	string	O nome da regra.	A tabela não pode estar vazia
ProjectId	integer	O ID do workspace do DataWorks.	1948
Enabled	boolean	Indica se a regra está ativada.	true
Severity	string	O nível de severidade da regra para negócios (correspondente a regras fortes e fracas na página). Valores válidos: Normal High	High
Description	string	A descrição da regra. A descrição pode ter até 500 caracteres.	esta é uma tarefa odps _sql
Target	object	O objeto monitorado pela regra.
Type	string	O tipo de objeto monitorado. Valores válidos: Table	Table
DatabaseType	string	O tipo de banco de dados da tabela para um conjunto de dados do tipo tabela. Valores válidos: maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	O ID exclusivo da tabela no Data Map à qual a regra se aplica.	odps.unit_test.tb_unit_test
PartitionSpec	string	As configurações de partição da tabela particionada.	ds=$[yyyymmdd-1]
TemplateCode	string	O identificador exclusivo do modelo de regra referenciado pela regra.	SYSTEM:table:table_count:fixed
SamplingConfig	object	As configurações necessárias para a coleta de amostras.
Metric	string	O nome da métrica de amostragem. Valores válidos: Count: o número de linhas da tabela. Min: o valor mínimo de um campo. Max: o valor máximo de um campo. Avg: o valor médio de um campo. DistinctCount: o número de valores exclusivos de um campo. DistinctPercent: a proporção do número de valores exclusivos de um campo em relação ao número de linhas de dados. DuplicatedCount: o número de valores duplicados de um campo. DuplicatedPercent: a proporção do número de valores duplicados de um campo em relação ao 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: o número de linhas de dados para cada valor após a agregação por valor de campo. CountNotIn: o número de linhas com valores de enumeração incompatíveis. CountDistinctNotIn: o número de valores exclusivos com valores de enumeração incompatíveis. UserDefinedSql: coleta de amostras por meio de SQL personalizado.	Max
MetricParameters	string	Os parâmetros necessários para a coleta de amostras.	{ "Columns": [ "id", "name" ] , "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 executadas antes da instrução de amostragem. O valor pode ter até 1.000 caracteres. Apenas o MaxCompute é suportado.	SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;
SamplingFilter	string	A condição de filtro usada para realizar filtragem secundária em dados irrelevantes durante a amostragem. O valor pode ter até 16.777.215 caracteres.	id IS NULL
CheckingConfig	object	As configurações de verificação de amostra.
Type	string	O método de cálculo de limite. Valores válidos: Fixed Fluctation FluctationDiscreate Auto Average Variance	Fixed
ReferencedSamplesFilter	string	Alguns tipos de limites exigem a consulta de amostras de referência e, em seguida, a agregação dos valores das amostras de referência para derivar o limite para comparação. Este campo usa uma expressão para especificar como consultar as amostras de referência.	{ "bizdate": [ "-1", "-7", "-1m" ] }
Thresholds	object	As configurações de limite.
Expected	object	As configurações de limite esperado.
Operator	string	O operador de comparação. Valores válidos: > >= < <= != =	>
Value	string	O valor do limite.	100.0
Expression	string	A expressão do limite.	$checkValue <= 0.01
Warned	object	As configurações de limite para avisos normais.
Operator	string	O operador de comparação. Valores válidos: > >= < <= != =	>
Value	string	O valor do limite.	100.0
Expression	string	A expressão do limite.	$checkValue > 0.01
Critical	object	As configurações de limite para avisos críticos.
Operator	string	O operador de comparação. Valores válidos: > >= < <= != =	>
Value	string	O valor do limite.	100.0
Expression	string	A expressão do limite.	$checkValue > 0.05
ErrorHandlers	array<object>	A lista de manipuladores de erros de verificação de regras de qualidade.
	object	O manipulador de erros de verificação de regras de qualidade.
Type	string	O tipo de manipulador. Valores válidos: SaveErrorData	SaveErrorData
ErrorDataFilter	string	A instrução SQL especificada pelo usuário para filtrar dados de erro. Isso é necessário para regras SQL personalizadas.	SELECT * FROM tb_api_log WHERE id IS NULL

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "691CA452-D37A-4ED0-****",
  "DataQualityRule": {
    "Id": 16033,
    "Name": "The table cannot be empty.\n",
    "ProjectId": 1948,
    "Enabled": true,
    "Severity": "High",
    "Description": "this is a odps _sql task\n",
    "Target": {
      "Type": "Table",
      "DatabaseType": "maxcompute",
      "TableGuid": "odps.unit_test.tb_unit_test\n",
      "PartitionSpec": "ds=$[yyyymmdd-1]\n"
    },
    "TemplateCode": "SYSTEM:table:table_count:fixed",
    "SamplingConfig": {
      "Metric": "Max",
      "MetricParameters": "{ \"Columns\": [ \"id\", \"name\" ] , \"SQL\": \"select count(1) from table;\"}",
      "SettingConfig": "SET odps.sql.udf.timeout=600s; \nSET odps.sql.python.version=cp27;\n",
      "SamplingFilter": "id IS NULL\n"
    },
    "CheckingConfig": {
      "Type": "Fixed",
      "ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }\n",
      "Thresholds": {
        "Expected": {
          "Operator": ">",
          "Value": "100.0",
          "Expression": "$checkValue <= 0.01"
        },
        "Warned": {
          "Operator": ">",
          "Value": "100.0",
          "Expression": "$checkValue > 0.01"
        },
        "Critical": {
          "Operator": ">",
          "Value": "100.0",
          "Expression": "$checkValue > 0.05"
        }
      }
    },
    "ErrorHandlers": [
      {
        "Type": "SaveErrorData\n",
        "ErrorDataFilter": "SELECT * FROM tb_api_log WHERE id IS NULL\n"
      }
    ]
  }
}

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.