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

Consulta a lista de regras de qualidade com base em uma expressão de partição.

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.

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 resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectName	string	Sim	O nome do mecanismo DPI ou da fonte de dados. Você pode obter o nome na configuração da fonte de dados.	autotest
EntityId	integer	Sim	O ID da expressão de partição. Você pode chamar a operação GetQualityEntity para obter o ID.	12345
PageNumber	integer	Sim	O número da página.	1
PageSize	integer	Sim	O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valor máximo: 20.	20
ProjectId	integer	Sim	O ID do espaço de trabalho do DataWorks.	12345

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação, que é usado para solução de problemas.	38cbdef0-f6cf-49****
ErrorMessage	string	A mensagem de erro.	You have no permission.
Success	boolean	Especifica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.	true
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Data	object	A lista de regras.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas retornadas em cada página. Valor padrão: 10. Valor máximo: 20.	20
TotalCount	integer	O número total de entradas retornadas.	400
Rules	array<object>	Os detalhes das regras de qualidade.
	object	A estrutura de dados da regra retornada.
BlockType	integer	A severidade da regra de qualidade, que indica a importância da regra. Valores válidos: 1: Regra forte. 0: Regra fraca. Você pode definir regras importantes como regras fortes com base nos seus requisitos de negócios. Se uma regra forte for acionada e um alerta vermelho for gerado, a tarefa agendada será bloqueada.	0
OnDutyAccountName	string	O nome da conta Alibaba Cloud que configurou a regra de qualidade.	test
Property	string	O nome do campo.	id
WarningThreshold	string	O limite de alerta para alerta laranja. Este valor indica o desvio em relação ao valor esperado da amostra. Você pode personalizar esse limite com base nos seus requisitos de negócios.	10
TableName	string	O nome da tabela.	dual
OnDuty	string	O ID da conta que configurou a regra de qualidade.	1912****
Comment	string	A descrição da regra.	Verify table rules
RuleCheckerRelationId	integer	O ID de associação interna dos detalhes da regra.	132323
FixCheck	boolean	A verificação de valor fixo.	true
MethodId	integer	O ID do método usado para coletar dados de amostra.	21
TemplateName	string	O nome do modelo de regra de qualidade usado.	Number of SQL task table rows, 1, 7, and 30 days wave detection
Trend	string	A tendência do resultado da verificação.	abs
HistoryWarningThreshold	string	O limite de alerta histórico para alerta laranja.	history max:40%,history min:10%
RuleType	integer	O tipo da regra. Valores válidos: 0: Regra de modelo do sistema. 1: Regra SQL personalizada. 4: Regra de modelo personalizada.	0
MatchExpression	string	A expressão de partição.	dt=$[yyyymmdd]
ProjectName	string	O nome do mecanismo ou da fonte de dados.	autotest
PropertyKey	string	A chave de propriedade usada para vinculação de regras de frontend na qualidade de dados. Você pode ignorar este campo.	table_count
CriticalThreshold	string	O limite de alerta para alerta vermelho. Este valor indica o desvio em relação ao valor esperado da amostra. Você pode personalizar esse limite com base nos seus requisitos de negócios. Se uma regra forte for acionada e o limite de alerta vermelho for atingido, a tarefa agendada será bloqueada.	40
HistoryCriticalThreshold	string	O limite de alerta histórico para alerta vermelho.	history max:80%,history min:50%
MethodName	string	O nome do método usado para coletar dados de amostra. Os valores válidos incluem avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count e table_count-count_distinct.	count/table_count
CheckerId	integer	O ID do verificador.	7
EntityId	integer	O ID da expressão de partição.	1234
ExpectValue	string	O valor esperado.	1000
TemplateId	integer	O ID do modelo de regra de qualidade usado.	7
Id	integer	O ID da regra.	1234
RuleName	string	O nome da regra.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "38cbdef0-f6cf-49****",
  "ErrorMessage": "You have no permission.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 400,
    "Rules": [
      {
        "BlockType": 0,
        "OnDutyAccountName": "test",
        "Property": "id",
        "WarningThreshold": "10",
        "TableName": "dual",
        "OnDuty": "1912****",
        "Comment": "Verify table rules",
        "RuleCheckerRelationId": 132323,
        "FixCheck": true,
        "MethodId": 21,
        "TemplateName": "Number of SQL task table rows, 1, 7, and 30 days wave detection",
        "Trend": "abs",
        "HistoryWarningThreshold": "history max:40%,history min:10%",
        "RuleType": 0,
        "MatchExpression": "dt=$[yyyymmdd]",
        "ProjectName": "autotest",
        "PropertyKey": "table_count",
        "CriticalThreshold": "40",
        "HistoryCriticalThreshold": "history max:80%,history min:50%",
        "MethodName": "count/table_count",
        "CheckerId": 7,
        "EntityId": 1234,
        "ExpectValue": "1000",
        "TemplateId": 7,
        "Id": 1234,
        "RuleName": "test"
      }
    ]
  }
}

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.