ListQualityResultsByEntity - DataWorks - Centro de documentación de Alibaba Cloud

Obtiene los resultados de validación basados en una expresión de partición mediante `ListQualityResultsByEntity`.

Nota

Esta API se marcó como obsoleta. Se recomienda migrar a dataworks-public(2024-05-18) - ListDataQualityScanRuns para obtener funciones mejoradas y soporte continuo. Si bien la API obsoleta permanece accesible de forma temporal, no se entregarán nuevas actualizaciones ni correcciones de bugs.

Descripción de la operación

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
EntityId	integer	Sí	El ID de la expresión de partición. Puede llamar a la operación GetQualityEntity para obtener este ID.	15232
StartDate	string	Sí	El inicio del intervalo de fechas de negocio. El valor debe tener el formato `yyyy-MM-dd HH:mm:ss`.	2020-09-20 00:00:00
EndDate	string	Sí	El fin del intervalo de fechas de negocio. El valor debe tener el formato `yyyy-MM-dd HH:mm:ss`.	2020-09-21 00:00:00
PageSize	integer	Sí	El número de entradas que se devolverán por página. El valor predeterminado es 10 y el máximo es 20.	10
PageNumber	integer	Sí	El número de página que se devolverá.	1
ProjectName	string	Sí	El nombre del motor o del origen de datos. Puede encontrar este nombre en la página de configuración del origen de datos.	autotest
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks.	12345

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los resultados de la comprobación de calidad de los datos.
HttpStatusCode	integer	El código de estado HTTP.	200
ErrorMessage	string	El mensaje de error.	You have no permission.
RequestId	string	El ID de la solicitud.	CBA58543-00D4-41****
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorCode	string	El código de error.	401
Data	object	El objeto de datos que contiene los resultados de la comprobación de calidad.
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
TotalCount	integer	El número total de entradas.	50
RuleChecks	array<object>	Los resultados de la comprobación de las reglas de monitoreo.
	array<object>	El resultado de la comprobación.
BlockType	integer	La rigurosidad de la regla de monitoreo. Valores válidos: 1: Regla estricta. Si la comprobación de una regla estricta genera una alerta crítica, la tarea de programación asociada se bloquea. 0: Regla débil.	0
WarningThreshold	number	El umbral de advertencia. Este valor indica la desviación aceptable respecto al valor esperado. Puede personalizar este umbral según los requisitos de su negocio.	0.1
Property	string	El nombre de la columna monitoreada en la tabla del origen de datos.	type
TableName	string	El nombre de la tabla que se monitorea.	dual
Comment	string	La descripción de la regla de monitoreo.	The description of the rule.
CheckResultStatus	integer	El estado del resultado de la comprobación. Este parámetro corresponde al estado que se muestra en la interfaz de usuario. Valores válidos: 0: Normal 1: Advertencia 2: Crítico	0
TemplateName	string	El nombre de la plantilla de regla.	Expected value verification
CheckerName	string	El nombre del comprobador.	fulx
RuleId	integer	El ID de la regla de monitoreo.	123123232
FixedCheck	boolean	Especifica si la comprobación se basa en un valor fijo. Valores válidos: true: La comprobación se basa en un valor fijo. false: La comprobación no se basa en un valor fijo.	false
Op	string	El operador de comparación.	>
UpperValue	number	El límite superior predicho. Este valor se genera automáticamente después de configurar un umbral.	25555
ActualExpression	string	La expresión que especifica la partición de datos que se comprobó.	ds=20200912
ExternalId	string	El ID de nodo de la tarea de programación.	1112323123
TimeCost	string	El tiempo que tardó en ejecutarse la comprobación, en segundos.	202
Trend	string	La tendencia del resultado de la comprobación.	abs
ExternalType	string	El tipo de sistema de programación. Actualmente, solo se admite CWF.	CWF2
BizDate	integer	La fecha de negocio. Si los datos monitoreados están sin conexión, la fecha de negocio suele ser el día anterior a la ejecución de la comprobación.	1600704000000
CheckResult	integer	El resultado de la comprobación. Este parámetro suele tener el mismo valor que `CheckResultStatus`. Valores válidos: 0: Normal 1: Advertencia 2: Crítico	0
ResultString	string	El resultado de la comprobación, devuelto como una cadena.	test
MatchExpression	string	La expresión de filtro de partición.	ds=$[yyyymmdd]
CheckerType	integer	El tipo de comprobador. Valores válidos: 0: Valor fijo 1: Fluctuación 2: Umbral dinámico	1
ProjectName	string	El nombre del motor de cómputo o del origen de datos monitoreado.	autotest
BeginTime	integer	La hora de inicio de la comprobación. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970 a las 00:00:00 UTC.	1600704000000
DateType	string	El ciclo de programación. Un valor común es YMD, que representa año, mes y día.	YMD
CriticalThreshold	number	La desviación aceptable respecto al valor esperado que desencadena una alerta crítica. Este umbral es personalizable. Si se desencadena una alerta crítica para una regla estricta, la tarea de programación asociada se bloquea.	0.5
IsPrediction	boolean	Especifica si el resultado es un valor predicho. Valores válidos: true: El resultado es un valor predicho. false: El resultado no es un valor predicho.	true
RuleName	string	El nombre de la regla de monitoreo.	The name of the rule.
CheckerId	integer	El ID del comprobador.	7
DiscreteCheck	boolean	Especifica si la comprobación es una comprobación discreta. Valores válidos: true: La comprobación es una comprobación discreta. false: La comprobación no es una comprobación discreta.	true
EndTime	integer	La hora de fin para consultar los resultados de la comprobación.	1600704000000
MethodName	string	El método para recopilar datos de muestra. Los valores válidos incluyen `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` y `table_count-count_distinct`.	count_distinct
LowerValue	number	El límite inferior predicho. Este valor se genera automáticamente después de configurar un umbral.	2344
EntityId	integer	El ID de la expresión de filtro de partición.	15432322
WhereCondition	string	La condición de filtro de la regla de monitoreo.	id>0
ExpectValue	number	El valor esperado.	200
TemplateId	integer	El ID de la plantilla de regla.	5
TaskId	string	El ID de la tarea de comprobación.	16008552981681a0d6****
Id	integer	El ID único del resultado de la comprobación.	121212121
ReferenceValue	array<object>	Los valores de muestra históricos.
	object	Un resultado de comprobación histórico.
DiscreteProperty	string	El valor del campo de muestra cuando se utiliza una cláusula `group by`. Por ejemplo, si agrupa por el campo de género, los valores para `DiscreteProperty` pueden ser male, female o null.	0
Value	number	El valor de comprobación histórico.	19
BizDate	string	La fecha de negocio. Si los datos monitoreados están sin conexión, la fecha de negocio suele ser el día anterior a la ejecución de la comprobación.	2020-12-03
SingleCheckResult	integer	El resultado de una sola comprobación.	0
Threshold	number	El umbral que se aplicó a este punto de datos histórico.	0.5
SampleValue	array<object>	Los valores de muestra actuales.
	object	Un resultado de comprobación de muestra.
DiscreteProperty	string	El valor del campo de muestra cuando se utiliza una cláusula `group by`. Por ejemplo, si agrupa por el campo de género, los valores para `DiscreteProperty` pueden ser male, female o null.	0
BizDate	string	La fecha de negocio. Si los datos monitoreados están sin conexión, la fecha de negocio suele ser el día anterior a la ejecución de la comprobación.	2020-12-03
Value	number	El valor de muestra actual.	19

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.