Todos los productos
Search
Centro de documentos

:Apéndice: biblioteca de código de ejemplo de DataWorks Open Platform

Última actualización: Sep 28, 2026

DataWorks Open Platform proporciona código de ejemplo para los escenarios de aplicación relacionados. Este material le ayuda a comprender y utilizar mejor las diversas funciones de Open Platform, como OpenAPI, OpenEvent y Extensions. En este tema se describe cómo ejecutar en su computadora local el código de ejemplo obtenido de GitHub para demostrar las capacidades de apertura de DataWorks en distintos escenarios de negocio.

Contexto

DataWorks Open Platform incluye los módulos OpenAPI, OpenEvent y Extensions. Con ellos es posible integrar DataWorks en sus aplicaciones y suscribirse a mensajes de eventos. Estos módulos permiten conectar diversos sistemas de aplicaciones con DataWorks para controlar procesos de datos, gobernar la información y gestionar las operaciones y el mantenimiento (O&M). También facilitan responder con rapidez a los cambios de estado de negocio en dichos sistemas. Para obtener más información sobre Open Platform, consulte Descripción general.

Inicialización del proyecto

Paso 1: preparar el entorno de desarrollo

  1. Instale Java Development Kit (JDK).

    Para instalar JDK, acceda al sitio web oficial de Oracle y descargue la versión compatible con su sistema operativo.

    Nota

    En este ejemplo, la versión de JDK debe ser Java 1.8 o posterior. Una vez finalizada la instalación, abra el símbolo del sistema o una terminal y ejecute el comando java -version para comprobar la versión de Java.

  2. Instale Maven.

    Maven es una herramienta del entorno de ejecución de Java. Visite el sitio web oficial de Maven y descargue el paquete compatible con su sistema operativo. Cuando termine la descarga, consulte Installing Apache Maven para descomprimir el paquete e instalar Maven.

  3. Instale Node.js.

    Este ejemplo utiliza una página de frontend, por lo que debe instalar el entorno de Node.js en el cliente para ejecutar código JavaScript. Para instalarlo, vaya al sitio web oficial de Node.js y descargue el entorno.

    Nota

    En este ejemplo, la versión de Node.js debe ser posterior a la 14. Tras completar la instalación, abra el símbolo del sistema o una terminal y ejecute el comando node --version para comprobar la versión instalada.

  4. Instale pnpm.

    pnpm es una herramienta de gestión de paquetes para proyectos de JavaScript. La biblioteca de código de ejemplo de este tema emplea el modo workspace para evitar que los componentes comunes se envíen a npm; por ello, es obligatorio instalar pnpm. Haga clic en Installation para instalar la herramienta. Si ya cuenta con Node.js, ejecute el siguiente comando:

    npm install -g pnpm
  5. Compruebe el entorno de desarrollo.

    Una vez completados los pasos anteriores, ejecute los siguientes comandos para verificar que el entorno requerido esté instalado:

    java -version // If JDK is installed, the command output shows the JDK version. Otherwise, the "command not found" error is reported. 
    mvn -v // If Maven is installed, the command output shows the Maven version. Otherwise, the "command not found" error is reported. 
    npm -v // If Node.js is installed, the command output shows the Node.js version. Otherwise, the "command not found" error is reported. 
    pnpm -v // If pnpm is installed, the command output shows the pnpm version. Otherwise, the "command not found" error is reported.

Paso 2: ejecutar el código de ejemplo

  1. Instale las dependencias.

    Cuando el entorno de desarrollo esté listo, descargue el proyecto de ejemplo en su computadora local y ejecute el siguiente código para instalar las dependencias:

    pnpm install
  2. Introduzca su AccessKey ID y su AccessKey secret.

    Al terminar la instalación, busque el archivo de configuración application.properties en el directorio raíz. En dicho archivo, especifique la información clave como Access Key (AK), Secret Key (SK), Region-id y endpoint. El proyecto leerá estos datos y los sincronizará con cada aplicación de ejemplo durante el inicio.

    Nota

    Durante la ejecución del proyecto, la información clave especificada en el archivo de configuración se utiliza para conectarse a los módulos de DataWorks Open Platform.

    ## The AccessKey ID of a RAM user.
    api.access-key-id={access-key}
    
    ## The AccessKey secret of a RAM user.
    api.access-key-secret={secret-key}
    
    ## The ID of the region where the DataWorks service is deployed. Sample values: cn-shanghai and cn-hangzhou.
    # api.region-id=cn-hangzhou
    api.region-id={regionId}
    
    ## The service of DataWorks API operations. The default value is dataworks-public.
    api.product=dataworks-public
    
    ## The endpoint of DataWorks OpenAPI.
    ## If DataWorks OpenAPI is accessed over the Internet, the endpoint is in the format of dataworks.${regionId}.aliyuncs.com. By default, DataWorks OpenAPI is accessed over the Internet.
    ## If DataWorks OpenAPI is accessed over a virtual private cloud (VPC), the endpoint is in the format of dataworks-vpc.${regionId}.aliyuncs.com.
    # api.endpoint=dataworks.cn-hangzhou.aliyuncs.com
    api.endpoint={endpoint}
    
    ## Specify the network environment. For access over the Internet, set the parameter to false. For access over a VPC, set the parameter to true.
    api.vpc-env=false
  3. Ejecute el código de ejemplo.

    Después de aplicar las configuraciones anteriores, ejecute los siguientes comandos para iniciar el código de ejemplo.

    npm run example:workbench-screen // Execute the sample code for Operation Center.
    npm run example:meta-api // Execute the sample code for metadata.
    npm run example:event-instance-status // Execute the sample code for subscribing to the status change events of an auto triggered node instance.
    npm run example:extension-maxpt // Execute the sample code for prohibiting the use of the MAX_PT function.
    npm run example:extension-deploy-control // Execute the sample code for configuring the settings in DataWorks Open Platform to perform a lockdown.
  4. Consulte el resultado de la ejecución.

    Una vez ejecutado el código, revise los resultados en un navegador web.

    • Si el ejemplo incluye una página de frontend interactiva, acceda a ella mediante la siguiente URL:

      https://localhost:8080
    • Si el ejemplo funciona únicamente en el backend, acceda a este mediante la siguiente URL:

      http://localhost:8008

Obtención del código de ejemplo para un escenario de aplicación

A continuación se muestran los escenarios cuyo código de ejemplo puede obtener desde la biblioteca de código de ejemplo de Open Platform: