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

Consulta la lista de tareas de escaneo de calidad de datos en un proyecto.

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

list

*All Resource

*

Ninguna

Sintaxis de la solicitud

GET  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Name	string	No	El nombre de la tarea de escaneo de calidad de datos para la coincidencia aproximada.	test
SortBy	string	No	La lista de campos de ordenamiento. Admite campos como la hora de la última modificación y la hora de creación. Formato: "SortField+SortOrder (Desc/Asc)", donde Asc es el valor predeterminado. Valores válidos: ModifyTime (Desc/Asc) CreateTime (Desc/Asc) Id (Desc/Asc)	ModifyTime Desc
PageSize	integer	Sí	El número de entradas por página. Valor predeterminado: 10.	10
PageNumber	integer	Sí	El número de página. Valor predeterminado: 1.	1
ProjectId	integer	Sí	El ID del proyecto.	10000
Table	string	No	La coincidencia aproximada del nombre de la tabla monitoreada.	video_album

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
RequestId	string	El ID de la solicitud de la API, que se genera como un UUID.	0bc14115***159376359
PageInfo	object	La información de la página.
PageNumber	integer	El número de página.	1
PageSize	integer	El número de registros por página. Valor predeterminado: 10.	10
TotalCount	integer	El número total de registros.	1
DataQualityScans	array<object>	La lista de monitores de calidad de datos.
	array<object>	La información sobre el monitor de calidad de datos.
ModifyTime	integer	La hora de la última actualización del monitor de calidad de datos.	17236236472
Owner	string	El ID del usuario propietario responsable del monitor de calidad de datos.	23782382795249
Description	string	La descripción de la tarea de escaneo de calidad de datos. Longitud máxima: 65,535 caracteres.	This is a hourly run data quality evaluation plan.
ModifyUser	string	El ID del usuario que actualizó por última vez el monitor de calidad de datos.	23782382795249
Parameters	array<object>	Las definiciones de parámetros de ejecución para el monitor de calidad de datos.
	object	Las definiciones de parámetros de ejecución para el monitor de calidad de datos.
Value	string	El valor del parámetro.	$[yyyy-mm-dd-1]
Name	string	El nombre del parámetro.	dt
CreateTime	integer	La hora de creación del monitor de calidad de datos.	1694512304000
ProjectId	integer	El ID del proyecto.	59094
CreateUser	string	El creador del monitor de calidad de datos.	7892346529452
ComputeResource	object	El motor de cómputo que se utiliza durante la ejecución. Si no se especifica, se utiliza la conexión de origen de datos definida en el Spec.
Runtime	object	La configuración adicional en tiempo de ejecución para el monitor de calidad de datos.
HiveConf	string	Los parámetros adicionales para el motor Hive. Actualmente solo se admite mapreduce.job.queuename para configurar la cola.	mapreduce.job.queuename=dq_queue
SparkConf	string	Los parámetros adicionales para el motor Spark. Actualmente solo se admite spark.yarn.queue para configurar la cola.	spark.yarn.queue=dq_queue
Engine	string	El tipo de motor. Estas configuraciones solo se admiten en el motor de cómputo EMR. Valores válidos: Hive: Hive SQL Spark: Spark SQL Kyuubi	Hive
EnvType	string	El entorno del espacio de trabajo del motor de cómputo. Valores válidos: Prod Dev	Prod
Name	string	El nombre del motor de cómputo. Identifica el motor de forma única.	emr_cluster_001
Name	string	El nombre de la tarea de escaneo de calidad de datos. Puede incluir dígitos, letras, caracteres chinos y signos de puntuación de ancho medio y ancho completo. Longitud máxima: 255 caracteres.	Hourly partition quality monitoring
RuntimeResource	object	El grupo de recursos que se utiliza durante la ejecución del monitor de calidad de datos.
Cu	number	El consumo de CU para la ejecución de la tarea.	0.25
Id	string	El ID del grupo de recursos.	Serverless_resource_group_xxxxx
Image	string	El ID de la imagen configurada para la ejecución de la tarea.	i-xxxxx
Trigger	object	La configuración del disparador para el monitor de calidad de datos.
Type	string	El modo de disparo del monitor de calidad de datos. Valores válidos: ByManual: se dispara manualmente. Configuración predeterminada. BySchedule: se dispara mediante una instancia de tarea programada.	BySchedule
TaskIds	array	Si el modo de disparo es BySchedule, se debe configurar el ID de la tarea de programación que dispara el monitor.
	integer	El ID de la tarea de programación.	1023777390
Hooks	array<object>	La configuración del hook después de que se detiene el monitor de calidad de datos.
	object	La configuración del hook después de que se detiene el monitor de calidad de datos.
Condition	string	La condición de disparo del hook. Cuando se cumple esta condición, se dispara el hook. Formato de expresión válido: Especifica múltiples combinaciones de niveles de gravedad de reglas y estados de validación de reglas, 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' }`. Esto significa que el hook se dispara si alguna regla ejecutada tiene Fail con gravedad Normal, Error con gravedad High o Warn con gravedad High. Los valores de gravedad deben coincidir con los definidos en el Spec. Los valores de estado 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 la tarea.	BlockTaskInstance
Id	integer	El ID del monitor de calidad de datos.	26433

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "DataQualityScans": [
      {
        "ModifyTime": 17236236472,
        "Owner": "23782382795249",
        "Description": "Este es un plan de evaluación de calidad de datos de ejecución horaria",
        "ModifyUser": "23782382795249",
        "Parameters": [
          {
            "Value": "$[yyyy-mm-dd-1]",
            "Name": "dt"
          }
        ],
        "CreateTime": 1694512304000,
        "ProjectId": 59094,
        "CreateUser": "7892346529452",
        "ComputeResource": {
          "Runtime": {
            "HiveConf": "mapreduce.job.queuename=dq_queue",
            "SparkConf": "spark.yarn.queue=dq_queue",
            "Engine": "Hive"
          },
          "EnvType": "Prod",
          "Name": "emr_cluster_001"
        },
        "Name": "Monitoreo de calidad de particiones horarias",
        "RuntimeResource": {
          "Cu": 0.25,
          "Id": "Serverless_resource_group_xxxxx",
          "Image": "i-xxxxx"
        },
        "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"
          }
        ],
        "Id": 26433
      }
    ]
  }
}

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.