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

Consulta la lista de reglas de calidad basadas en una expresión de partición.

Nota

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

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:*

get

*All resources.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectName	string	Sí	El nombre del motor DPI o del origen de datos. Puede obtener el nombre desde la configuración del origen de datos.	autotest
EntityId	integer	Sí	El ID de la expresión de partición. Puede llamar a la operación GetQualityEntity para obtener el ID.	12345
PageNumber	integer	Sí	El número de página.	1
PageSize	integer	Sí	El número de entradas que se devolverán en cada página. Valor predeterminado: 10. Valor máximo: 20.	20
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks.	12345

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La estructura de la respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
RequestId	string	El ID de la solicitud, que se utiliza para la solución de problemas.	38cbdef0-f6cf-49****
ErrorMessage	string	El mensaje de error.	You have no permission.
Success	boolean	Indica si la llamada se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.	true
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists
Data	object	La lista de reglas.
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas devueltas en cada página. Valor predeterminado: 10. Valor máximo: 20.	20
TotalCount	integer	El número total de entradas devueltas.	400
Rules	array<object>	Los detalles de las reglas de calidad.
	object	La estructura de datos de la regla devuelta.
BlockType	integer	La gravedad de la regla de calidad, que indica la importancia de la regla. Valores válidos: 1: Regla fuerte. 0: Regla débil. Puede configurar las reglas importantes como reglas fuertes según sus requisitos empresariales. Si se activa una regla fuerte y se genera una alerta roja, la tarea programada se bloquea.	0
OnDutyAccountName	string	El nombre de la cuenta de Alibaba Cloud que configuró la regla de calidad.	test
Property	string	El nombre del campo.	id
WarningThreshold	string	El umbral de alerta para las alertas naranjas. Este valor indica la desviación respecto al valor esperado de la muestra. Puede personalizar este umbral según sus requisitos empresariales.	10
TableName	string	El nombre de la tabla.	dual
OnDuty	string	El ID de la cuenta que configuró la regla de calidad.	1912****
Comment	string	La descripción de la regla.	Verify table rules
RuleCheckerRelationId	integer	El ID de asociación interna de los detalles de la regla.	132323
FixCheck	boolean	La comprobación de valor fijo.	true
MethodId	integer	El ID del método utilizado para recopilar datos de muestra.	21
TemplateName	string	El nombre de la plantilla de regla de calidad utilizada.	Number of SQL task table rows, 1, 7, and 30 days wave detection
Trend	string	La tendencia del resultado de la comprobación.	abs
HistoryWarningThreshold	string	El umbral de alerta histórico para las alertas naranjas.	history max:40%,history min:10%
RuleType	integer	El tipo de regla. Valores válidos: 0: Regla de plantilla del sistema. 1: Regla SQL personalizada. 4: Regla de plantilla personalizada.	0
MatchExpression	string	La expresión de partición.	dt=$[yyyymmdd]
ProjectName	string	El nombre del motor o del origen de datos.	autotest
PropertyKey	string	La clave de propiedad utilizada para la vinculación de reglas en el frontend de calidad de datos. Puede ignorar este campo.	table_count
CriticalThreshold	string	El umbral de alerta para las alertas rojas. Este valor indica la desviación respecto al valor esperado de la muestra. Puede personalizar este umbral según sus requisitos empresariales. Si se activa una regla fuerte y se alcanza el umbral de alerta roja, la tarea programada se bloquea.	40
HistoryCriticalThreshold	string	El umbral de alerta histórico para las alertas rojas.	history max:80%,history min:50%
MethodName	string	El nombre del método utilizado 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/table_count
CheckerId	integer	El ID del comprobador.	7
EntityId	integer	El ID de la expresión de partición.	1234
ExpectValue	string	El valor esperado.	1000
TemplateId	integer	El ID de la plantilla de regla de calidad utilizada.	7
Id	integer	El ID de la regla.	1234
RuleName	string	El nombre de la regla.	test

Ejemplos

Respuesta exitosa

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