Todos los productos
Search
Centro de documentos

DataWorks:Uso de OpenAPI

Última actualización: Sep 04, 2026

Este tema ofrece una descripción general de DataWorks OpenAPI, que incluye información básica, límites de uso, facturación y cómo llamar a estas API.

Información básica

Versión

Portal de OpenAPI

API compatibles

Regiones compatibles

2024-05-18 (versión nueva)

OpenAPI portal

List of supported APIs

China (Hangzhou), China (Shanghai), China (Shenzhen), China (Beijing), China (Zhangjiakou), China North 2 Ali Gov 1, China East 2 Finance, China (Chengdu), China (Hong Kong), Singapore, Indonesia (Jakarta), US (Silicon Valley), US (Virginia), Germany (Frankfurt), UK (London), Japan (Tokyo) y Malaysia (Kuala Lumpur)

Importante

Notas sobre las API relacionadas con Data Studio:

  • Si Use the New Data Studio, utilice la versión 2024-05-18 de OpenAPI.

  • Si no utiliza Use the New Data Studio, emplee la versión 2020-05-18 de OpenAPI.

Compruebe si está utilizando el nuevo Data Studio y seleccione la versión correspondiente de OpenAPI. Seleccionar una versión incorrecta puede provocar errores en las consultas o devolver resultados inesperados.

2020-05-18 (versión anterior)

OpenAPI portal

List of supported APIs

Límites

  • Los requisitos de edición para la OpenAPI de un módulo coinciden con los del propio módulo.

  • Para regular las llamadas a DataWorks OpenAPI y garantizar la estabilidad del sistema, las API se clasifican en lectura y escritura. Las distintas ediciones de DataWorks tienen límites específicos de QPS (consultas por segundo). La Basic Edition también cuenta con un límite diario de llamadas, mientras que la Standard Edition, Professional Edition y Enterprise Edition no lo tienen. Cada edición dispone además de una cuota mensual gratuita de llamadas y reglas pay-as-you-go para las llamadas que superen dicha cuota. A continuación se resumen estos detalles.

    Versión

    Límite de QPS

    Límite diario de llamadas

    Cuota mensual gratuita de llamadas

    Tarifa pay-as-you-go tras superar la cuota gratuita

    Basic Edition

    QPS total de todas las API ≤ 5

    Total de llamadas diarias a API ≤ 100

    3,100 llamadas/mes

    Se aplican límites de llamadas. No se admite facturación adicional pay-as-you-go.

    Standard Edition

    Sin límite diario de llamadas

    100,000 llamadas/mes

    USD 0.05 per 10,000 calls

    Professional Edition

    Sin límite diario de llamadas

    500,000 llamadas/mes

    USD 0.05 per 10,000 calls

    Enterprise Edition

    • QPS total de API de lectura ≤ 50

    • QPS total de API de escritura ≤ 20

    Sin límite diario de llamadas

    1,000,000 llamadas/mes

    USD 0.05 per 10,000 calls

    Las tareas de programación subyacentes de DataWorks no se ejecutan mediante operaciones de OpenAPI. Agotar la cuota de llamadas de OpenAPI no afecta la ejecución normal de las tareas de programación horaria ni las tareas por lotes. Solo pueden verse afectadas las tareas que invoquen operaciones de OpenAPI por sí mismas, como los nodos Python o PyODPS. Las instancias programadas en el entorno de producción se generan con antelación y no están sujetas a la cuota de llamadas de API.

    Importante
    • El QPS de API y los recuentos de llamadas se calculan como el valor acumulado de cada cuenta de Alibaba Cloud (incluidos los usuarios RAM) en cada región.

    • Si se supera el límite de QPS o el límite diario de llamadas de la Basic Edition, las llamadas fallarán. Controle la concurrencia y la frecuencia de sus llamadas en consecuencia.

    • En la Basic Edition, tanto las llamadas exitosas como las fallidas cuentan para el límite diario. La Standard Edition, Professional Edition y Enterprise Edition no tienen límite diario de llamadas, y las llamadas fallidas no se contabilizan en dicho límite. Preste atención a la cuota mensual gratuita y a las reglas de facturación pay-as-you-go.

    • Determine el tipo de lectura/escritura de cada API según su nombre. Por ejemplo, CreateFile es una API de escritura y ListFiles es una API de lectura.

Requisito previo

Antes de llamar a OpenAPI, asegúrese de que el permiso AliyunDataWorksFullAccess esté habilitado. De lo contrario, las llamadas a OpenAPI podrían fallar debido a permisos insuficientes. Para obtener más información, consulte Grant the AliyunDataWorksFullAccess permission.

Cuota gratuita y facturación

La cuota mensual gratuita de llamadas, el precio unitario pay-as-you-go tras superar la cuota, los límites de QPS y los límites diarios de llamadas para cada edición se resumen en la tabla de la sección Limitations anterior. A continuación se proporcionan detalles adicionales sobre las métricas de facturación y consideraciones importantes.

Importante
  • Cada mes natural se otorga una cuota gratuita de llamadas a OpenAPI a cada cuenta de Alibaba Cloud (incluidos los usuarios RAM) en cada región. La cuota mensual gratuita varía según la edición de DataWorks.

  • La Basic Edition está sujeta tanto al límite diario de llamadas como a la cuota mensual gratuita (para más detalles, consulte Limitations arriba). Las llamadas se rechazan una vez superado el límite y no se admite la facturación pay-as-you-go. La Standard Edition y la Professional Edition no tienen límite diario de llamadas y cada una cuenta con una cuota mensual gratuita (consulte la tabla en la sección Límites anterior). Se admite la facturación pay-as-you-go tras superar la cuota gratuita. Para precios unitarios y diferencias específicas del entorno, consulte OpenAPI billing in Resource costs. La Enterprise Edition no tiene límite diario de llamadas y se aplican las mismas reglas de facturación pay-as-you-go una vez agotada la cuota gratuita.

  • La Standard Edition, Professional Edition y Enterprise Edition de DataWorks permiten continuar realizando llamadas a API a precios pay-as-you-go después de agotar la cuota mensual gratuita. Los sitios internacionales utilizan el precio unitario y la facturación indicados en la documentación. Para obtener más información, consulte Resource costs. El precio real de facturación está sujeto al monto mostrado en su factura final.

Cómo llamar a OpenAPI

Nota

Para obtener más información sobre Alibaba Cloud OpenAPI, consulte Alibaba Cloud OpenAPI.

Métodos de llamada

Método de llamada

Estado de compatibilidad

Descripción

SDK (recomendado)

Compatible

Para conocer los lenguajes admitidos por el SDK de DataWorks y los métodos de instalación de dependencias, consulte DataWorks SDK.

Native HTTP call

Compatible

Las llamadas HTTP nativas requieren que implemente el algoritmo de firma y construya solicitudes personalizadas para iniciar dichas llamadas. Para obtener más información sobre el mecanismo de firma, consulte Signature mechanism.

Ejemplos de llamada

Estilo de API

Estilo RPC.

Endpoints

Seleccione el endpoint correspondiente a la región where reside su espacio de trabajo de DataWorks para lograr la menor latencia posible. Por ejemplo, el endpoint VPC para China (Zhangjiakou) es dataworks-vpc.cn-zhangjiakou.aliyuncs.com. Para obtener más información, consulte Endpoints (2024-05-18) y Endpoints (2020-05-18).

Consulta del uso de OpenAPI

Utilice Open Platform para consultar su uso de OpenAPI, incluido el consumo de la cuota gratuita, los recuentos de llamadas y los detalles de las mismas. Para obtener más información, consulte View OpenAPI usage.