Todos os produtos
Search
Central de documentação

DataWorks:ListQualityResultsByEntity

Última atualização: Sep 29, 2026

Usa ListQualityResultsByEntity para obter resultados de validação com base em uma expressão de partição.

Nota

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


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

EntityId

integer

Sim

O ID da expressão de partição. Você pode chamar a operação GetQualityEntity para obter este ID.

15232

StartDate

string

Sim

O início do intervalo de datas de negócio. O valor deve estar no formato yyyy-MM-dd HH:mm:ss.

2020-09-20 00:00:00

EndDate

string

Sim

O fim do intervalo de datas de negócio. O valor deve estar no formato yyyy-MM-dd HH:mm:ss.

2020-09-21 00:00:00

PageSize

integer

Sim

O número de entradas a serem retornadas por página. O valor padrão é 10 e o valor máximo é 20.

10

PageNumber

integer

Sim

O número da página a ser retornada.

1

ProjectName

string

Sim

O nome do mecanismo ou da fonte de dados. Você pode encontrar este nome na página Configuração de Fonte de Dados.

autotest

ProjectId

integer

Sim

O ID do workspace do DataWorks.

12345

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Os resultados da verificação de qualidade de dados.

HttpStatusCode

integer

O código de status HTTP.

200

ErrorMessage

string

A mensagem de erro.

You have no permission.

RequestId

string

O ID da solicitação.

CBA58543-00D4-41****

Success

boolean

Indica se a solicitação foi bem-sucedida.

true

ErrorCode

string

O código de erro.

401

Data

object

O objeto de dados que contém os resultados da verificação de qualidade.

PageNumber

integer

O número da página.

1

PageSize

integer

O número de entradas por página. Valor padrão: 10. Valor máximo: 100.

10

TotalCount

integer

O número total de entradas.

50

RuleChecks

array<object>

Os resultados da verificação das regras de monitoramento.

array<object>

O resultado da verificação.

BlockType

integer

A força da regra de monitoramento. Valores válidos:

  • 1: Regra forte. Se uma verificação de Regra forte gerar um alerta crítico, a Tarefa de Agendamento associada será bloqueada.

  • 0: Regra fraca.

0

WarningThreshold

number

O limite de alerta. Este valor indica o desvio aceitável em relação ao valor esperado. Você pode personalizar esse limite com base nos seus requisitos de negócio.

0.1

Property

string

O nome da coluna monitorada na tabela da fonte de dados.

type

TableName

string

O nome da tabela que é monitorada.

dual

Comment

string

A descrição da regra de monitoramento.

The description of the rule.

CheckResultStatus

integer

O status do resultado da verificação. Este parâmetro corresponde ao status exibido na interface do usuário. Valores válidos:

  • 0: Normal

  • 1: Alerta

  • 2: Crítico

0

TemplateName

string

O nome do modelo de regra.

Expected value verification

CheckerName

string

O nome do verificador.

fulx

RuleId

integer

O ID da regra de monitoramento.

123123232

FixedCheck

boolean

Especifica se a verificação é baseada em um valor fixo. Valores válidos:

  • true: A verificação é baseada em um valor fixo.

  • false: A verificação não é baseada em um valor fixo.

false

Op

string

O operador de comparação.

>

UpperValue

number

O limite superior previsto. Este valor é gerado automaticamente após você definir um limite.

25555

ActualExpression

string

A expressão que especifica a partição de dados que foi verificada.

ds=20200912

ExternalId

string

O ID do nó da Tarefa de Agendamento.

1112323123

TimeCost

string

O tempo gasto para executar a verificação, em segundos.

202

Trend

string

A tendência do resultado da verificação.

abs

ExternalType

string

O tipo do sistema de agendamento. Atualmente, apenas o CWF é suportado.

CWF2

BizDate

integer

A data de negócio. Se os dados monitorados forem offline, a data de negócio geralmente é o dia anterior à realização da verificação.

1600704000000

CheckResult

integer

O resultado da verificação. Este parâmetro geralmente tem o mesmo valor que CheckResultStatus. Valores válidos:

  • 0: Normal

  • 1: Alerta

  • 2: Crítico

0

ResultString

string

O resultado da verificação, retornado como uma string.

test

MatchExpression

string

A expressão de filtro de partição.

ds=$[yyyymmdd]

CheckerType

integer

O tipo do verificador. Valores válidos:

  • 0: Valor fixo

  • 1: Flutuação

  • 2: Limite dinâmico

1

ProjectName

string

O nome do mecanismo de computação ou da fonte de dados monitorada.

autotest

BeginTime

integer

A hora de início da verificação. Este valor é um carimbo de data e hora UNIX que representa o número de milissegundos decorridos desde 1 de janeiro de 1970, 00:00:00 UTC.

1600704000000

DateType

string

O ciclo de agendamento. Um valor comum é YMD, que representa ano, mês e dia.

YMD

CriticalThreshold

number

O desvio aceitável em relação ao valor esperado que aciona um alerta crítico. Este limite é personalizável. Se um alerta crítico for acionado para uma Regra forte, a Tarefa de Agendamento associada será bloqueada.

0.5

IsPrediction

boolean

Especifica se o resultado é um valor previsto. Valores válidos:

  • true: O resultado é um valor previsto.

  • false: O resultado não é um valor previsto.

true

RuleName

string

O nome da regra de monitoramento.

The name of the rule.

CheckerId

integer

O ID do verificador.

7

DiscreteCheck

boolean

Especifica se a verificação é uma verificação discreta. Valores válidos:

  • true: A verificação é uma verificação discreta.

  • false: A verificação não é uma verificação discreta.

true

EndTime

integer

A hora de fim para consulta dos resultados da verificação.

1600704000000

MethodName

string

O método para coleta de 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_distinct

LowerValue

number

O limite inferior previsto. Este valor é gerado automaticamente após você definir um limite.

2344

EntityId

integer

O ID da expressão de filtro de partição.

15432322

WhereCondition

string

A condição de filtro da regra de monitoramento.

id>0

ExpectValue

number

O valor esperado.

200

TemplateId

integer

O ID do modelo de regra.

5

TaskId

string

O ID da tarefa de verificação.

16008552981681a0d6****

Id

integer

O ID exclusivo do resultado da verificação.

121212121

ReferenceValue

array<object>

Os valores de amostra históricos.

object

Um resultado de verificação histórico.

DiscreteProperty

string

O valor do campo de amostra quando uma cláusula group by é usada. Por exemplo, se você agrupar pelo campo de gênero, os valores para DiscreteProperty podem ser masculino, feminino ou nulo.

0

Value

number

O valor de verificação histórico.

19

BizDate

string

A data de negócio. Se os dados monitorados forem offline, a data de negócio geralmente é o dia anterior à realização da verificação.

2020-12-03

SingleCheckResult

integer

O resultado de uma única verificação.

0

Threshold

number

O limite que foi aplicado a este ponto de dados histórico.

0.5

SampleValue

array<object>

Os valores de amostra atuais.

object

Um resultado de verificação de amostra.

DiscreteProperty

string

O valor do campo de amostra quando uma cláusula group by é usada. Por exemplo, se você agrupar pelo campo de gênero, os valores para DiscreteProperty podem ser masculino, feminino ou nulo.

0

BizDate

string

A data de negócio. Se os dados monitorados forem offline, a data de negócio geralmente é o dia anterior à realização da verificação.

2020-12-03

Value

number

O valor de amostra atual.

19

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "You have no permission.",
  "RequestId": "CBA58543-00D4-41****",
  "Success": true,
  "ErrorCode": "401",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 50,
    "RuleChecks": [
      {
        "BlockType": 0,
        "WarningThreshold": 0.1,
        "Property": "type",
        "TableName": "dual",
        "Comment": "The description of the rule.",
        "CheckResultStatus": 0,
        "TemplateName": "Expected value verification",
        "CheckerName": "fulx",
        "RuleId": 123123232,
        "FixedCheck": false,
        "Op": ">",
        "UpperValue": 25555,
        "ActualExpression": "ds=20200912",
        "ExternalId": "1112323123",
        "TimeCost": "202",
        "Trend": "abs",
        "ExternalType": "CWF2",
        "BizDate": 1600704000000,
        "CheckResult": 0,
        "ResultString": "test",
        "MatchExpression": "ds=$[yyyymmdd]",
        "CheckerType": 1,
        "ProjectName": "autotest",
        "BeginTime": 1600704000000,
        "DateType": "YMD",
        "CriticalThreshold": 0.5,
        "IsPrediction": true,
        "RuleName": "The name of the rule.",
        "CheckerId": 7,
        "DiscreteCheck": true,
        "EndTime": 1600704000000,
        "MethodName": "count_distinct",
        "LowerValue": 2344,
        "EntityId": 15432322,
        "WhereCondition": "id>0",
        "ExpectValue": 200,
        "TemplateId": 5,
        "TaskId": "16008552981681a0d6****",
        "Id": 121212121,
        "ReferenceValue": [
          {
            "DiscreteProperty": "0",
            "Value": 19,
            "BizDate": "2020-12-03",
            "SingleCheckResult": 0,
            "Threshold": 0.5
          }
        ],
        "SampleValue": [
          {
            "DiscreteProperty": "0",
            "BizDate": "2020-12-03",
            "Value": 19
          }
        ]
      }
    ]
  }
}

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.