Descripción general de la API - DataWorks - Centro de documentación de Alibaba Cloud

Estándares de API y SDK preconfigurados multilenguaje

La OpenAPI de este producto (dataworks-public/2020-05-18) utiliza el estilo de firma RPC. Se han encapsulado SDK para los lenguajes de programación más comunes con el fin de facilitar el desarrollo. Los desarrolladores pueden descargar el SDK para invocar directamente la OpenAPI de este producto sin preocuparse por los detalles técnicos. Si el SDK existente no satisface sus necesidades, utilice el mecanismo de firma para una integración con autofirma. Dado que los detalles de la autofirma son muy complejos, este proceso puede tardar alrededor de 5 días hábiles. Por lo tanto, se recomienda unirse a nuestro grupo de servicio de DingTalk (147535001692) para llevar a cabo la integración de firmas bajo la guía de expertos.

Antes de usar la API, prepare su cuenta de identidad y su clave de acceso (AccessKey) para acceder eficazmente a la API mediante herramientas cliente (como SDK y CLI). Para obtener más información, consulte Obtener un AccessKey.

Escenarios de firma personalizada

Si su escenario empresarial tiene requisitos especiales y necesita integrar la API mediante autofirma, se recomienda consultar primero a nuestro equipo de soporte técnico (grupo de servicio de DingTalk: 147535001692) para obtener orientación profesional y garantizar una integración eficiente.

Preparación de cuenta y seguridad

Las cuentas de Alibaba Cloud tienen permisos administrativos completos sobre todos los recursos. Si un AccessKey se ve comprometido, todos los recursos asociados corren el riesgo de sufrir accesos no autorizados. Para garantizar la seguridad, se recomienda crear un RAM user con permisos de acceso exclusivos a la API y configurar su AccessKey, además de establecer directivas de RAM basadas en el principio de menor privilegio (PoLP). Utilice la cuenta de Alibaba Cloud únicamente en escenarios específicos donde se requieran explícitamente sus permisos.

Inquilino

API	Título	Descripción
ListCalcEngines	ListCalcEngines	Queries a list of compute engines that are associated with a DataWorks workspace.
CreateDataSource	CreateDataSource.	Agrega un origen de datos a DataWorks.
ListDataSources	ListDataSources.	Consulta los orígenes de datos agregados a un espacio de trabajo de DataWorks.
UpdateDataSource	UpdateDataSource.	Actualiza un origen de datos.
DeleteDataSource	DeleteDataSource.	Elimina un origen de datos.
ListResourceGroups	Consultar lista de grupos de recursos.	Consulta la lista de grupos de recursos de un tipo especificado.
GetProject	Consulta de detalles del espacio de trabajo.	Consulta los detalles de un espacio de trabajo de DataWorks.
AddProjectMemberToRole	Agregar a un usuario del espacio de trabajo a un rol.	Agrega a un usuario de un espacio de trabajo de DataWorks a un rol. Antes de llamar a esta operación, primero debe agregar la cuenta de destino como miembro del espacio de trabajo de DataWorks.
CreateProjectMember	Agregar un usuario a un espacio de trabajo.	Agrega un usuario a un espacio de trabajo de DataWorks.
DeleteProjectMember	Elimina a un usuario de un espacio de trabajo de DataWorks.	Elimina a un usuario de un espacio de trabajo de DataWorks.
ListProjectRoles	Obtener todos los roles de un espacio de trabajo.	Obtiene una lista de todos los roles de un espacio de trabajo.
RemoveProjectMemberFromRole	Eliminar a un usuario de un rol en un espacio de trabajo.	Elimina a un usuario de un rol de DataWorks en un espacio de trabajo de DataWorks.
ListProjectMembers	Consulta la lista de miembros del espacio de trabajo.	Consulta la lista de miembros existentes en un espacio de trabajo de DataWorks.
ListProjects	Consulta de la lista de espacios de trabajo.	Consulta la lista de espacios de trabajo de DataWorks en el inquilino al que pertenece el usuario actual.
ListProjectIds	ListProjectIds.	Consulta los ID de los espacios de trabajo en los que una cuenta específica de Alibaba Cloud o un usuario de RAM tiene permisos en una región específica.
CreateProject	Crea un espacio de trabajo de DataWorks.	Crea un espacio de trabajo de DataWorks.
ChangeResourceManagerResourceGroup	ChangeResourceManagerResourceGroup.	Cambia el grupo de recursos de un recurso.
ListMeasureData	ListMeasureData.	Consulta las estadísticas sobre el número de alertas por llamada telefónica o alertas por mensaje de texto reportadas dentro del inquilino al que pertenece su cuenta durante los últimos 30 días.

Metadatos

API	Título	Descripción
ListTables	ListTables.	Obtiene tablas de diferentes tipos de origen de datos dentro de un inquilino por página.
GetMetaDBInfo	Obtener metadatos básicos de una instancia de motor.	Obtiene la información básica de metadatos de una instancia de motor.
GetMetaDBTableList	GetMetaDBTableList.	Obtiene todas las tablas en la instancia de motor especificada.
CheckMetaTable	Comprobar si existe una tabla.	Comprueba si existe una tabla.
CheckMetaPartition	CheckMetaPartition.	Verifica si existe una partición en una metatabla de MaxCompute.
SearchMetaTables	SearchMetaTables.	Consulta metatablas según condiciones específicas.
GetMetaTableBasicInfo	GetMetaTableBasicInfo.	Consulta la información básica de una metatabla.
GetMetaTableColumn	GetMetaTableColumn.	Consulta la información de los campos de una metatabla.
GetMetaTablePartition	GetMetaTablePartition.	Obtiene una lista de particiones para una tabla.
GetMetaTableOutput	Obtener información de salida de tabla.	Obtiene la información de salida de una tabla.
GetMetaTableChangeLog	Obtener registro de cambios de tabla.	Obtiene el registro de cambios de una tabla.
GetMetaTableIntroWiki	Obtener instrucciones de uso de tabla.	Obtiene las instrucciones de uso de una tabla.
CreateMetaCategory	CreateMetaCategory.	Crea una categoría.
DeleteMetaCategory	DeleteMetaCategory.	Elimina una categoría.
UpdateMetaCategory	UpdateMetaCategory.	Actualiza una categoría.
GetMetaCategory	Consulta de categorías de árbol.	Consulta las categorías de árbol.
GetMetaTableListByCategory	GetMetaTableListByCategory.	Consulta metatablas en una categoría especificada.
AddToMetaCategory	AddToMetaCategory.	Agrega una metatabla a una categoría especificada.
DeleteFromMetaCategory	DeleteFromMetaCategory.	Elimina una tabla de una categoría especificada.
UpdateMetaTable	UpdateMetaTable.	Actualiza los metadatos de una tabla.
UpdateMetaTableIntroWiki	Actualización de la descripción de la tabla.	Actualiza la descripción de una tabla. Si los datos no existen, se agrega la descripción.
ListMetaDB	Consulta las bases de datos.	Consulta una lista de bases de datos.
UpdateTableModelInfo	Modificar la información del modelo de tabla.	Modifica la información del tema, del nivel y de la categoría física de una tabla.
CreateTableTheme	Crear un tema de tabla.	Crea un tema de tabla. Esta operación se reemplazará próximamente. No invoque esta operación.
DeleteTableTheme	DeleteTableTheme.	Elimina un tema de tabla. Esta operación se reemplazará próximamente. Se recomienda no invocar esta operación.
UpdateTableTheme	UpdateTableTheme.	Actualiza un tema de tabla. Esta operación se reemplazará próximamente. Se recomienda no invocar esta operación.
ListTableTheme	ListTableTheme.	Enumera los temas de tabla. Esta operación se reemplazará próximamente. Se recomienda no invocar esta operación.
GetMetaTableThemeLevel	Consulta de información de tema y nivel de una tabla.	Consulta la información de tema y nivel de una tabla.
CreateTableLevel	CreateTableLevel.	Crea un nivel de jerarquía. Esta operación se reemplazará pronto. Se recomienda no llamar a esta operación.
UpdateTableLevel	UpdateTableLevel.	Actualiza un nivel de jerarquía. Esta operación se reemplazará próximamente. Se recomienda no invocar esta operación.
DeleteTableLevel	Eliminar un nivel de tabla.	Elimina un nivel de jerarquía. Esta operación se reemplazará próximamente. No invoque esta operación.
ListTableLevel	ListTableLevel.	Enumera los niveles de jerarquía. Esta operación se reemplazará próximamente. Se recomienda no llamar a esta operación.
UpdateMetaCollection	Actualiza un objeto de colección.	Actualiza el nombre y el comentario de un objeto de colección.
ListMetaCollections	Consulta de información de colecciones.	Consulta la información de las colecciones. Las colecciones incluyen álbumes y subcategorías dentro de los álbumes en la página Data Map. Puede invocar esta operación para consultar información de las colecciones si especifica un tipo de colección.
ListMetaCollectionEntities	Consulta de entidades en una colección.	Consulta las entidades de una colección.
DeleteMetaCollection	Elimina una colección.	Elimina una colección.
GetMetaCollectionDetail	Consulta de detalles de la colección.	Consulta los detalles de una colección.
DeleteMetaCollectionEntity	Elimina una entidad de una colección.	Elimina una entidad de una colección.
AddMetaCollectionEntity	Agrega una entidad a una colección.	Agrega una entidad a una colección.
CreateMetaCollection	Crea un objeto de colección.	Crea un objeto de colección.
ListLineage	Consulta de linaje de entidad.	Consulta las relaciones de linaje ascendentes y descendentes de una entidad.
DeleteLineageRelation	DeleteLineageRelation.	Elimina el linaje; admite la eliminación de relaciones de linaje definidas por el usuario.
RegisterLineageRelation	Registrar relación de linaje.	Registra las relaciones entre entidades. Permite registrar relaciones personalizadas entre entidades.
GetMetaTableLineage	Consulta del linaje de tabla.	Consulta el linaje de datos de una tabla.
GetMetaColumnLineage	Obtener el linaje del campo.	Consulta el linaje de un campo mediante la operación GetMetaColumnLineage.

Estudio de datos

API	Título	Descripción
CreateFile	Crear un archivo en DataStudio.	Crea un archivo en DataStudio. Esta operación no admite la creación de tareas de nodo de Data Integration.
CreateUdfFile	Crear un archivo de tipo función en DataStudio.	Crea un archivo de tipo función en DataStudio.
CreateBusiness	Crear un proceso de negocio.	Crea un proceso de negocio en DataStudio para el desarrollo de datos.
DeleteBusiness	DeleteBusiness.	Elimina un flujo de trabajo.
CreateFolder	CreateFolder.	La operación que se desea realizar. Establezca el valor en \\\\CreateFolder\\\\.
UpdateBusiness	UpdateBusiness.	Actualiza un flujo de trabajo.
ListFiles	ListFiles.	Consulta una lista de archivos.
EstablishRelationTableToBusiness	EstablishRelationTableToBusiness.	Importa una tabla a un flujo de trabajo. La llamada a esta operación de API equivale a realizar las siguientes operaciones: vaya a la página de DataStudio, busque el flujo de trabajo deseado y haga clic en el nombre del flujo de trabajo. Haga clic con el botón derecho en Tabla bajo la carpeta deseada y seleccione Importar tabla.
SubmitFile	SubmitFile.	Envía un archivo al entorno de desarrollo para crear una tarea correspondiente.
ListBusiness	ListBusiness.	Consulta una lista de flujos de trabajo.
GetFileVersion	Obtener versión de archivo.	Consulta la información sobre una versión de archivo.
DeleteFolder	Eliminar una carpeta.	Elimina una carpeta de la página de desarrollo de datos.
DeleteFile	DeleteFile.	Elimina un archivo de DataStudio. Si el archivo se ha confirmado, se activa un proceso asíncrono para eliminarlo en el sistema de programación. El valor del parámetro DeploymentId devuelto se utiliza para llamar a la operación GetDeployment y sondear el estado del proceso asíncrono.
GetDeployment	GetDeployment.	Consulta la información de un paquete de despliegue.
UpdateFile	Actualizar un nodo de archivo existente.	Actualiza un archivo creado.
GetFolder	GetFolder.	Obtiene los detalles de una carpeta mediante GetFolder.
ListFileVersions	ListFileVersions.	Consulta una lista de versiones de archivos.
GetFile	GetFile.	Consulta la información de un archivo.
ListFolders	ListFolders.	Llama a la operación ListFolders para consultar carpetas.
DeployFile	DeployFile.	Despliega un archivo en el entorno de producción.
UpdateUdfFile	Actualizar la información del archivo de una función.	Actualiza la información del archivo de una función.
GetBusiness	GetBusiness.	Consulta la información de un flujo de trabajo.
UpdateFolder	UpdateFolder.	Actualiza una carpeta.
ListDeployments	ListDeployments.	Consulta una lista de paquetes de despliegue. Esta operación equivale a ver una lista de paquetes de despliegue en la página Paquetes de despliegue de la consola de DataWorks.
UpdateIDEEventResult	UpdateIDEEventResult.	Devuelve el resultado de la verificación de un evento de punto de extensión a DataStudio después de que el evento se activa durante el desarrollo de datos y es verificado por una extensión.
GetIDEEventDetail	Consulta la instantánea de datos cuando se activa un evento de punto de extensión.	Consulta la instantánea de datos del punto de extensión en el momento en que se activó un evento de punto de extensión, basándose en el ID de mensaje de un mensaje abierto de DataWorks.
CreateResourceFile	CreateResourceFile.	Crea o carga un archivo de recursos en DataStudio. La funcionalidad implementada al llamar a esta operación es la misma que la función de creación de recursos proporcionada en el entorno de desarrollo integrado (IDE).

Integración de datos

API	Título	Descripción
CreateDISyncTask	CreateDISyncTask.	Crea una tarea de sincronización de datos.
DeleteDISyncTask	DeleteDISyncTask.	Elimina una tarea de sincronización en tiempo real.
UpdateDISyncTask	UpdateDISyncTask.	Actualiza una tarea de sincronización de datos.
TestNetworkConnection	TestNetworkConnection.	Prueba la conectividad de red entre un origen de datos y un grupo de recursos.
GetDataSourceMeta	GetDataSourceMeta.	Consulta los metadatos de un origen de datos especificado.
ListDIProjectConfig	ListDIProjectConfig.	Consulta las configuraciones globales predeterminadas de las soluciones de sincronización en un espacio de trabajo de DataWorks especificado.
UpdateDIProjectConfig	UpdateDIProjectConfig.	Modifica la configuración global predeterminada de las soluciones de sincronización en un espacio de trabajo de DataWorks.
GetDISyncTask	Get data synchronization task.	Obtiene los detalles de una tarea de sincronización o de una solución de sincronización de datos.
DeployDISyncTask	DeployDISyncTask.	Despliega una tarea de sincronización en tiempo real.
GetDISyncInstanceInfo	GetDISyncInstanceInfo.	Consulta el estado de una tarea de sincronización en tiempo real o de una solución de sincronización de datos.
TerminateDISyncInstance	TerminateDISyncInstance.	Despliega una tarea de sincronización en tiempo real.
GenerateDISyncTaskConfigForCreating	GenerateDISyncTaskConfigForCreating.	Genera un ID para un subproceso asíncrono que se utiliza para crear una tarea de sincronización en Data Integration.
GenerateDISyncTaskConfigForUpdating	GenerateDISyncTaskConfigForUpdating.	Genera la configuración para actualizar una tarea de sincronización en tiempo real en Data Integration.
StartDISyncInstance	StartDISyncInstance.	Inicia una tarea de sincronización en tiempo real o una solución de sincronización.
StopDISyncInstance	StopDISyncInstance.	Detiene una tarea de sincronización en tiempo real.
QueryDISyncTaskConfigProcessResult	Consultar el resultado de un proceso de generación de configuración de tarea de sincronización de integración de datos.	Consulta el resultado de una tarea asíncrona para generar configuraciones de tareas de sincronización.
CreateDIJob	CreateDIJob.	Crea una tarea de sincronización de nueva versión. Se admiten los siguientes tipos de tareas de sincronización: sincronización en tiempo real de todos los datos de una base de datos MySQL a Hologres y sincronización por lotes de todos los datos de una base de datos MySQL a Hive.
DeleteDIJob	DeleteDIJob.	Elimina una tarea de Data Integration de nueva versión. Solo se admite el siguiente tipo de tarea: sincronización de datos en tiempo real desde una base de datos MySQL hacia Hologres.
GetDIJob	GetDIJob.	Consulta la información de una tarea de sincronización de nueva versión creada en Data Integration. Se admiten los siguientes tipos de tareas de sincronización: sincronización en tiempo real de todos los datos de una base de datos MySQL a Hologres.
ListDIJobs	ListDIJobs.	Consulta la lista de tareas de integración de datos de nueva versión. Los tipos de tareas admitidos actualmente incluyen tareas de sincronización en tiempo real de base de datos completa de MySQL a Hologres.
StartDIJob	StartDIJob.	Inicia una tarea de sincronización de una nueva versión. Solo se admite el siguiente tipo de tarea: sincronización de datos en tiempo real desde una base de datos MySQL hacia Hologres.
StopDIJob	StopDIJob.	Detiene una tarea de sincronización de nueva versión. Se admite el siguiente tipo de tarea de sincronización: sincronización en tiempo real de todos los datos de una base de datos MySQL a Hologres.
UpdateDIJob	Actualizar una tarea de sincronización.	Actualiza una tarea de sincronización. Se admite el siguiente tipo de tarea: sincronización en tiempo real de todos los datos de una base de datos MySQL a Hologres.
CreateDIAlarmRule	CreateDIAlarmRule.	Crea una regla de alerta para una tarea de sincronización.
DeleteDIAlarmRule	DeleteDIAlarmRule.	Elimina una regla de alerta para una tarea de integración de datos de nueva versión. Solo se admite el siguiente tipo de tarea: sincronización de datos en tiempo real desde una base de datos MySQL hacia Hologres.
GetDIAlarmRule	GetDIAlarmRule.	Obtiene los detalles de una regla de alerta configurada para una tarea de sincronización.
ListDIAlarmRules	Listar reglas de alerta para tareas de integración de datos.	Consulta la lista de reglas de alerta para nodos de nueva versión de integración de datos. Los tipos de nodo admitidos actualmente incluyen las soluciones en tiempo real de base de datos completa de MySQL a Hologres.
UpdateDIAlarmRule	UpdateDIAlarmRule.	Actualiza una regla de alerta para una tarea de sincronización.

Modelado de datos

API	Título	Descripción
QueryPublicModelEngine	Consulta del motor de modelo público.	Obtiene información sobre objetos de Modelado de datos creados mediante instrucciones de lenguaje de modelado rápido (FML).

Centro de operaciones

API	Título	Descripción
GetAlertMessage	GetAlertMessage.	Consulta la información de alertas según el ID de alerta especificado por el parámetro AlertId.
ListAlertMessages	ListAlertMessages.	Consulta una lista de alertas.
GetBaselineConfig	Obtener detalles de configuración de la línea base.	Obtiene los detalles de configuración de una línea base mediante la llamada a GetBaselineConfig.
ListNodesByBaseline	Obtener nodos en una línea base.	Obtiene los nodos de una línea base (excluyendo los nodos ascendentes de estos nodos).
ListBaselineConfigs	ListBaselineConfigs.	Consulta una lista de líneas base.
GetBaselineKeyPath	Obtener la ruta crítica de una instancia de línea base.	Obtiene la ruta crítica de una instancia de línea base.
GetBaselineStatus	Obtener detalles de la instancia de línea base.	Obtiene los detalles de una instancia de línea base.
ListBaselineStatuses	Obtener lista de instancias de línea base.	Obtiene una lista de instancias de línea base.
DeleteRemind	DeleteRemind.	Elimina una regla de alerta de monitoreo personalizado.
UpdateRemind	Actualizar una regla de alerta personalizada.	Actualiza una regla de monitoreo personalizada.
CreateRemind	Crear una regla de alerta personalizada.	Crea una regla de alerta personalizada mediante la llamada a CreateRemind.
GetRemind	GetRemind.	Consulta la información de una regla de alerta personalizada.
ListReminds	Listar reglas de alerta.	Consulta una lista de reglas de alerta personalizadas.
ListTopics	Consulta o búsqueda de eventos.	Consulta o busca una lista de eventos.
GetTopic	Obtener detalles del evento.	Obtiene los detalles de un evento.
GetTopicInfluence	GetTopicInfluence.	Consulta las instancias de línea base afectadas por un evento.
GetNode	Obtener detalles del nodo.	Obtiene los detalles de un nodo.
ListNodeInputOrOutput	Consulta de información de entrada y salida de nodos.	Consulta la información de entrada y salida del nodo actual.
ListNodes	ListNodes.	El ID del espacio de trabajo.
GetNodeCode	GetNodeCode.	Obtiene el código de un nodo.
GetInstance	GetInstance.	Consulta la información de una instancia.
ListInstances	Listar instancias.	Obtiene una lista de instancias.
GetInstanceLog	GetInstanceLog.	Consulta los registros de una instancia.
StopInstance	Detener una instancia.	Detiene una instancia.
RestartInstance	Reiniciar una instancia.	Reinicia una instancia.
SetSuccessInstance	SetSuccessInstance.	Establece el estado de una instancia fallida a exitoso.
SuspendInstance	Pausar una instancia.	Pausa una instancia.
ResumeInstance	ResumeInstance.	Reanuda una instancia en pausa.
RunCycleDagNodes	Crear un flujo de trabajo de relleno de datos.	Crea un flujo de trabajo de relleno de datos mediante la llamada a RunCycleDagNodes.
RunSmokeTest	RunSmokeTest.	Crea un flujo de trabajo de prueba de humo mediante la llamada a la operación RunSmokeTest.
ListSuccessInstanceAmount	Obtener el recuento de instancias completadas exitosamente.	Obtiene la tendencia de recuentos de instancias completadas exitosamente en diferentes horas de la fecha de negocio para instancias periódicas generadas en esa fecha.
ListInstanceAmount	ListInstanceAmount.	Consulta la tendencia del número de instancias de nodo activadas automáticamente dentro de un período de tiempo especificado.
TopTenElapsedTimeInstance	TopTenElapsedTimeInstance.	Consulta la clasificación de las duraciones de ejecución de las instancias.
TopTenErrorTimesInstance	TopTenErrorTimesInstance.	Consulta la clasificación de los nodos en los que se produjeron errores durante el mes anterior.
GetFileTypeStatistic	GetFileTypeStatistic.	Consulta la distribución de tipos de nodo.
GetInstanceStatusStatistic	GetInstanceStatusStatistic.	Consulta el número de instancias que se encuentran en cada estado.
ListFileType	ListFileType.	Consulta la información sobre los tipos de nodo, como el código y el nombre.
RunManualDagNodes	Ejecutar un flujo de trabajo manual.	Desencadena la ejecución de un flujo de trabajo manual. El flujo de trabajo manual debe haberse enviado y publicado en la página de entornos antes de aparecer en el Centro de operaciones y poder ser desencadenado por esta operación.
ListManualDagInstances	Listar instancias de flujos de trabajo activados manualmente.	Consulta la información de las instancias en un flujo de trabajo activado manualmente.
GetDag	GetDag.	Consulta la información de un grafo acíclico dirigido (DAG). Puede llamar a la operación GetDag para consultar la información del DAG de un flujo de trabajo activado manualmente, un nodo activado manualmente o una instancia de relleno de datos. Sin embargo, no puede consultar la información del DAG de un nodo activado automáticamente o un flujo de trabajo activado automáticamente.
ListDags	ListDags.	Llama a la operación ListDags para obtener los detalles de todos los DAG correspondientes a una única instancia de reabastecimiento de datos, con base en el OpSeq (identificador único de la instancia de reabastecimiento de datos).
ListNodesByOutput	ListNodesByOutput.	Consulta nodos según la salida de los nodos.
RunTriggerNode	Run a trigger node.	Ejecuta un nodo de activación.
GetNodeParents	Obtener lista de nodos ascendentes.	Llama a GetNodeParents para obtener la lista de nodos ascendentes.
GetNodeChildren	Obtener lista de nodos descendentes.	Llama a GetNodeChildren para obtener la lista de nodos descendentes de un nodo.
UpdateNodeRunMode	UpdateNodeRunMode.	Congela o descongela un nodo especificado.
UpdateNodeOwner	UpdateNodeOwner.	Cambia el propietario de un nodo.
UpdateWorkbenchEventResult	UpdateWorkbenchEventResult.	Devuelve el resultado del procesamiento enviado por una extensión después de que un proceso en Operation Center es bloqueado por la extensión.
ListShiftPersonnels	Obtener personal de guardia de un programa de turnos.	Obtiene la lista de personal de guardia para un programa de turnos.
ListShiftSchedules	ListShiftSchedules.	Consulta una lista de programaciones de turnos en Operation Center.
ListInstanceHistory	Obtener todos los registros de historial de instancias.	Obtiene todos los registros de historial de una instancia. Se genera un registro de historial cada vez que se vuelve a ejecutar un nodo.
ListInnerNodes	ListInnerNodes.	Obtiene una lista de nodos internos dentro de un grupo de nodos o un nodo do-while. Esta operación no admite la consulta de los nodos internos de un nodo PAI.
OfflineNode	OfflineNode.	Despliega un nodo.
GetBaseline	Obtener configuración de línea base.	Obtiene la configuración de la línea base a partir de un ID de línea base.
UpdateBaseline	Actualizar la configuración de la línea base.	Actualiza una línea base.

Calidad de datos

API	Título	Descripción
UpdateQualityFollower	UpdateQualityFollower.	Actualiza una relación de suscripción.
UpdateQualityRule	Actualizar regla.	Llama a UpdateQualityRule para actualizar la información de una regla de verificación de calidad.
GetQualityRule	GetQualityRule.	Obtiene información sobre una regla de calidad.
ListQualityRules	ListQualityRules.	Llama a ListQualityRules para obtener las reglas de calidad que coinciden con una expresión de partición.
CreateQualityRule	CreateQualityRule.	Llama a CreateQualityRule para crear una regla de calidad.
DeleteQualityFollower	DeleteQualityFollower.	Elimina un seguidor de una expresión de partición.
DeleteQualityRule	DeleteQualityRule.	Elimina una regla de calidad de datos.
GetQualityFollower	Obtener suscriptores de una expresión de partición.	Obtiene los suscriptores de una expresión de partición.
CreateQualityFollower	CreateQualityFollower.	Crea un suscriptor para una expresión de partición mediante la llamada a CreateQualityFollower.
DeleteQualityEntity	DeleteQualityEntity.	Elimina una expresión de partición.
GetQualityEntity	Obtener una expresión de partición.	Obtiene una expresión de partición.
CreateQualityEntity	CreateQualityEntity.	Crea una expresión de partición para la calidad de datos.
CreateQualityRelativeNode	CreateQualityRelativeNode.	Crea una asociación de expresión de partición.
DeleteQualityRelativeNode	DeleteQualityRelativeNode.	DeleteQualityRelativeNode elimina una asociación de programación.
ListQualityResultsByEntity	ListQualityResultsByEntity.	Utilice ListQualityResultsByEntity para obtener los resultados de validación basados en una expresión de partición.
ListQualityResultsByRule	ListQualityResultsByRule.	Valida la calidad de un origen de datos con base en reglas de validación y devuelve los resultados de la validación.

Servicio de datos

API	Título	Descripción
CreateDataServiceApi	Crear una API de servicio de datos.	Crea una API de servicio de datos mediante la llamada a CreateDataServiceApi.
PublishDataServiceApi	PublishDataServiceApi.	Publica una API.
DeleteDataServiceApi	DeleteDataServiceApi.	Elimina una API de DataService.
ListDataServiceApis	ListDataServiceApis.	Consulta una lista de API en estado de desarrollo.
GetDataServiceApi	GetDataServiceApi.	Obtiene los detalles de una API de DataService Studio en estado de desarrollo.
UpdateDataServiceApi	UpdateDataServiceApi.	Actualiza la información de una API en estado de desarrollo en DataService Studio.
GetDataServicePublishedApi	GetDataServicePublishedApi.	Obtiene los detalles de una API publicada de DataService Studio.
ListDataServicePublishedApis	Lista de API de Data Service publicadas.	Consulta la lista de API de Data Service publicadas mediante una llamada a ListDataServicePublishedApis.
ListDataServiceApiAuthorities	Obtener API autorizadas a otros.	Obtiene la lista de API que han sido autorizadas a otros usuarios.
ListDataServiceAuthorizedApis	Lista de API autorizadas en DataService.	Obtiene una lista de API autorizadas en DataService.
AbolishDataServiceApi	AbolishDataServiceApi.	Anula la publicación de una API de DataService Studio.
GetDataServiceApplication	GetDataServiceApplication.	Obtiene los detalles de una aplicación.
ListDataServiceApplications	ListDataServiceApplications.	Obtiene una lista de aplicaciones.
CreateDataServiceFolder	CreateDataServiceFolder.	Crea una carpeta en DataService Studio.
GetDataServiceFolder	GetDataServiceFolder.	Consulta una carpeta.
ListDataServiceFolders	Consultar carpetas del servicio de datos.	Consulta la lista de carpetas del servicio de datos.
CreateDataServiceGroup	CreateDataServiceGroup.	Crea un proceso de negocio.
GetDataServiceGroup	GetDataServiceGroup.	Obtiene los detalles de un proceso de negocio.
ListDataServiceGroups	Consultar procesos de negocio del servicio de datos.	Consulta la lista de procesos de negocio del servicio de datos.
CreateDataServiceApiAuthority	CreateDataServiceApiAuthority.	Otorga los permisos de acceso a una API en DataService Studio.
DeleteDataServiceApiAuthority	DeleteDataServiceApiAuthority.	Revoca los permisos de acceso a una API.
ListDataServiceApiTest	Enumerar registros de prueba de API de DataService.	Enumera los registros de prueba de una API de DataService. Solo se pueden consultar datos del último mes.
TestDataServiceApi	TestDataServiceApi.	Prueba una API de DataService Studio en modo asíncrono. Puede llamar a la operación GetDataServiceApiTest para consultar el resultado de la prueba.
GetDataServiceApiTest	GetDataServiceApiTest.	Consulta los resultados de prueba de una API en DataService Studio.
SubmitDataServiceApi	SubmitDataServiceApi.	Envía una API en DataService Studio.
SaveDataServiceApiTestResult	SaveDataServiceApiTestResult.	Guarda los resultados de prueba de una API.

Guardián de seguridad de datos

API	Título	Descripción
DsgQueryRowDetail	Paraguas de protección de datos - acceso a datos - exportar consulta de lista detallada.	Exporta una consulta de lista detallada a nivel de fila.
DsgQueryDetails	Data shield - acceso a datos - exportar consulta.	Exporta resultados detallados de consultas.
DsgGetVisitStat	Consulta de registros de comportamiento de acceso a datos.	Consulta los registros de acceso a datos.
DsgGetVisitDetail	Consulta de detalles del comportamiento de acceso.	Consulta los detalles del comportamiento de acceso.
DsgUpdateDesensStatusList	Update the status of data masking switches	Actualiza el estado de los interruptores de enmascaramiento de datos.
DsgQueryDesensStatusList	Query data masking switch.	Consulta el estado del interruptor de enmascaramiento de datos.
GetOpSensitiveData	GetOpSensitiveData.	Consulta los registros generados en una fecha específica para el acceso a datos sensibles en todos los espacios de trabajo de DataWorks de un inquilino.
DesensitizeData	Enmascarar datos.	Envía datos para su enmascaramiento y devuelve el resultado enmascarado.
GetOpRiskData	GetOpRiskData.	Consulta los registros generados en una fecha específica para el acceso a datos sensibles de alto riesgo en todos los espacios de trabajo de DataWorks de un inquilino.
GetSensitiveData	GetSensitiveData.	Consulta los datos sensibles más recientes en todos los espacios de trabajo de DataWorks de un inquilino.
ScanSensitiveData	ScanSensitiveData.	Verifica si los datos de entrada contienen datos sensibles.
DsgQuerySensResult	Obtención de resultados de identificación de datos sensibles.	Obtiene los resultados de identificación de datos sensibles de Data Security Guard.
QueryDefaultTemplate	Consulta de la plantilla de clasificación de datos predeterminada.	Consulta la plantilla de clasificación de datos predeterminada definida por Data Security Guard.
DsgStopSensIdentify	Detener una tarea de identificación de datos sensibles.	Detiene una tarea de identificación de datos sensibles.
QuerySensClassification	QuerySensClassification.	Consulta las categorías de datos.
QuerySensLevel	QuerySensLevel.	Consulta los niveles de sensibilidad de datos en Data Security Guard.
QueryRecognizeRulesType	QueryRecognizeRulesType.	Consulta la regla integrada de identificación de datos sensibles que se utiliza para configurar un campo sensible.
DsgRunSensIdentify	DsgRunSensIdentify.	Inicia una tarea de identificación de datos sensibles en Data Security Guard.
DeleteRecognizeRule	DeleteRecognizeRule.	Elimina tipos de campos sensibles.
QuerySensNodeInfo	QuerySensNodeInfo.	Consulta las reglas de identificación de datos sensibles.
AddRecognizeRule	AddRecognizeRule.	Agrega un campo sensible definido según la categoría y el nivel de sensibilidad de los datos en Data Security Guard.
EditRecognizeRule	EditRecognizeRule.	Edita un campo sensible definido según la categoría y el nivel de sensibilidad de los datos en Data Security Guard.
QueryRecognizeDataByRuleType	Consultar la lista de métodos de reconocimiento de campos sensibles.	Consulta la lista de métodos de reconocimiento de campos sensibles en Data Protection Umbrella mediante la operación QueryRecognizeDataByRuleType.
QueryRecognizeRuleDetail	QueryRecognizeRuleDetail.	Obtiene los detalles de un campo sensible especificado en Data Security Guard.
DsgUserGroupGetOdpsRoleGroups	DsgUserGroupGetOdpsRoleGroups.	Consulta una lista de roles de MaxCompute que pueden ser seleccionados por los miembros de un grupo de usuarios cuando el inquilino crea o modifica dicho grupo en Data Security Guard.
DsgDesensPlanAddOrUpdate	DsgDesensPlanAddOrUpdate.	Llama a la API `DsgDesensPlanAddOrUpdate` para crear o editar una regla de desensibilización de datos.
DsgPlatformQueryProjectsAndSchemaFromMeta	DsgPlatformQueryProjectsAndSchemaFromMeta.	Consulta una lista de motores de cómputo de diferentes tipos en el inquilino actual.
DsgUserGroupDelete	DsgUserGroupDelete.	Elimina un grupo de usuarios configurado en Data Security Guard.
DsgWhiteListDeleteList	DsgWhiteListDeleteList.	Elimina una lista blanca de enmascaramiento de datos configurada en Data Security Guard.
DsgScenedDeleteScene	DsgScenedDeleteScene.	Elimina un escenario de enmascaramiento de datos de nivel 2 creado en Data Security Guard.
DsgDesensPlanDelete	DsgDesensPlanDelete.	Elimina una regla de enmascaramiento de datos creada en Data Security Guard.
DsgDesensPlanUpdateStatus	DsgDesensPlanUpdateStatus.	Modifica el estado de una regla de enmascaramiento de datos.
DsgWhiteListQueryList	DsgWhiteListQueryList.	Consulta una lista blanca de enmascaramiento de datos.
DsgSceneAddOrUpdateScene	DsgSceneAddOrUpdateScene.	Agrega o modifica un escenario de enmascaramiento de datos de nivel 2.
DsgSceneQuerySceneListByName	DsgSceneQuerySceneListByName	Llama a la API `DsgSceneQuerySceneListByName` para obtener una lista de escenarios de enmascaramiento de datos.
DsgUserGroupAddOrUpdate	DsgUserGroupAddOrUpdate.	Crea o actualiza un grupo de usuarios en Data Security Guard.
DsgUserGroupQueryList	DsgUserGroupQueryList.	Llama a `DsgUserGroupQueryList` para consultar grupos de usuarios en Data Security Guard (DSG).
DsgUserGroupQueryUserList	DsgUserGroupQueryUserList.	Consulta una lista de usuarios o roles del inquilino actual.
DsgDesensPlanQueryList	DsgDesensPlanQueryList.	Llama a la API `DsgDesensPlanQueryList` para consultar las reglas de enmascaramiento de datos de Data Security Guard (DSG).
DsgWhiteListAddOrUpdate	DsgWhiteListAddOrUpdate.	Agrega o modifica una lista blanca de enmascaramiento de datos.
DsgQueryDefaultTemplates	DsgQueryDefaultTemplates.	Obtiene las plantillas de tipos de datos sensibles disponibles y las reglas de desensibilización que admiten. Utilice la respuesta de esta API para configurar sus reglas de desensibilización.

Asistente de migración

API	Título	Descripción
CreateImportMigration	CreateImportMigration.	Crea una tarea de importación. La tarea de importación contiene los paquetes de importación de orígenes de datos, nodos y tablas.
GetMigrationProcess	GetMigrationProcess.	Consulta el progreso de una tarea de migración.
StartMigration	StartMigration.	Inicia una tarea de migración.
CreateExportMigration	CreateExportMigration.	Crea una tarea de exportación en DataWorks. Esta operación de API solo crea la tarea de exportación y no la inicia.
GetMigrationSummary	GetMigrationSummary.	Consulta la información sobre una tarea de migración.
ListMigrations	ListMigrations.	Consulta una lista de tareas de migración.

Centro de seguridad

API	Título	Descripción
CreatePermissionApplyOrder	Crear una orden de solicitud de permisos.	Crea una orden de solicitud de permisos. Nota: La versión 2020 de OpenAPI se descontinuará. Migre a la versión 2024 de OpenAPI — ApplyResourceAccessPermission lo antes posible.
GetPermissionApplyOrderDetail	Consulta los detalles de una orden de solicitud de permiso.	Consulta los detalles de una orden de solicitud de permiso. Nota: La versión 2020 de OpenAPI se discontinuará. Migre a la versión 2024 de OpenAPI lo antes posible: GetApplicationContents/GetProcessInstance.
ListPermissionApplyOrders	Consulta de la lista de órdenes de solicitud de permisos.	Consulta una lista de órdenes de solicitud de permisos. Nota: La versión 2020 de OpenAPI se descontinuará en una fecha programada. Migre a la versión 2024 de OpenAPI lo antes posible: ListMyApplications/ListPendingApprovals/ListMyRelatedApprovals.
ApprovePermissionApplyOrder	Aprueba una orden de solicitud de permisos.	Aprueba una orden de solicitud de permisos. Nota: La edición 2020 de OpenAPI se descontinuará. Migre a la edición 2024 de OpenAPI lo antes posible — ApproveProcessInstance.
RevokeTablePermission	Revocar permisos de tabla a un usuario.	Revoca los permisos de tabla a un usuario.

Plataforma abierta

API	Título	Descripción
ListExtensions	Obtener lista de extensiones.	Obtiene la lista de extensiones de la plataforma abierta.
GetExtension	GetExtension.	Obtiene los detalles de una extensión.
GetOptionValueForProject	GetOptionValueForProject.	Consulta la configuración de opciones de una extensión en un espacio de trabajo.
ListEnabledExtensionsForProject	ListEnabledExtensionsForProject.	Consulta una lista de extensiones integradas y personalizadas que están habilitadas en un espacio de trabajo.
CallbackExtension	Devolver el resultado de la verificación de un programa de extensión para un evento de punto de extensión.	Devuelve el resultado de la verificación de un programa de extensión para un evento de punto de extensión a la plataforma DataWorks mediante la llamada a la operación CallbackExtension cuando se activa un punto de extensión durante el uso de la plataforma DataWorks.
ListCheckProcesses	Consultar la lista de verificación de eventos de extensión.	Consulta la lista de verificación de eventos de extensión.

Otros

API	Título	Descripción
UpdateTableAddColumn	Actualiza la información de las columnas de la tabla.	Actualiza la información de las columnas de una tabla de MaxCompute.
GetMetaTableFullInfo	Obtener la información completa de la tabla, incluida la información de los campos.	Obtiene la información completa de una tabla, incluida la información de los campos.
GetDDLJobStatus	Obtiene el estado del trabajo DDL.	Obtiene el estado de las tareas para crear, actualizar y eliminar tablas.
DeleteTable	DeleteTable.	Elimina una tabla de MaxCompute.
UpdateTable	UpdateTable.	Actualiza una tabla de MaxCompute.
CreateTable	CreateTable.	Crea una tabla de MaxCompute.
CheckFileDeployment	Verificar despliegue de archivo.	Devuelve el resultado de la verificación de un archivo pendiente de despliegue en DataWorks. Después de enviar un archivo creado en la página DataStudio de DataWorks, el archivo entra en estado de verificación de despliegue. DataWorks devuelve un evento de verificación de despliegue de archivo, y usted debe determinar si el archivo puede continuar con la verificación de despliegue según el contenido del evento. Puede llamar a esta operación para obtener el resultado de la verificación del archivo pendiente de despliegue en DataWorks.
ListRefDISyncTasks	Lista de tareas de sincronización de integración de datos referenciadas.	Consulta las tareas de sincronización en Data Integration que utilizan un origen de datos específico.
ExportDataSources	ExportDataSources.	Exporta una lista de orígenes de datos.
ImportDataSources	ImportDataSources.	Importa orígenes de datos desde su máquina local a un espacio de trabajo específico de DataWorks.
UpdateClusterConfigs	Actualizar configuraciones del clúster.	Actualiza las configuraciones de los submódulos de un clúster en un espacio de trabajo. Actualmente, solo se admiten parámetros de Spark.
ListClusterConfigs	ListClusterConfigs.	Consulta las configuraciones de los submódulos en un espacio de trabajo. Puede consultar información sobre los parámetros de SPARK.
ListClusters	ListClusters.	Consulta los clústeres registrados en DataWorks. Se admiten clústeres de E-MapReduce (EMR) y clústeres de Cloudera's Distribution Including Apache Hadoop (CDH).

API obsoletas

API	Título	Descripción
ListEntitiesByTags	Enumera entidades por etiqueta.	Enumera las entidades por etiqueta. Actualmente, solo se admiten entidades del tipo maxcompute-table.
RemoveEntityTags	Quita etiquetas de una entidad.	Quita etiquetas de una entidad. Actualmente, solo se admiten entidades del tipo maxcompute-table.
SetEntityTags	Establece etiquetas para una entidad.	Establece etiquetas para una entidad. Actualmente, solo se admiten entidades del tipo maxcompute-table.
ListEntityTags	Enumerar etiquetas de entidad.	Enumera las etiquetas de una entidad. Actualmente, solo se admiten las entidades de tipo maxcompute-table.
SetDataSourceShare	SetDataSourceShare.	Comparte un origen de datos con un espacio de trabajo de DataWorks específico o un usuario específico.
CreateConnection	CreateConnection.	Agrega un origen de datos.
CreateDagComplement	Crear un flujo de trabajo de relleno de datos.	Crea un flujo de trabajo de relleno de datos mediante la llamada a CreateDagComplement.
CreateDagTest	Crear un flujo de trabajo de prueba de humo.	Crea un flujo de trabajo de prueba de humo mediante la llamada a CreateDagTest.
CreateManualDag	Desencadenar la ejecución de un proceso de negocio manual.	Desencadena la ejecución de un proceso de negocio manual. El proceso de negocio manual debe haberse enviado y publicado en la consola, y el centro de O&M debe poder encontrar el proceso de negocio manual correspondiente antes de que pueda invocar esta operación.
DeleteConnection	DeleteConnection.	Elimina un origen de datos.
UpdateConnection	UpdateConnection.	Actualiza un origen de datos.
ListConnections	ListConnections.	Consulta una lista de orígenes de datos.
GetProjectDetail	Consulta la información del espacio de trabajo.	Consulta la información de un espacio de trabajo de DataWorks.
ListNodeIO	Consultar información del DAG.	Consulta la información de los nodos anteriores y posteriores. Solo se puede consultar un nivel.
GetInstanceStatusCount	GetInstanceStatusCount.	Consulta las estadísticas de instancias en diferentes estados.
ListProgramTypeCount	ListProgramTypeCount.	Consulta la distribución de los diferentes tipos de nodos.
GetManualDagInstances	Consultar información sobre instancias de flujos de trabajo activados manualmente.	Consulta información sobre instancias de un flujo de trabajo activado manualmente.
SearchNodesByOutput	Consultar nodos por salida.	Consulta nodos por coincidencia exacta según la salida.
GetNodeTypeListInfo	GetNodeTypeListInfo.	Consulta la información sobre los tipos de nodo, incluido el código y el nombre de un tipo de nodo.
GetNodeOnBaseline	Consultar los nodos en una línea base.	Llama a la operación GetNodeOnBaseline para consultar los nodos en una línea base.
GetSuccessInstanceTrend	Obtener tendencias estadísticas horarias de las instancias del día actual.	Obtiene las tendencias estadísticas horarias de las instancias del día actual.
GetInstanceCountTrend	GetInstanceCountTrend.	Consulta la tendencia de cantidad de instancias activadas automáticamente.
GetInstanceConsumeTimeRank	Consulta la clasificación de instancias por duración de ejecución.	Consulta la clasificación de instancias por duración de ejecución.
GetInstanceErrorRank	Obtiene la clasificación de errores de los nodos en el último mes.	Llama a GetInstanceErrorRank para obtener la clasificación de errores de los nodos en el último mes.