Crea un monitor de calidad de datos.
Descripción de la operación
Se requiere DataWorks Basic Edition o una edición superior.
Pruébelo ahora
Test
Autorización de RAM
Sintaxis de la solicitud
POST HTTP/1.1Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| Description |
string |
No |
La descripción del monitor de calidad de datos. |
Daily data quality scanning of ods tables. |
| ProjectId |
integer |
No |
El ID del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks y acceder a la página de configuración del espacio de trabajo para obtener el ID del espacio de trabajo. Este parámetro es obligatorio para especificar el espacio de trabajo de DataWorks de destino para esta operación de la API. |
101 |
| Owner |
string |
No |
El ID del usuario propietario del monitor de calidad de datos. |
95279527**** |
| Spec |
string |
No |
El código de Spec del contenido del monitoreo de calidad de datos. Para obtener más información, consulte Descripción de la configuración de Spec de calidad de datos. |
{ "datasets": [ { "type": "Table", "dataSource": { "name": "odps_first", "envType": "Prod" }, "tables": [ "ods_d_user_info" ], "filter": "pt = $[yyyymmdd-1]" } ], "rules": [ { "assertion": "row_count > 0" }, { "templateId": "SYSTEM:field:null_value:fixed", "pass": "when = 0", "name": "The id cannot be empty.", "severity": "High", "identity": "a-customized-data-quality-rule-uuid" } ] } |
| Parameters |
array<object> |
No |
La definición de los parámetros de ejecución para el monitoreo de calidad de datos. |
|
|
object |
No |
La definición de los parámetros de ejecución para el monitoreo de calidad de datos. |
||
| Value |
string |
No |
Los valores del parámetro. |
$[yyyymmdd-1] |
| Name |
string |
No |
El nombre del parámetro. |
triggerTime |
| RuntimeResource |
object |
No |
El grupo de recursos que se utiliza durante la ejecución del monitoreo de calidad de datos. |
|
| Id |
string |
No |
El ID del grupo de recursos. |
0525242e-d0ee-4bda-bc73-765d82f6a34a |
| Cu |
number |
No |
El número de CU configuradas para la ejecución de tareas. |
0.25 |
| Image |
string |
No |
El ID de la imagen configurada para la ejecución de tareas. |
i-xxxxxx |
| ComputeResource |
object |
No |
El motor de cómputo que se utiliza en tiempo de ejecución. Si no se especifica, se utiliza el origen de datos definido en el Spec. |
|
| Name |
string |
No |
El nombre del motor de cómputo, que es un identificador único. |
emr_first |
| Runtime |
object |
No |
Configuraciones adicionales para el monitoreo de calidad de datos en tiempo de ejecución. |
|
| Engine |
string |
No |
El tipo de motor de cómputo. Solo los motores de cómputo EMR admiten estas configuraciones. Valores válidos:
|
Hive |
| SparkConf |
object |
No |
Parámetros adicionales del motor de Spark. Actualmente, solo se admite el parámetro spark.yarn.queue. |
spark.yarn.queue=dq_queue |
| HiveConf |
object |
No |
Parámetros adicionales del motor de Hive. Actualmente, solo se admite el parámetro mapreduce.job.queuename. |
mapreduce.job.queuename=dq_queue |
| EnvType |
string |
No |
El entorno del espacio de trabajo al que pertenece el motor de cómputo. Valores válidos:
|
Dev |
| Trigger |
object |
No |
Las configuraciones de disparo de la tarea de monitoreo de calidad de datos. |
|
| Type |
string |
No |
El modo de disparo de la tarea de monitoreo. Valores válidos:
|
BySchedule |
| TaskIds |
array |
No |
Si el modo de disparo se establece en BySchedule, se debe especificar el ID de la tarea programada. |
|
|
integer |
No |
El ID de la tarea programada. |
1004979033 |
|
| Hooks |
array<object> |
No |
Las configuraciones de Hook después de que finaliza la ejecución del monitoreo de calidad de datos. |
|
|
object |
No |
Las configuraciones de Hook después de que finaliza la ejecución del monitoreo de calidad de datos. |
||
| Condition |
string |
No |
La condición de disparo del Hook. El Hook se ejecuta si se cumple la condición. Actualmente, solo se admite un tipo de sintaxis de expresión: Puede especificar múltiples combinaciones de niveles de gravedad de las reglas y estados de validación mediante una expresión como |
results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' || r.status == 'Error' && r.rule.severity == 'High' || r.status == 'Warn' && r.rule.severity == 'High' } |
| Type |
string |
No |
El tipo de Hook. Valores válidos:
|
BlockTaskInstance |
| Name |
string |
No |
El nombre del monitoreo de calidad de datos. |
data_quality_scan_001 |
| ClientToken |
string |
Sí |
El token de idempotencia. |
a-customized-uuid |
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
Esquema de respuesta. |
||
| RequestId |
string |
El ID de la solicitud. |
0000-ABCD-EFG**** |
| Id |
integer |
Devuelve el ID de la regla de uso compartido de origen de datos creada, que identifica de forma única la regla. |
676303114031776 |
Ejemplos
Respuesta exitosa
JSON Formato
{
"RequestId": "0000-ABCD-EFG****",
"Id": 676303114031776
}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.