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

Obtiene los detalles del monitoreo de calidad de datos.

Descripción de la operación

Se requiere DataWorks Basic Edition o una edición superior.

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

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	integer	No	El ID del monitor.	10001

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	204EAF68-CCE3-5112-8DA0-E7A60F02XXXX
DataQualityScan	object	Los detalles del monitoreo de calidad de datos.
Id	integer	El ID del monitoreo de calidad de datos.	10001
Name	string	El nombre del monitor de calidad de datos.	data_quality_scan_001
Description	string	La descripción del monitor de calidad de datos.	aily data quality scanning of ods tables.
ProjectId	integer	El ID del espacio de trabajo donde reside el monitor de calidad de datos. Puede obtener el ID del espacio de trabajo llamando a la operación ListProjects.	101
CreateTime	integer	La hora de creación del monitor de calidad de datos.	1731550150000
ModifyTime	integer	La hora de la última modificación del monitor de calidad de datos.	1731550150000
CreateUser	string	El ID del usuario que creó el monitor de calidad de datos.	2374924198591250
ModifyUser	string	El ID del usuario que modificó por última vez el monitor de calidad de datos.	23482597582479
Owner	string	El ID del usuario propietario del monitor de calidad de datos.	231263586109857423
Spec	string	El código de especificación del contenido del monitoreo de calidad de datos. Para obtener más información, consulte Descripción de la configuración de la especificación 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>	La definición de los parámetros de ejecución del monitor de calidad de datos.
	object	La información del parámetro.
Value	string	El nombre del parámetro.	10
Name	string	El valor del parámetro.	e2e_autolabel
ComputeResource	object	El motor de cómputo que se utiliza en tiempo de ejecución. Opcional. Si no se especifica, se utiliza el origen de datos definido en la especificación.
Name	string	El nombre del motor de cómputo, que es un identificador único.	polardb_to_holo
Runtime	object	Las configuraciones adicionales para el monitor de calidad de datos en tiempo de ejecución.
Engine	string	El tipo de motor de cómputo. Solo los motores de cómputo de EMR admiten estas configuraciones. Valores válidos: Hive: Hive SQL Spark: Spark SQL Kyuubi	Hive
HiveConf	object	Parámetros adicionales del motor Hive. Actualmente, solo se admite el parámetro mapreduce.job.queuename.	mapreduce.job.queuename=dq_queue
SparkConf	object	Parámetros adicionales del motor Spark. Actualmente, solo se admite el parámetro spark.yarn.queue.	spark.yarn.queue=dq_queue
EnvType	string	El entorno del espacio de trabajo al que pertenece el motor de cómputo. Valores válidos: Prod: entorno de producción. Dev: entorno de desarrollo.	Prod
RuntimeResource	object	El grupo de recursos que se utiliza durante la ejecución del monitor de calidad de datos.
Id	string	El ID del grupo de recursos.	122878
Cu	number	Las unidades de cómputo (CU) reservadas para el grupo de recursos.	10
Image	string	El ID de la imagen que se utiliza en la configuración de tiempo de ejecución.	hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008
Trigger	object	Las configuraciones de activación de la tarea de monitoreo de calidad de datos.
Type	string	El modo de activación de la tarea de monitoreo. Valores válidos: ByManual: activación manual. Esta es la configuración predeterminada. BySchedule: activación por una instancia de tarea programada.	BySchedule
TaskIds	array	Si el modo de activación se establece en BySchedule, se debe especificar el ID de la tarea de programación.
	integer	El ID de la tarea de programación.	1023777390
Hooks	array<object>	Las configuraciones de Hook después de que finaliza la ejecución del monitoreo de calidad de datos.
	object	Las configuraciones de Hook después de que finaliza la ejecución del monitoreo de calidad de datos.
Condition	string	La condición de activación 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' }`. Esta expresión significa que la condición se cumple si alguna regla ejecutada tiene un resultado de Fail con gravedad Normal, Error con gravedad High o Warn con gravedad High. En la expresión de condición, los valores de severity y status son enumeraciones predefinidas. Los valores de severity deben coincidir con los definidos en la especificación, y los valores de status deben coincidir con los de DataQualityResult.	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	El tipo de Hook. Valores válidos: BlockTaskInstance: bloquea la programación de la instancia de tarea.	BlockTaskInstance

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "204EAF68-CCE3-5112-8DA0-E7A60F02XXXX",
  "DataQualityScan": {
    "Id": 10001,
    "Name": "data_quality_scan_001",
    "Description": "aily data quality scanning of ods tables",
    "ProjectId": 101,
    "CreateTime": 1731550150000,
    "ModifyTime": 1731550150000,
    "CreateUser": "2374924198591250",
    "ModifyUser": "23482597582479",
    "Owner": "231263586109857423",
    "Spec": "{\n    \"datasets\": [\n        {\n            \"type\": \"Table\",\n            \"dataSource\": {\n                \"name\": \"odps_first\",\n                \"envType\": \"Prod\"\n            },\n            \"tables\": [\n                \"ods_d_user_info\"\n            ],\n            \"filter\": \"pt = $[yyyymmdd-1]\"\n        }\n    ],\n    \"rules\": [\n        {\n            \"assertion\": \"row_count > 0\"\n        }, {\n            \"templateId\": \"SYSTEM:field:null_value:fixed\",\n            \"pass\": \"when = 0\",\n            \"name\": \"The id cannot be empty.\",\n            \"severity\": \"High\",\n             \"identity\": \"a-customized-data-quality-rule-uuid\"\n        }\n    ]\n}",
    "Parameters": [
      {
        "Value": "10",
        "Name": "e2e_autolabel"
      }
    ],
    "ComputeResource": {
      "Name": "polardb_to_holo",
      "Runtime": {
        "Engine": "Hive",
        "HiveConf": {
          "test": "test",
          "test2": 1
        },
        "SparkConf": {
          "test": "test",
          "test2": 1
        }
      },
      "EnvType": "Prod"
    },
    "RuntimeResource": {
      "Id": "122878",
      "Cu": 10,
      "Image": "hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008"
    },
    "Trigger": {
      "Type": "BySchedule",
      "TaskIds": [
        1023777390
      ]
    },
    "Hooks": [
      {
        "Condition": "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": "BlockTaskInstance"
      }
    ]
  }
}

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.