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

Consulta las reglas de monitoreo de calidad mediante paginación.

Nota

Esta API se marcó como obsoleta. Se recomienda migrar a dataworks-public(2024-05-18) - ListDataQualityScans 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

Debe adquirir DataWorks Basic Edition o una edición superior para utilizar esta funció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

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:*

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks.	10002
DataQualityEvaluationTaskId	integer	No	El ID de la tarea de verificación de calidad asociada.	10000
TableGuid	string	No	El identificador único de la tabla a la que se aplica la regla en el mapa de datos de DataWorks.	odps.unit_test.tb_unit_test
Name	string	No	El nombre de la regla para la coincidencia aproximada.	unit_test
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 200.	10
PageNumber	integer	Sí	El número de página para la paginación. Valor predeterminado: 1.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	691CA452-D37A-4ED0-9441
PagingInfo	object	El resultado de consulta paginado de la lista de reglas.
PageNumber	integer	El número de página.	1
PageSize	integer	El tamaño de página.	10
TotalCount	integer	El número total de entradas.	294
DataQualityRules	array<object>	La lista de reglas.
	array<object>
Id	integer	El ID de la regla.	22130
Name	string	El nombre de la regla.	La tabla no puede estar vacía
ProjectId	integer	El ID del espacio de trabajo de DataWorks.	100001
Enabled	boolean	Indica si la regla de calidad está habilitada.	true
Severity	string	El nivel de severidad de la regla para el negocio (corresponde a reglas fuertes/débiles en la página). Valores válidos: Normal High	High
Description	string	La descripción de la regla. Longitud máxima: 500 caracteres.	esta es una tarea odps _sql
Target	object	El objeto monitoreado por la regla.
Type	string	El tipo de objeto monitoreado. Table	Table
DatabaseType	string	El tipo de base de datos de la tabla para conjuntos de datos de tipo tabla. Valores válidos: maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	El ID único de la tabla a la que se aplica la regla en el mapa de datos de DataWorks.	odps.unit_test.tb_unit_test
TemplateCode	string	El identificador único de la plantilla de regla referenciada por la regla.	SYSTEM:user_defined_sql
SamplingConfig	object	La configuración requerida para la recolección de muestras.
Metric	string	El nombre de la métrica para el muestreo. Valores válidos: Count: el número de filas de la tabla. Min: el valor mínimo de un campo. Max: el valor máximo de un campo. Avg: el valor promedio de un campo. DistinctCount: el número de valores únicos en un campo. DistinctPercent: la proporción de valores únicos respecto al número total de filas. DuplicatedCount: el número de valores duplicados en un campo. DuplicatedPercent: la proporción de valores duplicados respecto al número total de filas. TableSize: el tamaño de la tabla. NullValueCount: el número de filas donde el campo es nulo. NullValuePercent: la proporción de valores nulos en un campo. GroupCount: el número de filas para cada valor después de la agregación por valor de campo. CountNotIn: el número de filas con valores de enumeración no coincidentes. CountDistinctNotIn: el número de valores únicos con valores de enumeración no coincidentes. UserDefinedSql: recolección de muestras mediante SQL personalizado.	Max
MetricParameters	string	Los parámetros requeridos para la recolección de muestras.	{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}
SettingConfig	string	Las instrucciones de configuración de parámetros de ejecución que se deben ejecutar antes de la instrucción de muestreo. Longitud máxima: 1000 caracteres. Actualmente, solo se admite MaxCompute.	SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;
SamplingFilter	string	La condición de filtro para el filtrado secundario de datos irrelevantes durante el muestreo. Longitud máxima: 16,777,215 caracteres.	id IS NULL
CheckingConfig	object	La configuración de verificación de muestras.
Type	string	El método de cálculo de umbral. Valores válidos: Fixed Fluctation FluctationDiscreate Auto Average Variance	Fixed
ReferencedSamplesFilter	string	Una expresión que especifica cómo consultar muestras de referencia. Algunos tipos de umbral requieren consultar muestras de referencia y agregar sus valores para derivar el umbral de comparación.	{ "bizdate": [ "-1", "-7", "-1m" ] }
Thresholds	object	La configuración de umbrales.
Expected	object	La configuración de umbral esperado.
Operator	string	El operador de comparación. Valores válidos: > >= < <= != =	>
Value	string	El valor del umbral.	100.0
Expression	string	La expresión del umbral. Para reglas de tipo fluctuación, debe usar una expresión para representar el umbral de fluctuación. Ejemplos: Aumento de fluctuación mayor que 0.01: $checkValue > 0.01 Disminución de fluctuación mayor que 0.01: $checkValue < -0.01 Valor absoluto de la tasa de fluctuación: abs($checkValue) > 0.01 Para reglas de tipo valor fijo, también puede usar una expresión para configurar el umbral. Si ambos están configurados, la expresión tiene prioridad sobre Operator y Value.	$checkValue > 0.01
Warned	object	La configuración de umbral para advertencias normales.
Operator	string	El operador de comparación. Valores válidos: > >= < <= != =	>
Value	string	El valor del umbral.	100.0
Expression	string	La expresión del umbral. Para reglas de tipo fluctuación, debe usar una expresión para representar el umbral de fluctuación. Ejemplos: Aumento de fluctuación mayor que 0.01: $checkValue > 0.01 Disminución de fluctuación mayor que 0.01: $checkValue < -0.01 Valor absoluto de la tasa de fluctuación: abs($checkValue) > 0.01 Para reglas de tipo valor fijo, también puede usar una expresión para configurar el umbral. Si ambos están configurados, la expresión tiene prioridad sobre Operator y Value.	$checkValue > 0.01
Critical	object	La configuración de umbral para advertencias críticas.
Operator	string	El operador de comparación. Valores válidos: > >= < <= != =	>
Value	string	El valor del umbral.	100.0
Expression	string	La expresión del umbral. Para reglas de tipo fluctuación, debe usar una expresión para representar el umbral de fluctuación. Ejemplos: Aumento de fluctuación mayor que 0.01: $checkValue > 0.01 Disminución de fluctuación mayor que 0.01: $checkValue < -0.01 Valor absoluto de la tasa de fluctuación: abs($checkValue) > 0.01 Para reglas de tipo valor fijo, también puede usar una expresión para configurar el umbral. Si ambos están configurados, la expresión tiene prioridad sobre Operator y Value.	$checkValue > 0.01
ErrorHandlers	array<object>	La lista de controladores de errores de verificación de reglas de calidad.
	object	El controlador de errores de verificación de reglas de calidad.
Type	string	El tipo de controlador. Valores válidos: SaveErrorData	SaveErrorData
ErrorDataFilter	string	Para reglas de SQL personalizado, la instrucción SQL especificada por el usuario para filtrar datos de error.	SELECT * FROM tb_api_log WHERE id IS NULL

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "691CA452-D37A-4ED0-9441",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 294,
    "DataQualityRules": [
      {
        "Id": 22130,
        "Name": "The table cannot be empty.",
        "ProjectId": 100001,
        "Enabled": true,
        "Severity": "High",
        "Description": "this is a odps _sql task",
        "Target": {
          "Type": "Table",
          "DatabaseType": "maxcompute",
          "TableGuid": "odps.unit_test.tb_unit_test"
        },
        "TemplateCode": "SYSTEM:user_defined_sql",
        "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;",
          "SamplingFilter": "id IS NULL"
        },
        "CheckingConfig": {
          "Type": "Fixed",
          "ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }",
          "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.01"
            }
          }
        },
        "ErrorHandlers": [
          {
            "Type": "SaveErrorData\n",
            "ErrorDataFilter": "SELECT * FROM tb_api_log WHERE id IS NULL"
          }
        ]
      }
    ]
  }
}

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.