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

Obtém informações sobre uma regra de qualidade.

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

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RuleId	integer	Sim	O ID da regra de qualidade. Você pode chamar a operação ListQualityRules para obter o ID.	1234
ProjectName	string	Sim	O nome do mecanismo ou da fonte de dados.	autotest
ProjectId	integer	Não	O ID do workspace do DataWorks.	12345

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura de dados da resposta.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação.	576b9457-2cf5-4****
ErrorMessage	string	A mensagem de erro.	You have no permission.
ErrorCode	string	O código de erro.	401
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	Os detalhes da regra de qualidade.
BlockType	integer	A severidade da regra de qualidade. Valores válidos: `1`: Regra forte. Se uma regra forte acionar um alerta crítico, a tarefa de agendamento associada será bloqueada. `0`: Regra fraca.	1
OnDutyAccountName	string	O nome da conta Alibaba Cloud que configurou a regra.	test
WarningThreshold	string	O limite para um alerta de aviso. Este valor especifica o desvio aceitável em relação ao valor esperado e pode ser personalizado.	10
Property	string	A coluna na tabela da fonte de dados à qual a regra se aplica.	id
RuleType	integer	O tipo da regra de qualidade. Valores válidos: `0`: Uma regra baseada em um modelo do sistema. `1`: Uma regra baseada em uma instrução SQL personalizada. `4`: Uma regra baseada em um modelo personalizado.	0
Comment	string	O comentário da regra.	Verify that the primary key is unique
OnDuty	string	O ID da conta Alibaba Cloud que configurou a regra.	1822931****
Checker	integer	O ID do verificador, que é convertido do pkId e usado para identificação no front-end.	9
FixCheck	boolean	Indica se a validação deve ser feita em relação a um valor fixo.	true
MethodId	integer	O ID do método usado para coletar dados de amostra.	8
CriticalThreshold	string	O limite de alerta vermelho, que indica o grau de desvio em relação ao valor de amostra esperado. Você pode personalizar esse limite com base nos seus requisitos de negócios. Se uma regra forte acionar o limite vermelho, a tarefa de agendamento será bloqueada.	20
PredictType	integer	Indica se o limite é dinâmico. Valores válidos: `0`: O limite é estático. `1`: O limite é dinâmico.	0
TemplateName	string	O nome do modelo usado.	SQL task table rows, 1,7, 30 days fluctuation test
CheckerName	string	O nome do verificador.	compared with a fixed value
RuleName	string	O nome da regra.	View table fluctuations
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`.	table_count
EntityId	integer	O ID da expressão de partição.	165523
WhereCondition	string	A condição de filtro ou instrução SQL personalizada usada para validação.	id>10
Operator	string	O operador de comparação.	>=
ExpectValue	string	O valor esperado.	30
Trend	string	A tendência do resultado da validação.	abs
TemplateId	integer	O ID do modelo usado.	7
Id	integer	O ID da regra.	123232
OpenSwitch	boolean	Indica se a regra está ativada.	true
TaskSetting	string	As configurações de variáveis inseridas antes de uma regra personalizada. O formato é x=a,y=b.	x=a,y=b

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "576b9457-2cf5-4****",
  "ErrorMessage": "You have no permission.",
  "ErrorCode": "401",
  "Success": true,
  "Data": {
    "BlockType": 1,
    "OnDutyAccountName": "test",
    "WarningThreshold": "10",
    "Property": "id",
    "RuleType": 0,
    "Comment": "Verify that the primary key is unique",
    "OnDuty": "1822931****",
    "Checker": 9,
    "FixCheck": true,
    "MethodId": 8,
    "CriticalThreshold": "20",
    "PredictType": 0,
    "TemplateName": "SQL task table rows, 1,7, 30 days fluctuation test",
    "CheckerName": "compared with a fixed value",
    "RuleName": "View table fluctuations",
    "MethodName": "table_count",
    "EntityId": 165523,
    "WhereCondition": "id>10",
    "Operator": ">=",
    "ExpectValue": "30",
    "Trend": "abs",
    "TemplateId": 7,
    "Id": 123232,
    "OpenSwitch": true,
    "TaskSetting": "x=a,y=b\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.