Crea una regla de calidad.
Esta API se marcó como obsoleta. Se recomienda migrar a dataworks-public(2024-05-18) - CreateDataQualityScan 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
Test
Autorización de RAM
Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| BlockType |
integer |
Sí |
La intensidad de la regla. Valores válidos:
|
0 |
| EntityId |
integer |
Sí |
El ID de la expresión de filtro de partición. |
15224 |
| Comment |
string |
No |
Los comentarios de la regla. |
Verification |
| Checker |
integer |
No |
El ID del verificador. Valores válidos:
|
9 |
| ExpectValue |
string |
No |
El valor esperado. |
0 |
| Trend |
string |
No |
La tendencia del resultado de la verificación. Valores válidos:
|
abs |
| MethodName |
string |
No |
El método de muestreo. Si usa una sentencia SQL personalizada, establezca este parámetro en |
count/table_count |
| Operator |
string |
No |
El operador de comparación. Ejemplos: Nota
Si establece el parámetro Checker en 9, debe especificar el parámetro Operator. |
> |
| ProjectName |
string |
Sí |
El nombre del motor de cómputo o del origen de datos. |
autotest |
| Property |
string |
No |
La columna que la regla monitorea. Para una verificación a nivel de tabla, establezca este parámetro en |
table_id |
| PropertyType |
string |
No |
El tipo de datos de la columna. Para una verificación a nivel de tabla, establezca este parámetro en |
bigint |
| RuleType |
integer |
Sí |
El tipo de regla. Valores válidos:
|
0 |
| WhereCondition |
string |
No |
La condición de filtro o la sentencia SQL personalizada. |
table_id>1 |
| CriticalThreshold |
string |
No |
El umbral crítico. Indica la desviación del resultado de la verificación respecto al valor esperado. Puede personalizar este umbral según sus requisitos empresariales. Si se usa una regla fuerte y se activa una alerta crítica, la tarea programada se bloquea. |
20 |
| WarningThreshold |
string |
No |
El umbral de advertencia. Indica la desviación del resultado de la verificación respecto al valor esperado. Puede personalizar este umbral según sus requisitos empresariales. |
10 |
| TemplateId |
integer |
No |
El ID de la plantilla. |
7 |
| RuleName |
string |
Sí |
El nombre de la regla. |
1234 |
| PredictType |
integer |
Sí |
Especifica si se debe usar un umbral dinámico. Valores válidos:
|
0 |
| ProjectId |
integer |
Sí |
El ID del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks e ir a la página Gestión del espacio de trabajo para obtener el ID del espacio de trabajo. |
10000 |
| TaskSetting |
string |
No |
La configuración de variables que se inserta antes de la regla personalizada. Formato: x=a,y=b. |
x=a,y=b |
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
Los parámetros de respuesta. |
||
| HttpStatusCode |
integer |
El código de estado HTTP. |
200 |
| Data |
string |
El ID de la nueva regla. |
12345 |
| ErrorMessage |
string |
El mensaje de error. |
You have no permission. |
| RequestId |
string |
El ID de la solicitud. |
ecb967ec-c137-48**** |
| ErrorCode |
string |
El código de error. |
401 |
| Success |
boolean |
Indica si la solicitud se realizó correctamente. |
true |
Ejemplos
Respuesta exitosa
JSON Formato
{
"HttpStatusCode": 200,
"Data": "12345",
"ErrorMessage": "You have no permission",
"RequestId": "ecb967ec-c137-48****",
"ErrorCode": "401",
"Success": true
}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.