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

Obtiene información sobre una regla de calidad.

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 Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RuleId	integer	Sí	El ID de la regla de calidad. Puede llamar a la operación ListQualityRules para obtener el ID.	1234
ProjectName	string	Sí	El nombre del motor o del origen de datos.	autotest
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks.	12345

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La estructura de datos de la respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
RequestId	string	El ID de la solicitud.	576b9457-2cf5-4****
ErrorMessage	string	El mensaje de error.	You have no permission.
ErrorCode	string	El código de error.	401
Success	boolean	Indica si la solicitud se completó correctamente.	true
Data	object	Los detalles de la regla de calidad.
BlockType	integer	La gravedad de la regla de calidad. Valores válidos: `1`: Regla fuerte. Si una regla fuerte desencadena una alerta crítica, la tarea de programación asociada se bloquea. `0`: Regla débil.	1
OnDutyAccountName	string	El nombre de la cuenta de Alibaba Cloud que configuró la regla.	test
WarningThreshold	string	El umbral para una alerta de advertencia. Este valor especifica la desviación aceptable respecto al valor esperado y se puede personalizar.	10
Property	string	La columna de la tabla de origen de datos a la que se aplica la regla.	id
RuleType	integer	El tipo de regla de calidad. Valores válidos: `0`: Una regla basada en una plantilla del sistema. `1`: Una regla basada en una sentencia SQL personalizada. `4`: Una regla basada en una plantilla personalizada.	0
Comment	string	El comentario de la regla.	Verify that the primary key is unique
OnDuty	string	El ID de la cuenta de Alibaba Cloud que configuró la regla.	1822931****
Checker	integer	El ID del verificador, que se obtiene a partir de pkId y se utiliza para la identificación en el frontend.	9
FixCheck	boolean	Indica si se debe validar con un valor fijo.	true
MethodId	integer	El ID del método utilizado para recopilar datos de muestra.	8
CriticalThreshold	string	El umbral de alerta roja, que indica el grado de desviación respecto al valor de muestra esperado. Puede personalizar este umbral según sus requisitos empresariales. Si una regla fuerte desencadena el umbral rojo, la tarea de programación se bloquea.	20
PredictType	integer	Indica si el umbral es dinámico. Valores válidos: `0`: El umbral es estático. `1`: El umbral es dinámico.	0
TemplateName	string	El nombre de la plantilla utilizada.	SQL task table rows, 1,7, 30 days fluctuation test
CheckerName	string	El nombre del verificador.	compared with a fixed value
RuleName	string	El nombre de la regla.	View table fluctuations
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`.	table_count
EntityId	integer	El ID de la expresión de partición.	165523
WhereCondition	string	La condición de filtro o la sentencia SQL personalizada que se utiliza para la validación.	id>10
Operator	string	El operador de comparación.	>=
ExpectValue	string	El valor esperado.	30
Trend	string	La tendencia del resultado de la validación.	abs
TemplateId	integer	El ID de la plantilla utilizada.	7
Id	integer	El ID de la regla.	123232
OpenSwitch	boolean	Indica si la regla está habilitada.	true
TaskSetting	string	La configuración de variables que se inserta antes de una regla personalizada. El formato es x=a,y=b.	x=a,y=b

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "RequestId": "576b9457-2cf5-4****",
  "ErrorMessage": "No tiene permisos",
  "ErrorCode": "401",
  "Success": true,
  "Data": {
    "BlockType": 1,
    "OnDutyAccountName": "test",
    "WarningThreshold": "10",
    "Property": "id",
    "RuleType": 0,
    "Comment": "Verificar que la clave principal sea única",
    "OnDuty": "1822931****",
    "Checker": 9,
    "FixCheck": true,
    "MethodId": 8,
    "CriticalThreshold": "20",
    "PredictType": 0,
    "TemplateName": "Filas de tabla de tarea SQL, prueba de fluctuación de 1, 7 y 30 días",
    "CheckerName": "comparado con un valor fijo",
    "RuleName": "Ver fluctuaciones de la tabla",
    "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 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.