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/2024-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.

Agente de datos

API	Título	Descripción
Gestión de servidores MCP	Gestión de servidores MCP
CreateMcpServer	Crear un servidor MCP	Crea un servidor MCP.
DeleteMcpServer	Delete MCP Server.	Elimina un servidor MCP.
UpdateMcpServer	Actualizar un servidor MCP	Actualiza un servidor MCP.
GetMcpServer	GetMcpServer.	Devuelve los detalles de un servidor MCP.
ListMcpServers	ListMcpServers.	Obtiene una lista paginada de servidores MCP.
Gestión de habilidades	Gestión de habilidades
CreateSkill	Crear una habilidad	Crea una habilidad en DataWorks.
UpdateSkill	Actualizar una habilidad.	Actualiza una habilidad especificada y genera una nueva versión.
DeleteSkill	Delete Skill.	Elimina una habilidad.
GetSkill	GetSkill.	Obtiene los detalles de una habilidad especificada mediante su nombre, incluidos el contenido del archivo SKILL.md y el enlace de descarga del paquete.
ListSkills	Listado de habilidades	Realiza una consulta paginada para listar las habilidades de la cuenta actual.
Gestión de agentes	Gestión de agentes
CreateAgent	Crear un agente	Crea un agente.
ListCustomAgents	Enumerar agentes personalizados	Enumera los agentes personalizados con paginación.
DeleteAgent	Eliminar un agente.	Elimina un agente.
GetAgent	GetAgent.	Obtiene los detalles del agente por nombre.
ListAgents	Consultar lista de agentes.	Consulta la lista de agentes disponibles para el inquilino actual, con compatibilidad para filtrado por nombre y paginación.
Gestión de sesiones de agente	Gestión de sesiones de agente
PromptAgentSession	Enviar prompt de sesión.	Envía un prompt de usuario a una sesión existente y devuelve la respuesta del agente en modo de transmisión.
ReplyAgentSession	Respuesta a la entrada de solicitud de sesión	Responde a una interacción de usuario pendiente en una sesión de DataAgent.
LoadAgentSession	LoadAgentSession.	Carga el historial de mensajes de una sesión existente y lo devuelve como un flujo SSE. Si la sesión no existe, el servidor envía un JSONRPCResponse.error con el código 400 a través del flujo SSE. El Content-Type es text/event-stream. Utilice esta operación para restaurar el contexto de la sesión.
ListAgentSessions	Consultar lista de sesiones.	Carga la lista del historial de conversaciones de una sesión de agente.
ListAgentSessionArtifacts	Consultar lista de artefactos de sesión.	Consulta la lista de archivos de artefactos generados por una sesión especificada.
GetAgentSessionTokenUsage	GetAgentSessionTokenUsage.	Obtiene el uso acumulado de tokens de IA para una sesión especificada.
GetAgentSessionArtifactMeta	GetAgentSessionArtifactMeta.	Obtiene los metadatos y el contenido de un artefacto a partir del ID de sesión y la ruta del artefacto.
CreateAgentSession	Creación de una sesión de agente.	Crea una nueva sesión de agente y devuelve el ID de la sesión.
CancelAgentSession	Cancelar una sesión.	Interrumpe la llamada del agente para una sesión especificada y admite la interrupción durante las respuestas en streaming.

Gestión de espacios de trabajo

API	Título	Descripción
Espacios de trabajo	Espacios de trabajo
CreateProject	Crear un espacio de trabajo.	Crea un espacio de trabajo.
DeleteProject	Eliminar un espacio de trabajo.	Elimina un espacio de trabajo de DataWorks.
UpdateProject	UpdateProject.	Actualiza un espacio de trabajo de DataWorks.
ListProjects	ListProjects.	Consulta la lista de espacios de trabajo de DataWorks del inquilino al que pertenece su cuenta.
GetProject	Obtener detalles del espacio de trabajo.	Consulta los detalles de un espacio de trabajo de DataWorks.
Roles de espacio de trabajo	Roles de espacio de trabajo
CreateProjectRole	CreateProjectRole.	Crea un rol personalizado para un espacio de trabajo.
DeleteProjectRole	Eliminar un rol personalizado de un espacio de trabajo.	Elimina un rol personalizado de un espacio de trabajo.
UpdateProjectRole	Actualizar un rol personalizado de un espacio de trabajo.	Actualiza los permisos de un rol personalizado en un espacio de trabajo.
GetProjectRole	GetProjectRole.	Consulta los detalles de un rol del espacio de trabajo.
ListProjectRoles	Detalles de los roles del espacio de trabajo	Consulta los detalles de los roles del espacio de trabajo con paginación.
Miembros del espacio de trabajo	Miembros del espacio de trabajo
CreateProjectMember	Crear un miembro del espacio de trabajo.	Agrega un miembro al espacio de trabajo y le asigna roles del espacio de trabajo.
DeleteProjectMember	Eliminar un miembro del espacio de trabajo.	Elimina un miembro del espacio de trabajo y los roles de espacio de trabajo otorgados al miembro.
GrantMemberProjectRoles	Asignación de roles de proyecto a miembros.	Asigna roles a los miembros de un espacio de trabajo.
RevokeMemberProjectRoles	Revocar roles de espacio de trabajo de un miembro del espacio de trabajo.	Revoca roles de un miembro del espacio de trabajo.
GetProjectMember	GetProjectMember.	Obtiene los detalles de un miembro específico de un espacio de trabajo.
ListProjectMembers	ListProjectMembers.	Obtiene una lista paginada de los detalles de los miembros del espacio de trabajo.

Orígenes de datos

API	Título	Descripción
UpdateDataSource	Actualizar un origen de datos	Modifica un origen de datos especificado según el ID del origen de datos.
TestDataSourceConnectivity	Prueba de conectividad de una fuente de datos.	Prueba la conectividad de una fuente de datos en un grupo de recursos.
CreateDataSource	Crear un origen de datos	Crea un origen de datos en un espacio de trabajo especificado para el entorno de desarrollo o de producción.
DeleteDataSource	DeleteDataSource.	Elimina un origen de datos mediante el ID del origen de datos.
CloneDataSource	Clonar un origen de datos	Clona un origen de datos existente para crear uno nuevo.
ListDataSources	ListDataSources.	Obtiene una lista de orígenes de datos que coinciden con las condiciones de filtro especificadas.
Reglas de uso compartido de orígenes de datos	Reglas de uso compartido de orígenes de datos
CreateDataSourceSharedRule	CreateDataSourceSharedRule.	Crea una regla de uso compartido de una fuente de datos para compartirla con otros espacios de trabajo o usuarios RAM.
DeleteDataSourceSharedRule	Eliminar una regla de uso compartido de origen de datos	Elimina una regla de uso compartido de origen de datos mediante su ID.
ListDataSourceSharedRules	Lista de reglas de uso compartido de origen de datos.	Obtiene una lista de las reglas de uso compartido de un origen de datos.

Recursos de cómputo

API	Título	Descripción
DeleteComputeResource	Eliminar un recurso de cómputo.	Elimina el recurso de cómputo especificado en función del ID del recurso de cómputo.
GetComputeResource	GetComputeResource.	Consulta el recurso de computación especificado en función del ID del recurso de computación.
UpdateComputeResource	Actualizar un recurso de cómputo	Modifica un recurso de cómputo especificado según el ID del recurso de cómputo.
ListComputeResources	ListComputeResources.	Consulta la lista de recursos de cómputo que cumplen con la información de negocio especificada.
CreateComputeResource	Crear un recurso de cómputo	Crea un recurso de cómputo en un espacio de trabajo especificado. El recurso de cómputo se puede utilizar en el entorno de desarrollo o de producción.
GetComputeResourceAuthUserMappings	Obtener información de asignación de cuentas del recurso de cómputo.	Consulta las asignaciones de usuario de un recurso de cómputo. Admite los tipos de recurso EMR y Serverless Spark.
UpdateComputeResourceAuthUserMappings	Actualizar la asignación de cuentas del recurso de cómputo.	Actualiza la asignación de cuentas de un recurso de cómputo. Esta operación admite actualmente los tipos de recursos EMR y Serverless Spark.

Gestión de grupos de recursos

API	Título	Descripción
Grupos de recursos	Grupos de recursos
CreateResourceGroup	Crear un grupo de recursos	Crea un grupo de recursos.
DeleteResourceGroup	Eliminar un grupo de recursos de uso general.	Elimina un grupo de recursos de uso general.
UpdateResourceGroup	UpdateResourceGroup.	Actualiza la información básica de un grupo de recursos.
GetResourceGroup	Obtener detalles del grupo de recursos por ID	Obtiene los detalles de un grupo de recursos especificado por ID.
ListResourceGroups	Lista de grupos de recursos	Obtiene una lista de grupos de recursos.
DissociateProjectFromResourceGroup	Desasociar un grupo de recursos de un espacio de trabajo.	Desasocia un grupo de recursos de un espacio de trabajo.
AssociateProjectToResourceGroup	Asociar un grupo de recursos con un espacio de trabajo.	Asocia un grupo de recursos con un espacio de trabajo.
ListResourceGroupAssociateProjects	ListResourceGroupAssociateProjects.	Consulta la lista de espacios de trabajo con los que está asociado un grupo de recursos.
ListResourceGroupMetricData	ListResourceGroupMetricData.	Consulta los datos de métricas de un grupo de recursos.
Enrutamiento	Enrutamiento
CreateRoute	Crear ruta.	Crea una ruta para una red.
DeleteRoute	DeleteRoute.	Elimina una ruta de un recurso de red.
UpdateRoute	UpdateRoute.	Actualiza la información de una ruta.
GetRoute	GetRoute.	Consulta la información de una ruta a partir de su ID.
ListRoutes	Obtener la lista de rutas de un recurso de red.	Obtiene la lista de rutas de un recurso de red.
Redes	Redes
CreateNetwork	Crear red.	Crea una red y la asocia con un grupo de recursos general.
DeleteNetwork	Desasociar y eliminar un recurso de red de un grupo de recursos de propósito general.	Desasocia y elimina un recurso de red de un grupo de recursos de propósito general.
GetNetwork	Obtener detalles del recurso de red	Obtiene los detalles de un recurso de red.
ListNetworks	Consulta de recursos de red en un grupo de recursos	Consulta los recursos de red en un grupo de recursos.

Gestión de imágenes

API	Título	Descripción
CreateImage	Crear una imagen	Crea una imagen.
UpdateImage	Actualizar imagen	Actualiza una imagen.
RunImageTest	Ejecutar prueba de imagen.	Ejecuta una prueba de imagen.
ListImageTestResults	Obtener resultados de pruebas de imágenes	Consulta una lista de resultados de pruebas de imágenes.
GetImageTestResult	Obtener el resultado de una tarea de prueba de imagen especificada	Obtiene los detalles del resultado de una prueba de imagen.
CancelImageTest	Cancelar prueba de imagen.	Cancela una prueba de imagen.
PublishImage	Publicar una imagen.	Publica una imagen.
BuildImage	Compilar una imagen.	Compila una imagen.
RollbackImage	Revertir una imagen.	Revierte una imagen.
EnableImage	Habilitar una imagen.	Habilita una imagen.
DisableImage	Deshabilitar una imagen.	Deshabilita una imagen.
GetImage	Obtener detalles de imagen por ID	Obtiene los detalles de una imagen especificada por ID de imagen.
ListImages	Obtener una lista de imágenes	Obtiene una lista de imágenes.
ListImageVersions	Obtener detalles de la versión de imagen.	Obtiene los detalles de una versión de imagen especificada.
DeleteImage	Eliminar una imagen.	Elimina una imagen.
AssociateProjectToImage	Asociar una imagen con un espacio de trabajo.	Asocia una imagen con un espacio de trabajo.
DissociateProjectFromImage	Desasociar una imagen de un espacio de trabajo.	Desasocia una imagen de un espacio de trabajo.
ListImageAssociatedProjects	Enumerar espacios de trabajo asociados con una imagen.	Enumera los espacios de trabajo asociados con una imagen.

Estudio de datos (nueva versión)

API	Título	Descripción
Instantáneas	Instantáneas
GetSnapshot	Obtener detalles de la instantánea de versión.	Obtiene los detalles de una instantánea de versión.
ListSnapshots	Obtener lista de instantáneas de versión.	Obtiene una lista de instantáneas de versión.
Componentes	Componentes
CreateComponent	Crear un componente.	Crea un componente.
DeleteComponent	Eliminar un componente.	Elimina un componente.
GetComponent	GetComponent.	Obtiene la información del componente.
UpdateComponent	Actualizar un componente.	Actualiza componentes.
ListComponents	Lista de componentes.	Obtiene una lista de componentes.
Nodos	Nodos
CreateNode	Crear un nodo de Data Studio.	Crea un nodo de Data Studio en la nueva versión de Data Studio.
DeleteNode	Eliminar un nodo de Data Studio.	Elimina un nodo de Data Studio especificado.
UpdateNode	Actualizar un nodo.	Actualiza la información básica de un nodo en Data Studio. Esta operación de API actualiza la información de forma incremental. La información de actualización se describe mediante FlowSpec.
MoveNode	MoveNode.	Mueve un nodo a una ruta en Data Studio.
RenameNode	RenameNode.	Cambia el nombre de un nodo en Data Studio.
GetNode	GetNode.	Consulta la información de un nodo en Data Studio.
ListNodes	Lista de nodos de desarrollo de datos	Obtiene una lista de nodos de desarrollo de datos con paginación. También puede realizar una consulta filtrada en la lista mediante condiciones especificadas.
ListNodeDependencies	Obtener nodos dependientes de un nodo de desarrollo de datos	Obtiene los nodos dependientes de un nodo de desarrollo de datos especificado de forma paginada.
Definiciones de flujos de trabajo	Definiciones de flujos de trabajo
CreateWorkflowDefinition	Crear un flujo de trabajo de Data Studio.	Crea un flujo de trabajo en una carpeta especificada de Data Studio.
ImportWorkflowDefinition	Importar un flujo de trabajo de Data Studio.	Importa un flujo de trabajo definido mediante FlowSpec y sus nodos secundarios internos en Data Studio.
DeleteWorkflowDefinition	Eliminar un flujo de trabajo de Data Studio.	Elimina un flujo de trabajo especificado en Data Studio.
UpdateWorkflowDefinition	UpdateWorkflowDefinition.	Actualiza la información básica de un flujo de trabajo en Data Studio. Esta operación de la API actualiza de forma incremental. La información de la actualización se describe mediante FlowSpec.
MoveWorkflowDefinition	MoveWorkflowDefinition.	Mueve un flujo de trabajo a una ruta en Data Studio.
RenameWorkflowDefinition	Cambiar el nombre de un flujo de trabajo de Data Studio.	Cambia el nombre de un flujo de trabajo en Data Studio.
GetWorkflowDefinition	Obtener detalles del flujo de trabajo de Data Studio.	Consulta la información sobre un flujo de trabajo.
ListWorkflowDefinitions	Lista de flujos de trabajo de desarrollo de datos	Consulta una lista paginada de flujos de trabajo de desarrollo de datos. También puede filtrar los flujos de trabajo según condiciones especificadas.
Recursos	Recursos
CreateResource	Crear un recurso de archivo de Data Studio.	Crea un recurso de archivo para Data Studio. La información del recurso de archivo se define en formato FlowSpec.
DeleteResource	Eliminar un recurso de archivo.	Elimina un recurso de archivo de Data Studio.
UpdateResource	Actualizar la información del recurso de archivo de Data Studio.	Actualiza la información básica de un recurso de archivo en Data Studio. Esta operación de API es incremental. La información de la actualización se describe mediante FlowSpec.
GetResource	Obtener detalles del recurso de archivo de Data Studio.	Consulta la información de un recurso de archivo.
ListResources	Obtener recursos de archivos de desarrollo de datos	Obtiene una lista paginada de archivos de recursos y filtra recursos.
MoveResource	Mover un recurso de archivo de Data Studio.	Mueve un recurso de archivo a una ruta en Data Studio.
RenameResource	Renombrar un recurso de archivo de Data Studio.	Renombra un recurso de archivo en Data Studio.
Funciones	Funciones
CreateFunction	Crear una función de Data Studio.	Crea una función UDF en Data Studio. La información de la función UDF se describe en formato FlowSpec.
DeleteFunction	Eliminar función.	Elimina una función definida por el usuario (UDF) en Data Studio.
UpdateFunction	Actualiza la información de la función de Data Studio.	Actualiza la información básica de una función definida por el usuario (UDF) en Data Studio. Esta operación de API actualiza la información de manera incremental. La información de actualización se describe mediante FlowSpec.
MoveFunction	Mover una función de Data Studio.	Mueve una función definida por el usuario (UDF) a una ruta en Data Studio.
RenameFunction	Cambiar el nombre de una función de Data Studio.	Cambia el nombre de una función definida por el usuario (UDF) en Data Studio.
GetFunction	Obtener detalles de la función de Data Studio.	Consulta los detalles de una función definida por el usuario (UDF) en Data Studio.
ListFunctions	Lista de funciones de Data Studio.	Obtiene una lista paginada de funciones UDF en Data Studio. También puede usar condiciones de filtro para filtrar funciones UDF.
Flujos de trabajo de publicación	Flujos de trabajo de publicación
CreatePipelineRun	Crear un proceso de despliegue	Crea un proceso de despliegue para una entidad en Data Studio.
AbolishPipelineRun	Detener un proceso de despliegue.	Cambia el estado de un proceso de despliegue especificado a terminado. El proceso de despliegue no se elimina y aún se puede consultar mediante operaciones de consulta.
ExecPipelineRunStage	Ejecutar una etapa especificada de un proceso de despliegue.	Ejecuta una etapa especificada de un proceso de despliegue.
GetPipelineRun	Detalles del proceso de despliegue.	Obtiene los detalles de un proceso de despliegue.
ListPipelineRuns	Lista de procesos de despliegue.	Obtiene una lista paginada de procesos de despliegue. También puede filtrar esta lista según criterios específicos.
ListPipelineRunItems	Obtener el contenido del despliegue.	Consulta la información de los objetos de despliegue mediante el ID del proceso de despliegue.
Entorno de desarrollo personal	Entorno de desarrollo personal
ListServerIdeInstances	Lista de instancias de entorno de desarrollo personal	Realiza una consulta paginada de instancias de entorno de desarrollo personal. Al invocar esta operación, utilice el endpoint de DataWorks que corresponde a la región del espacio de trabajo de destino.
GetServerIdeInstance	Consultar instancia de entorno de desarrollo personal.	Consulta los detalles de una instancia de entorno de desarrollo personal especificada.
ListServerIdeImages	Consulta de imágenes para entornos de desarrollo personal.	Consulta la lista de imágenes disponibles para entornos de desarrollo personal mediante paginación.
ListServerIdeEcsSpecs	Consulta de tipos de instancia de ECS para entornos de desarrollo personal.	Consulta la lista de tipos de instancia de ECS disponibles para entornos de desarrollo personal.
CreateServerIdeInstance	Crear una instancia de entorno de desarrollo personal.	Crea una instancia de entorno de desarrollo personal.
UpdateServerIdeInstance	Actualizar una instancia de entorno de desarrollo personal.	Actualiza la configuración de una instancia de entorno de desarrollo personal especificada.
StopServerIdeInstance	Detener una instancia de entorno de desarrollo personal.	Detiene una instancia de entorno de desarrollo personal especificada.
StartServerIdeInstance	Iniciar una instancia de entorno de desarrollo personal.	Inicia una instancia de entorno de desarrollo personal especificada.
DeleteServerIdeInstance	Eliminar una instancia de entorno de desarrollo personal.	Elimina una instancia de entorno de desarrollo personal especificada.

Estudio de datos (versión anterior)

API	Título	Descripción
Archivos	Archivos
CreateFile	Crear un archivo en Data Studio.	Crea un archivo en Data Studio. Esta operación no admite la creación de nodos de Data Integration.
CreateResourceFile	Crear archivo de recursos.	Permite a los usuarios especificar sus propios archivos (como JAR, PY, archivo comprimido o archivo) para crear archivos de recursos de Data Studio.
CreateUdfFile	Crear un archivo de función en Data Studio.	Crea un archivo para una función en Data Studio.
UpdateFile	Actualizar un nodo de archivo existente	Actualiza un archivo existente.
UpdateUdfFile	Actualización de la información del archivo de la función	Actualiza la información del archivo de una función.
GetFile	Detalles de un archivo.	Obtiene los detalles de un archivo.
ListFiles	Consulta de la lista de archivos.	Consulta una lista de archivos al llamar a ListFiles.
SubmitFile	Enviar un archivo al entorno de desarrollo del sistema de programación.	Envía un archivo al entorno de desarrollo del sistema de programación para generar una tarea.
DeployFile	Deploy file.	Despliega un archivo en el entorno de producción.
Carpetas	Carpetas
CreateFolder	Crear una carpeta.	Crea una carpeta.
DeleteFolder	Eliminar una carpeta en Data Studio.	Invoca la operación DeleteFolder para eliminar una carpeta en la página de Data Studio.
UpdateFolder	Actualización de información de carpeta.	Invoca la operación UpdateFolder para actualizar la información de la carpeta.
GetFolder	Obtener detalles de la carpeta.	Consulta la información sobre una carpeta.
ListFolders	Consulta de lista de carpetas.	Consulta una lista de carpetas.
Flujos de negocio	Flujos de negocio
CreateBusiness	Crear un proceso de negocio.	Crea un proceso de negocio en Data Studio para el desarrollo de datos.
DeleteBusiness	Eliminar un flujo de trabajo.	Elimina un flujo de trabajo.
UpdateBusiness	Actualizar flujo de trabajo.	Actualiza un flujo de trabajo.
GetBusiness	Consulta de detalles del flujo de negocio	Consulta los detalles de un flujo de negocio.
ListBusiness	ListBusiness.	Consulta una lista de flujos de trabajo.
Paquetes de publicación	Paquetes de publicación
GetDeploymentPackage	Obtener detalles del paquete de despliegue.	Obtiene los detalles de un paquete de despliegue.
ListDeploymentPackages	Consulta de paquetes de despliegue.	Consulta una lista de paquetes de despliegue.
ListDeploymentPackageFiles	Obtener versiones de archivos pendientes de despliegue.	Obtiene la lista de versiones de archivos pendientes de despliegue.
Versiones de archivo	Versiones de archivo
GetFileVersion	Obtener los detalles de la versión del archivo.	Obtiene los detalles de la versión de un archivo.
ListFileVersions	Consulta de versiones de archivo.	Consulta la lista de versiones de un archivo.
Eventos de puntos de extensión	Eventos de puntos de extensión
UpdateIDEEventResult	Actualizar el resultado de la verificación de un evento de punto de extensión.	Informa el resultado de la verificación de un mensaje de evento de punto de extensión mediante un callback.
GetIDEEventDetail	GetIDEEventDetail.	Consulta la instantánea de datos de un punto de extensión a partir del ID de un mensaje en DataWorks OpenEvent cuando se activa el evento de punto de extensión relacionado.
Tablas	Tablas
EstablishRelationTableToBusiness	Importar una tabla a un flujo de trabajo.	Importa una tabla a un flujo de trabajo. Llamar a esta operación equivale a hacer clic con el botón derecho en un flujo de trabajo en la página Data Studio y seleccionar Importar tabla.

Integración de datos

API	Título	Descripción
Tareas de sincronización	Tareas de sincronización
CreateDIJob	Crear una tarea de sincronización de integración de datos.	Crea una tarea en la nueva versión de Data Integration.
UpdateDIJob	UpdateDIJob.	Actualiza una tarea de Data Integration.
DeleteDIJob	Eliminar trabajo de DI.	Elimina una tarea de sincronización de nueva versión.
StopDIJob	Detener una tarea de sincronización de integración de datos.	Cancela una tarea de integración de datos.
StartDIJob	StartDIJob.	Inicia una tarea de sincronización de nueva versión.
GetDIJob	Detalles de configuración de la tarea de sincronización de Data Integration.	Consulta las tareas de integración de datos.
GetDIJobLog	Ver los registros de ejecución de una tarea de sincronización de integración de datos.	Obtiene los registros de una tarea de integración de datos.
ListDIJobs	Lista de configuraciones de tareas de sincronización de Data Integration.	Enumera las tareas de la nueva versión de Data Integration, incluidas las tareas de sincronización de bases de datos en tiempo real, las tareas de sincronización de bases de datos por lotes y las tareas de sincronización de una sola tabla en tiempo real.
ListDIJobRunDetails	ListDIJobRunDetails.	Consulta la información de ejecución de una tarea de sincronización.
ListDIJobMetrics	Lista de métricas de trabajo de DI.	Consulta las métricas de una tarea de sincronización.
ListDIJobEvents	ListDIJobEvents.	Consulta los eventos de una tarea de sincronización.
Alertas de tareas	Alertas de tareas
CreateDIAlarmRule	Crear una regla de alerta para una tarea de sincronización de integración de datos.	Crea una regla de alerta para una tarea de integración de datos.
UpdateDIAlarmRule	UpdateDIAlarmRule.	Actualiza una regla de alerta configurada para una tarea de sincronización.
DeleteDIAlarmRule	DeleteDIAlarmRule.	Elimina una regla de alerta configurada para una tarea de sincronización.
ListDIAlarmRules	ListDIAlarmRules.	Consulta las reglas de alerta configuradas para una tarea de sincronización.

Mapa de datos

API	Título	Descripción
Análisis semántico	Análisis semántico
ListSemanticJobs	Listar trabajos semánticos.	Consulta las definiciones de nodos semánticos del inquilino actual con paginación. Los campos Name, ProjectId y Source en los elementos de la lista se pueden utilizar para ejecutar o eliminar nodos, consultar detalles de ejecución y verificar el alcance de entrada, respectivamente.
CreateSemanticJob	Crear un trabajo semántico.	Guarda una definición de trabajo semántico reutilizable. Si utiliza un origen de archivo único, solicite y complete primero la carga del archivo adjunto. Después de la creación, llame a RunSemanticJob con el Name devuelto.
DeleteSemanticJob	Eliminar un trabajo semántico.	Elimina una definición de trabajo semántico mediante el nombre de un trabajo creado. Si el trabajo se está ejecutando actualmente, llame a KillSemanticJob con el ExecutorJobId de esa ejecución y confirme la detención antes de eliminarlo.
DownloadSemanticResults	Obtener la URL de descarga de resultados de trabajos semánticos.	Devuelve la URL de descarga de artefactos por nombre de trabajo y un ID de ejecución opcional después de que se completa una ejecución. Si no se especifica JobRunId, se devuelven los resultados de la ejecución más reciente del trabajo.
GetSemanticJobDetail	Consulta de detalles de ejecución de trabajos semánticos.	Consulta el estado del ejecutor y la configuración de tiempo de ejecución mediante el ExecutorJobId devuelto por RunSemanticJob o ListSemanticJobRuns.
RunSemanticJob	Ejecutar un trabajo semántico.	Envía un trabajo semántico guardado para su ejecución por nombre y devuelve los identificadores de la ejecución y del ejecutor. Una llamada exitosa indica que el trabajo se ha enviado, no que se hayan generado los resultados del modelo semántico.
ListSemanticJobRuns	Consulta de registros de ejecución de trabajos semánticos.	Consulta los registros de ejecución de un nodo creado por nombre con paginación. El JobRunId en cada registro se utiliza para obtener los resultados de una ejecución específica, y el ExecutorJobId se utiliza para consultar detalles, recuperar registros o detener la ejecución.
GetSemanticJobLog	Consulta de registros de ejecución de trabajos semánticos.	Consulta los registros de ejecución mediante el ExecutorJobId devuelto por RunSemanticJob o ListSemanticJobRuns. El contrato POP actual expone solo los identificadores de tarea y espacio de trabajo, y devuelve segmentos de registro predeterminados.
KillSemanticJob	Detener una ejecución de un trabajo semántico.	Detiene una ejecución especificada mediante el ExecutorJobId que devuelven RunSemanticJob o ListSemanticJobRuns. Una llamada correcta indica únicamente que la solicitud de detención se ha aceptado. Consulte el estado final mediante la llamada a GetSemanticJobDetail.
UploadSemanticFile	Solicitar una URL de carga para archivos adjuntos de tareas semánticas.	Solicita una URL temporal de carga PUT de OSS. Complete la carga PUT antes de que expire la URL y luego pase el FileId devuelto al parámetro ReferenceFileIds de CreateSemanticJob.
Atributos personalizados	Atributos personalizados
ListCustomAttributes	Listar atributos personalizados.	Consulta la lista de definiciones de atributos personalizados.
GetCustomAttribute	GetCustomAttribute.	Obtiene una definición de atributo personalizado.
CreateCustomAttribute	Crear un atributo personalizado.	Crea una definición de atributo personalizado.
UpdateCustomAttribute	Actualizar atributo personalizado.	Actualiza un atributo personalizado.
DeleteCustomAttribute	DeleteCustomAttribute.	Elimina una definición de atributo personalizado.
Definiciones de entidades de metadatos personalizados	Definiciones de entidades de metadatos personalizados
ListMetaEntityDefs	Consultar lista de definiciones de entidades de metadatos.	Consulta la lista de definiciones de entidades personalizadas, incluidos los tipos de entidades personalizadas y los tipos de tablas de extensión.
GetMetaEntityDef	GetMetaEntityDef.	Obtiene los detalles de una definición de entidad personalizada.
CreateMetaEntityDef	Crear una definición de tipo de entidad de metadatos.	Crea una definición de entidad de metadatos, incluidos tipos personalizados y tipos de tabla extendidos.
UpdateMetaEntityDef	Actualizar definición de entidad de metadatos.	Actualiza una definición de entidad de metadatos, incluidos los tipos de entidad personalizados y los tipos de tabla de extensión.
DeleteMetaEntityDef	Eliminar una definición de entidad de metadatos.	Elimina una definición de entidad de metadatos, incluidos los tipos de entidad personalizados y los tipos de tabla de extensión.
Recopiladores de metadatos	Recopiladores de metadatos
ListCrawlerTypes	ListCrawlerTypes.	Consulta una lista de tipos de rastreadores de metadatos admitidos en Data Map. También se devuelven los subtipos de los tipos y la relación jerárquica entre los subtipos.
GetCrawlerTypeCapabilities	Consulta de capacidades de tipos de rastreador.	Consulta los tipos de rastreadores admitidos en la región actual, junto con su alcance de recolección, programación y capacidades de configuración de extensiones.
CreateCrawler	Crear un rastreador de metadatos.	Crea un rastreador de metadatos y configura el origen de datos, el alcance de la recolección, el grupo de recursos y el método de programación.
ListCrawlers	List metadata crawlers.	Consulta rastreadores de metadatos mediante una consulta paginada y admite el filtrado por espacio de trabajo, origen de datos, tipo, entorno, propietario y nombre.
GetCrawler	Consultar detalles del rastreador de metadatos.	Consulta la configuración, el estado y la información de la última ejecución de un rastreador de metadatos especificado.
UpdateCrawler	Actualizar un rastreador de metadatos.	Actualiza el grupo de recursos, el alcance de la recolección, la programación y las configuraciones de extensión de un rastreador de metadatos especificado.
RunCrawler	Ejecutar un crawler de metadatos.	Desencadena la ejecución de un crawler de metadatos especificado y devuelve el estado de aceptación y la información de la instancia de tarea asociada.
StopCrawler	Detener una ejecución de rastreador de metadatos.	Detiene la tarea en ejecución actual de un rastreador de metadatos especificado.
ListCrawlerRuns	Consulta de registros de ejecución del rastreador.	Consulta los registros de ejecución de un rastreador de metadatos especificado mediante paginación, con filtrado opcional por rango de tiempo y estado de ejecución.
DeleteCrawler	Eliminar un rastreador de metadatos.	Elimina un rastreador de metadatos especificado.
Entidades de metadatos	Entidades de metadatos
Entidades personalizadas	Entidades personalizadas
ListMetaEntities	Consulta de la lista de entidades de metadatos.	Consulta una lista de entidades de metadatos. Actualmente, solo se admiten tipos de entidad personalizados.
GetMetaEntity	GetMetaEntity.	Obtiene los detalles de la entidad de metadatos. Actualmente, solo se admiten los tipos de entidad puramente personalizados.
BatchCreateMetaEntities	Creación por lotes de entidades de metadatos.	Crea entidades de metadatos en lotes. Todas las entidades del mismo lote deben ser del mismo tipo. Actualmente, solo se admiten tipos de entidad personalizados y tipos de tabla de extensión (correspondientes a Base de datos/Tabla).
UpdateMetaEntity	UpdateMetaEntity.	Actualiza una entidad de metadatos. Puede actualizar entidades personalizadas u objetos del tipo de tabla extendida, como bases de datos, tablas y columnas.
BatchDeleteMetaEntities	Eliminación por lotes de entidades de metadatos.	Elimina objetos de entidad de metadatos en lotes. Admite la eliminación de entidades personalizadas y objetos de tipo tabla de extensión (Database/Table). No admite la eliminación de columnas de forma individual. Puede eliminar los objetos Column asociados al eliminar la Table.
Catálogos de datos	Catálogos de datos
ListCatalogs	Lista de catálogos de datos en Data Map.	Consulta una lista de catálogos en Data Map. Solo se admiten los catálogos de los tipos de rastreador de metadatos de Data Lake Formation (DLF) y StarRocks. Para el tipo de rastreador de metadatos DLF, se devuelven todos los catálogos de datos admitidos. Para el tipo de rastreador de metadatos StarRocks, se devuelven los catálogos de datos de una instancia específica.
GetCatalog	Obtención de detalles del catálogo de datos en Data Map.	Obtiene los detalles de un catálogo de datos especificado en Data Map de DataWorks. Actualmente, se admiten los tipos de catálogo DLF y StarRocks.
Bases de datos	Bases de datos
ListDatabases	Listar bases de datos en Data Map.	Consulta una lista de bases de datos en una instancia, un clúster o un catálogo de datos en Data Map. Para los orígenes de datos DLF o StarRocks, puede llamar a esta operación de API para consultar bases de datos en un catálogo de datos. Para los orígenes de datos StarRocks, puede llamar a esta operación de API para consultar bases de datos solo en el catálogo Internal. Para otros tipos de orígenes de datos, puede llamar a esta operación de API para consultar bases de datos en una instancia o un clúster.
GetDatabase	Detalles de una base de datos en Data Map.	Consulta la información sobre una base de datos específica en Data Map.
Esquemas	Esquemas
ListSchemas	Consulta de esquemas de base de datos en Data Map.	Consulta los esquemas de una base de datos o un proyecto de MaxCompute especificados en Data Map. Esta operación admite MaxCompute y Hologres.
GetSchema	Obtener información del esquema de base de datos en Data Map.	Obtiene los detalles de un esquema especificado en Data Map. Solo se admiten los esquemas de MaxCompute y Hologres.
Tablas de datos	Tablas de datos
ListTables	Consultar tablas de datos en data map.	Consulta la lista de tablas de datos en Data Map de DataWorks. Para los tipos que no admiten el nivel de esquema, puede consultar tablas de datos bajo una base de datos especificada. Para los tipos que admiten el nivel de esquema, puede consultar tablas de datos bajo una base de datos, un proyecto de MaxCompute o un esquema especificados. La respuesta contiene solo información básica de la tabla y no incluye metadatos técnicos ni metadatos empresariales.
GetTable	Obtener detalles de tabla de mapa de datos.	Obtiene los detalles de una tabla especificada en Data Map. Puede elegir si se devuelven los metadatos empresariales.
UpdateTableBusinessMetadata	Actualizar los metadatos de negocio de una tabla de Data Map.	Actualiza los metadatos de negocio de una tabla en Data Map. Actualmente, solo se pueden actualizar la descripción de uso de la tabla y los atributos personalizados.
SubmitBatchChangeTableOwner	Actualización por lotes del propietario de tabla.	Envía una solicitud por lotes para transferir la propiedad de tablas.
GetBatchChangeTableOwnerStatus	Obtener el estado de la transferencia por lotes de propietario de tabla.	Consulta el estado de una tarea de transferencia por lotes de propietario de tabla.
Campos	Campos
ListColumns	Consultar columnas de una tabla de mapa de datos.	Consulta la lista de columnas de una tabla especificada en Data Map de DataWorks.
GetColumn	Obtener información de columna de tabla de Data Map.	Obtiene los detalles de una columna especificada en una tabla de Data Map.
UpdateColumnBusinessMetadata	UpdateColumnBusinessMetadata.	Actualiza los metadatos de negocio de una columna en un mapa de datos. Esta operación solo puede actualizar la descripción de negocio y los atributos personalizados.
Conjuntos de datos	Conjuntos de datos
ListDatasets	Lista de conjuntos de datos.	Consulta una lista de conjuntos de datos. Actualmente, se admiten los conjuntos de datos de DataWorks y los conjuntos de datos de PAI.
GetDataset	GetDataset.	Obtiene los detalles de un conjunto de datos.
CreateDataset	Crear un conjunto de datos.	Crea un conjunto de datos. Solo puede crear un conjunto de datos en un espacio de trabajo al que se haya unido. Solo se admiten conjuntos de datos de DataWorks. El número máximo de conjuntos de datos por inquilino es 2000.
UpdateDataset	Actualizar un conjunto de datos.	Actualiza la información del conjunto de datos. Solo se admiten los conjuntos de datos de DataWorks. El operador debe ser el creador del conjunto de datos o el administrador del espacio de trabajo donde se encuentra el conjunto de datos.
DeleteDataset	Eliminar un conjunto de datos.	Elimina un conjunto de datos. Solo se admiten conjuntos de datos de DataWorks. Las versiones correspondientes del conjunto de datos se eliminan en cascada. El operador debe ser el creador del conjunto de datos o un administrador del espacio de trabajo al que pertenece el conjunto de datos.
Versiones de conjuntos de datos	Versiones de conjuntos de datos
ListDatasetVersions	ListDatasetVersions.	Obtiene la lista de versiones de un conjunto de datos determinado.
GetDatasetVersion	GetDatasetVersion.	Obtiene información de una versión de conjunto de datos específica.
CreateDatasetVersion	Crear una versión de conjunto de datos.	Crea una versión de conjunto de datos. Actualmente, solo se admiten conjuntos de datos de DataWorks. El número máximo de versiones es 20.
UpdateDatasetVersion	UpdateDatasetVersion.	Actualiza la información de la versión del conjunto de datos. Solo se admiten conjuntos de datos de DataWorks. Se requieren permisos de creador del conjunto de datos o de administrador del espacio de trabajo.
DeleteDatasetVersion	Eliminar una versión de conjunto de datos.	Elimina una versión de conjunto de datos. Solo se pueden eliminar versiones de conjuntos de datos de DataWorks que no sean v1 mediante esta operación. Para eliminar una versión de conjunto de datos v1, utilice la operación DeleteDataset. El operador debe ser el creador del conjunto de datos o un administrador del espacio de trabajo al que pertenece el conjunto de datos.
PreviewDatasetVersion	PreviewDatasetVersion.	Muestra una vista previa del contenido de una versión de conjunto de datos especificada. Actualmente, solo se admite la vista previa de archivos de texto para conjuntos de datos de tipo OSS. Tipos MIME admitidos: 1. application/json 2. application/xml 3. text/html 4. text/plain 5. application/octet-stream.
Particiones	Particiones
ListPartitions	Consultar particiones de una tabla de mapa de datos.	Consulta la lista de particiones de una tabla especificada en DataWorks Data Map. Actualmente admite los tipos MaxCompute y HMS (clúster EMR).
GetPartition	Obtener los detalles de la partición de una tabla en Data Map.	Obtiene los detalles de una partición de una tabla de Data Map. Actualmente solo admite los tipos MaxCompute y HMS (clúster de EMR).
Linaje	Linaje
ListLineageRelationships	Consulta de relaciones de linaje de datos en DataWorks Data Map	Consulta la lista de relaciones de linaje de datos entre dos entidades dadas (como tablas, campos o archivos de OSS) en DataWorks Data Map.
GetLineageRelationship	Obtener detalles de la relación de linaje de datos.	Obtiene los detalles de una relación de linaje especificada en DataWorks Data Map.
DeleteLineageRelationship	Eliminar una relación de linaje de datos.	Elimina una relación de linaje de datos especificada de Data Map de DataWorks.
CreateLineageRelationship	Registrar relación de linaje de datos en Data Map.	Registra una relación de linaje de datos en DataWorks Data Map. Esta operación permite establecer relaciones de linaje entre entidades de metadatos administradas por DataWorks, incluidos los escenarios de tabla a tabla, de columna a columna, de tabla a columna y de dataset a tabla. También permite establecer relaciones de linaje entre entidades administradas y objetos de entidades personalizadas registrados por los usuarios. Esta operación admite objetos personalizados no administrados, pero este enfoque ya no se recomienda. Antes de invocar esta operación, asegúrese de que las entidades administradas involucradas en el registro de linaje ya existan en la plataforma DataWorks.
ListLineages	Consulta de entidades de linaje en DataWorks Data Map	Consulta la lista de entidades de linaje ascendentes y descendentes para una entidad determinada en DataWorks Data Map, con la opción de incluir información específica de relaciones de linaje.
Colecciones de metadatos	Colecciones de metadatos
ListMetaCollections	Consultar lista de colecciones de Data Map.	Consulta la lista de colecciones de Data Map. Admite consultar tanto categorías de Data Map como álbumes de datos.
CreateMetaCollection	CreateMetaCollection.	Crea una colección en Data Map. Las colecciones incluyen categorías, subcategorías, álbumes de datos y categorías que se crean en los álbumes de datos.
GetMetaCollection	Obtener información de la colección de Data Map.	Consulta la información sobre una colección en Data Map. Las colecciones incluyen categorías y álbumes de datos.
UpdateMetaCollection	Actualizar objeto de colección del Mapa de datos.	Actualiza los objetos de colección del Mapa de datos, incluidas las categorías del Mapa de datos y los álbumes de datos. Puede actualizar el nombre de la colección, la descripción y la información del administrador. Al actualizar un álbum de datos, el llamador debe tener el permiso AliyunDataWorksFullAccess o ser el creador o un administrador del álbum.
DeleteMetaCollection	Eliminar un objeto de colección del Mapa de datos.	Elimina un objeto de colección en el Mapa de datos especificado, incluidas las categorías del Mapa de datos y los álbumes de datos. Al eliminar un álbum de datos, el solicitante debe tener el permiso AliyunDataWorksFullAccess o ser el creador o administrador del álbum.
ListEntitiesInMetaCollection	Lista de entidades en una colección de Data Map.	Consulta una lista de entidades en una colección de Data Map. Las colecciones incluyen categorías y álbumes de datos. Las entidades solo pueden ser tablas.
AddEntityIntoMetaCollection	Agregar un objeto de entidad a una colección de Data Map.	Agrega un objeto de entidad especificado a una colección de Data Map. El objeto de colección puede ser una categoría de Data Map o un álbum de datos. El objeto de entidad actualmente solo admite el tipo de tabla de datos. Para agregar una entidad a un álbum de datos, quien realiza la llamada debe tener el permiso AliyunDataWorksFullAccess, o ser el creador o administrador del álbum.
RemoveEntityFromMetaCollection	Eliminar un objeto de entidad de una colección de Data Map.	Elimina un objeto de entidad de una colección de Data Map. La colección admite categorías de Data Map y álbumes de datos, y la entidad actualmente solo admite el tipo Tabla de datos. Al eliminar una entidad de un álbum de datos, el llamador debe tener el permiso AliyunDataWorksFullAccess o ser el creador o administrador del álbum.

Centro de operaciones

API	Título	Descripción
Parámetros	Parámetros
CreateParameter	Crear un parámetro	Crea un parámetro.
DeleteParameter	Eliminar un parámetro.	Elimina un parámetro especificado.
UpdateParameter	Actualizar un parámetro.	Actualiza un parámetro. Esta operación actualiza de forma incremental y modifica solo los campos especificados.
RollbackParameter	Revertir un parámetro.	Revierte un parámetro especificado.
GetParameter	Obtener parámetro.	Obtiene los detalles de un parámetro mediante su ID.
ListParameters	Obtener lista de parámetros	Consulta la lista de parámetros de consulta.
ListParameterVersions	Lista de versiones de parámetros.	Enumera las versiones de parámetros.
Monitoreo y alertas	Monitoreo y alertas
ListAlertRules	ListAlertRules.	Consulta una lista de reglas de alerta de monitoreo personalizado.
GetAlertRule	Obtenga una regla de alerta de monitoreo personalizado.	Obtiene una regla de alerta de monitoreo personalizado.
UpdateAlertRule	UpdateAlertRule.	Actualiza la información de una regla de monitoreo de alertas personalizada.
DeleteAlertRule	Eliminar una regla personalizada.	Elimina una regla de alerta de monitoreo personalizado.
CreateAlertRule	Crear una regla de alerta de monitoreo personalizada.	Crea una regla de alerta de monitoreo personalizada.
Tareas	Tareas
GetUpdateTaskResult	Obtiene el resultado de una tarea de actualización de nodo.	Consulta el resultado de la creación asíncrona de una instancia de flujo de trabajo.
UpdateTaskAsync	Actualización asíncrona de un nodo.	Actualiza de forma asíncrona un nodo especificado y sincroniza los cambios con Data Studio como una nueva versión guardada.
DeleteTask	Eliminar tarea.	Elimina una tarea.
UpdateTask	Actualizar un nodo.	Actualiza un nodo especificado. Las modificaciones se sincronizan con Data Studio, donde se crea una nueva versión guardada.
BatchUpdateTasks	Actualización de nodos por lotes.	Actualiza múltiples nodos por lotes mediante actualizaciones incrementales.
GetTask	GetTask.	Consulta la información de una tarea.
ListTasks	ListTasks.	Consulta una lista de tareas por página. También puede especificar condiciones de filtro para consultar tareas.
ListUpstreamTasks	Lista de tareas ascendientes.	Consulta una lista paginada de tareas ascendientes de una tarea.
ListDownstreamTasks	ListDownstreamTasks.	Consulta una lista paginada de tareas descendientes de una tarea.
ListTaskOperationLogs	Obtenga los registros de operaciones de una tarea	Consulta una lista paginada de registros de operaciones para una tarea especificada.
Instancias de tareas	Instancias de tareas
UpdateTaskInstances	Modificar propiedades de instancias de tarea.	Modifica por lotes las propiedades de varias instancias de tarea, como la prioridad, el grupo de recursos, el origen de datos, entre otras.
GetTaskInstance	Detalles de la instancia de tarea	Obtiene los detalles de una instancia de tarea especificada.
GetTaskInstanceLog	GetTaskInstanceLog.	Consulta el registro de ejecución generado durante una ejecución específica de una instancia.
ListTaskInstances	Lista de instancias de tarea	Obtiene una lista paginada de instancias de tarea. También puede realizar una consulta filtrada según condiciones.
ListUpstreamTaskInstances	Lista de instancias ascendentes.	Obtiene de forma paginada las instancias ascendentes de una instancia especificada.
ListTaskInstanceOperationLogs	Lista de registros de operaciones de instancia de tarea.	Obtiene una lista paginada de registros de operaciones de una instancia de tarea.
ListDownstreamTaskInstances	Lista de instancias descendentes.	Obtiene una lista paginada de las instancias descendentes de una instancia especificada.
SuspendTaskInstances	Suspender instancias de tarea.	Suspende varias instancias a la vez.
ResumeTaskInstances	ResumeTaskInstances.	Reanuda varias instancias suspendidas a la vez.
StopTaskInstances	Detener instancias de nodo	Detiene varias instancias de nodo.
SetSuccessTaskInstances	Establecer instancias de tarea como exitosas.	Establece los estados de varias instancias como exitosos a la vez.
RerunTaskInstances	Volver a ejecutar instancias de nodo.	Vuelve a ejecutar varias instancias de nodo en lote.
RemoveTaskInstanceDependencies	RemoveTaskInstanceDependencies.	Elimina varias dependencias ascendentes de una instancia a la vez.
TriggerSchedulerTaskInstance	Desencadenar una instancia de tarea programada.	Desencadena la ejecución de una tarea en un momento especificado mediante un nodo de activador HTTP.
Flujos de trabajo	Flujos de trabajo
DeleteWorkflow	Eliminar un flujo de trabajo.	Elimina un flujo de trabajo especificado.
Instancias de flujos de trabajo	Instancias de flujos de trabajo
GetRerunWorkflowInstancesResult	Obtención del resultado de una nueva ejecución de instancia de flujo de trabajo.	Consulta el resultado de una nueva ejecución asíncrona de una instancia de flujo de trabajo.
RerunWorkflowInstances	Reejecución de una instancia de flujo de trabajo	Reejecuta una instancia de flujo de trabajo.
CreateWorkflowInstances	Crear una instancia de flujo de trabajo	Crea una instancia de flujo de trabajo basada en las configuraciones especificadas, como una instancia de flujo de trabajo de relleno de datos.
GetCreateWorkflowInstancesResult	Obtener los resultados de la creación asíncrona de instancias de flujo de trabajo.	Consulta el resultado de la creación asíncrona de instancias de flujo de trabajo.
GetWorkflowInstance	GetWorkflowInstance.	Consulta la información de una instancia de flujo de trabajo.
ListWorkflowInstances	Lista de instancias de flujo de trabajo	Obtiene una lista de instancias de flujo de trabajo mediante paginación. También puede filtrar la consulta según condiciones.
StartWorkflowInstances	Iniciar instancias de flujo de trabajo.	Inicia varias instancias de flujo de trabajo en lote.
StopWorkflowInstances	Finalizar instancias de flujo de trabajo	Finaliza varias instancias de flujo de trabajo por lotes.
ExecuteAdhocWorkflowInstance	Ejecutar una instancia de flujo de trabajo temporal	Crea una instancia de flujo de trabajo temporal basada en las configuraciones especificadas.

Calidad de datos

API	Título	Descripción
Plantillas de reglas de calidad de datos	Plantillas de reglas de calidad de datos
CreateDataQualityTemplate	Crear una plantilla de reglas de calidad de datos.	Crea una plantilla de reglas de calidad de datos en un proyecto especificado.
UpdateDataQualityTemplate	Actualizar una plantilla de reglas de calidad de datos.	Actualiza una plantilla de reglas de calidad de datos en un proyecto.
ListDataQualityTemplates	Listar plantillas de reglas de calidad de datos.	Consulta la lista de plantillas de reglas de calidad de datos en un proyecto especificado.
GetDataQualityTemplate	GetDataQualityTemplate.	Obtiene los detalles de una plantilla de reglas de calidad de datos mediante el ID de la plantilla.
DeleteDataQualityTemplate	DeleteDataQualityTemplate.	Elimina una plantilla de reglas de calidad de datos por ID.
Monitoreo de calidad de datos	Monitoreo de calidad de datos
CreateDataQualityScan	CreateDataQualityScan.	Crea un monitor de calidad de datos.
UpdateDataQualityScan	Actualizar un monitor de calidad de datos.	Actualiza un monitor de calidad de datos.
ListDataQualityScans	Lista de tareas de escaneo de calidad de datos.	Consulta la lista de tareas de escaneo de calidad de datos en un proyecto.
GetDataQualityScan	GetDataQualityScan.	Obtiene los detalles del monitoreo de calidad de datos.
DeleteDataQualityScan	DeleteDataQualityScan.	Elimina un monitor de calidad de datos.
Reglas de alerta	Reglas de alerta
CreateDataQualityAlertRule	Crear una regla de alerta de calidad de datos	Crea una regla de alerta de monitoreo de calidad de datos en un proyecto especificado.
UpdateDataQualityAlertRule	Actualización de una regla de alerta de calidad de datos	Actualiza una regla de alerta de monitoreo de calidad de datos especificada.
ListDataQualityAlertRules	Lista de reglas de alerta de calidad de datos.	Consulta la lista de reglas de alerta de calidad de datos en un proyecto.
GetDataQualityAlertRule	GetDataQualityAlertRule.	Obtiene los detalles de una regla de alerta de calidad de datos mediante el ID de la regla.
DeleteDataQualityAlertRule	Eliminar una regla de alerta de calidad de datos.	Elimina una regla de alerta de monitoreo de calidad de datos según el ID especificado.
Ejecuciones de calidad de datos	Ejecuciones de calidad de datos
CreateDataQualityScanRun	Crear una ejecución de escaneo de calidad de datos.	Desencadena la ejecución de una tarea de monitoreo de calidad de datos especificada y devuelve el ID de la instancia de ejecución.
ListDataQualityScanRuns	Consulta de registros de ejecución de escaneo de calidad de datos	Consulta los registros de ejecución de escaneo de calidad de datos de un proyecto especificado.
GetDataQualityScanRunLog	Obtener registros de la ejecución del análisis de calidad de datos.	Consulta el contenido de los registros de una instancia de tarea de monitoreo de calidad de datos especificada.
GetDataQualityScanRun	GetDataQualityScanRun.	Consulta los detalles de la ejecución de una tarea de escaneo de calidad de datos mediante su ID.

Centro de seguridad

API	Título	Descripción
Solicitud y aprobación de permisos	Solicitud y aprobación de permisos
ApplyResourceAccessPermission	Enviar una solicitud de permisos de acceso a recursos.	Envía una solicitud de permisos de acceso para recursos específicos.
StopProcessInstance	StopProcessInstance.	Retira o termina una instancia de proceso especificada.
ApproveProcessInstance	Aprobar una instancia de flujo de trabajo.	Aprueba o rechaza una instancia de proceso de aprobación especificada.
GetApplicationContents	Obtener detalles de la solicitud de permisos de recursos.	Consulta el contenido de las solicitudes de permisos de recursos bajo el ID de instancia de proceso especificado.
GetProcessInstance	GetProcessInstance.	Obtiene los detalles de una instancia de proceso de aprobación especificada, incluidos sus nodos de aprobación y la lista de tareas.
ListPendingApprovals	Consulta de órdenes de solicitud de permisos pendientes.	Obtiene la lista de órdenes de solicitud de permisos pendientes en las que el usuario actual es el aprobador.
ListMyRelatedApprovals	Consultar órdenes de solicitud de permisos relacionadas conmigo.	Consulta todas las órdenes de solicitud de permisos en las que el usuario actual es aprobador o parte interesada.
ListMyApplications	Consultar órdenes de solicitud de permisos iniciadas por mí.	Consulta todas las órdenes de solicitud de permisos de acceso a recursos iniciadas por el usuario actual.
Políticas de control de resultados de consultas	Políticas de control de resultados de consultas
CreateSecurityStrategy	Crear una política de seguridad	Crea una nueva política de control de seguridad y admite la configuración de varios módulos y submódulos. Requiere los permisos de administrador de inquilino de DataWorks y de administrador de seguridad.
DeleteSecurityStrategy	Eliminar una política de seguridad.	Elimina una política de seguridad mediante su ID. Para llamar a esta operación, debe tener permisos de administrador de inquilino de DataWorks y de administrador de seguridad.
UpdateSecurityStrategy	UpdateSecurityStrategy.	Modifica la configuración de una política de seguridad existente. Requiere ser tanto administrador del inquilino de DataWorks como administrador de seguridad.
GetSecurityStrategy	GetSecurityStrategy.	Obtiene los detalles de una política de seguridad mediante su ID. Esta operación requiere permisos de administrador de inquilino y de administrador de seguridad de DataWorks.
ListSecurityStrategies	ListSecurityStrategies.	Obtiene una lista paginada de políticas de seguridad según las condiciones especificadas. Esta operación requiere permisos de administrador de inquilino o administrador de seguridad de DataWorks.
FindBestMatchSecurityStrategy	Coincidencia de la mejor política de seguridad.	Busca la política de seguridad que mejor se ajusta a las condiciones especificadas.
Políticas de aprobación	Políticas de aprobación
CreateProcessDefinition	Crear una definición de proceso de aprobación.	Crea una nueva definición de proceso de aprobación y admite la configuración personalizada de reglas de aprobación y servicios de notificación.
DeleteProcessDefinition	DeleteProcessDefinition.	Elimina una definición de proceso mediante el ID especificado.
EnableProcessDefinition	EnableProcessDefinition.	Habilita una definición de proceso con el ID especificado.
DisableProcessDefinition	DisableProcessDefinition.	Deshabilita la definición del proceso de aprobación especificado.
UpdateProcessDefinition	Actualización de la definición de proceso de aprobación.	Actualiza una definición de proceso de aprobación existente.
GetProcessDefinition	GetProcessDefinition.	Obtiene la política de aprobación para un ID de definición de proceso determinado.
ListProcessDefinitions	ListProcessDefinitions.	Consulta las definiciones de proceso de un tipo especificado.
CreateIdentifyCredential	Crear una credencial de identidad.	Crea una credencial de identidad.

Gestión de etiquetas

API	Título	Descripción
CreateDataAssetTag	Crear una etiqueta	Crea una etiqueta.
DeleteDataAssetTag	DeleteDataAssetTag.	Elimina una etiqueta.
UpdateDataAssetTag	Actualizar una etiqueta.	Actualiza una etiqueta.
ListDataAssetTags	Lista de etiquetas	Consulta una lista de etiquetas.
TagDataAssets	Adjuntar etiquetas de activos de datos	Adjunta etiquetas a los activos de datos.
UnTagDataAssets	Desasociar etiquetas de activos de datos	Desasocia etiquetas de los activos de datos.
ListDataAssets	Lista de activos asociados con etiquetas	Realiza una consulta paginada de los activos de datos de DataWorks asociados con etiquetas.

Plataforma abierta

API	Título	Descripción
GetJobStatus	Obtener el estado de ejecución de la API asíncrona.	Devuelve el estado de una tarea asíncrona. Después de llamar a una API asíncrona, consulte esta API de forma periódica para obtener el estado de éxito.

Otros

API	Título	Descripción
ListDataQualityEvaluationTasks	Lista de tareas de monitoreo de calidad.	Consulta una lista paginada de tareas de monitoreo de calidad.
ListDataQualityRules	Listar reglas de calidad.	Consulta las reglas de monitoreo de calidad mediante paginación.
ListDataQualityEvaluationTaskInstances	Consulta la lista de instancias de tareas de monitoreo de calidad.	Realiza una consulta paginada de la lista de instancias de tareas de monitoreo de calidad.
ListDataQualityResults	Consultar resultados de calidad de datos.	Consulta una lista de resultados de calidad de datos mediante paginación.
DetachDataQualityRulesFromEvaluationTask	Eliminar la asociación entre una regla de calidad de datos y una tarea de monitoreo.	Elimina la asociación entre una regla de calidad de datos y una tarea de monitoreo de calidad de datos.
DeleteDataQualityEvaluationTask	Eliminar un monitor de calidad de datos.	Elimina una tarea de monitoreo de calidad de datos.
GetDataQualityEvaluationTaskInstance	Obtener detalles de la instancia de tarea de verificación de calidad de datos.	Obtiene los detalles de una instancia de tarea de verificación de calidad de datos.
GetDataQualityEvaluationTask	Consulta de detalles de monitoreo de calidad de datos.	Consulta los detalles de una tarea de validación de calidad de datos.
AttachDataQualityRulesToEvaluationTask	Asociar reglas de calidad de datos con el monitoreo de calidad.	Asocia reglas de calidad de datos con una tarea de verificación de calidad de datos.
UpdateDataQualityEvaluationTask	Actualizar el monitoreo de calidad de datos	Actualiza una tarea de verificación de calidad de datos.
CreateDataQualityEvaluationTaskInstance	Crear una instancia de monitoreo de verificación de calidad de datos.	Crea una instancia de tarea de verificación de calidad de datos.
CreateDataQualityEvaluationTask	Crear monitoreo de calidad de datos	Crea una tarea de monitoreo de calidad de datos de DataWorks.
DeleteDataQualityRule	DeleteDataQualityRule.	Elimina una regla de monitoreo de calidad de datos.
UpdateDataQualityRuleTemplate	Actualiza una plantilla de reglas de calidad de datos.	Actualiza una plantilla de reglas de calidad de datos.
CreateDataQualityRuleTemplate	Crear una plantilla de regla de calidad.	Crea una plantilla de regla.
DeleteDataQualityRuleTemplate	Eliminar una plantilla personalizada de reglas de calidad de datos.	Elimina una plantilla personalizada de reglas de calidad de datos.
GetDataQualityRuleTemplate	Consulta los detalles de una plantilla de reglas de calidad de datos.	Consulta los detalles de una plantilla de reglas de calidad de datos.
CreateDataQualityRule	Crear una regla de calidad	Crea una regla de calidad.
UpdateDataQualityRule	Actualización de una regla de calidad	Actualiza una regla de calidad.
GetDataQualityRule	Consulta de detalles de reglas de calidad de datos.	Consulta los detalles de una regla de calidad de datos.
ListDataQualityRuleTemplates	Listar plantillas de reglas de calidad de datos.	Consulta una lista de plantillas de reglas de calidad de datos.
DeleteCertificate	Eliminar un archivo de certificado.	Elimina un archivo de certificado.
GetCertificate	Ver un archivo de certificado	Obtiene un archivo de certificado.
GetDataSource	Ver detalles del origen de datos.	Consulta un origen de datos especificado por su ID de origen de datos.
ImportCertificate	Importar un archivo de autenticación.	Importa un archivo de certificado.
ListCertificates	ListCertificates.	Obtiene una lista de archivos de certificado.
DeleteFile	Eliminar un archivo de Data Studio.	Elimina un archivo de Data Studio. Si el archivo se ha enviado, se activa un proceso asíncrono para eliminar el archivo en el sistema de programación. El valor del parámetro DeploymentId devuelto se usa para llamar a la operación GetDeployment y consultar el estado del proceso asíncrono periódicamente.
GetWorkflow	GetWorkflow.	Consulta la información de un flujo de trabajo.
ListWorkflows	Lista de flujos de trabajo	Obtiene una lista de flujos de trabajo con paginación y admite consultas filtradas por condiciones.
UpdateWorkflow	Actualizar un flujo de trabajo.	Actualiza un flujo de trabajo especificado mediante el método de actualización completa. Los campos que se pueden actualizar de forma síncrona en Data Studio incluyen: propietario, origen de datos, grupo de recursos de programación, descripción y modo de ejecución del disparador (Normal, Skip o Pause).
AbolishCrossProjectPipelineRun	Detener un flujo de publicación entre espacios de trabajo.	Detiene un flujo de publicación entre espacios de trabajo.
CreateCrossProjectPipelineRun	Crear un flujo de despliegue entre espacios de trabajo.	Crea un flujo de despliegue entre espacios de trabajo.
ExecCrossProjectPipelineRun	Ejecuta un flujo de despliegue entre espacios de trabajo.	Ejecuta un flujo de despliegue entre espacios de trabajo.
GetCrossProjectPipelineRun	Consulta de detalles del flujo de despliegue entre espacios de trabajo.	Consulta los detalles de un flujo de despliegue entre espacios de trabajo.
ListCrossProjectDeploymentCandidates	Consulta los objetos candidatos de despliegue entre espacios de trabajo.	Consulta los objetos candidatos de despliegue entre espacios de trabajo.
ListCrossProjectDeploymentEnvironments	Consulta los entornos de despliegue entre espacios de trabajo.	Consulta los entornos de despliegue entre espacios de trabajo.
ListCrossProjectPipelineRunItems	Consulta de elementos del pipeline de publicación entre espacios de trabajo.	Consulta los elementos de publicación de un pipeline de publicación entre espacios de trabajo.
ListCrossProjectPipelineRuns	Consulta de pipelines de publicación entre espacios de trabajo.	Consulta la lista de flujos de publicación entre espacios de trabajo.