Tous les produits
Search
Centre de documentation

DataWorks:Utiliser l'OpenAPI

Dernière mise à jour :Aug 26, 2026

Cette rubrique présente une vue d'ensemble de l'OpenAPI DataWorks, incluant les informations de base, les limitations d'utilisation, la facturation et les méthodes d'appel.

Informations de base

Version

Portail OpenAPI

API prises en charge

Régions prises en charge

2024-05-18 (nouvelle version)

Portail OpenAPI

Liste des API prises en charge

Chine (Hangzhou), Chine (Shanghai), Chine (Shenzhen), Chine (Pékin), Chine (Zhangjiakou), Chine du Nord 2 Ali Gov 1, Chine de l'Est 2 Finance, Chine (Chengdu), Chine (Hong Kong), Singapour, Indonésie (Jakarta), États-Unis (Silicon Valley), États-Unis (Virginie), Allemagne (Francfort), Royaume-Uni (Londres), Japon (Tokyo) et Malaisie (Kuala Lumpur)

Important

Remarques concernant les API liées à Data Studio :

  • Si vous Use the New Data Studio, utilisez la version 2024-05-18 de l'OpenAPI.

  • Si vous n'utilisez pas Use the New Data Studio, utilisez la version 2020-05-18 de l'OpenAPI.

Vérifiez si vous utilisez le nouveau Data Studio et sélectionnez la version correspondante de l'OpenAPI. Le choix d'une version incorrecte peut entraîner des échecs de requête ou retourner des résultats inattendus.

2020-05-18 (version héritée)

Portail OpenAPI

Liste des API prises en charge

Limitations

  • Les exigences d'édition pour l'OpenAPI d'un module correspondent à celles du module lui-même.

  • Pour réguler les appels à l'OpenAPI DataWorks et garantir la stabilité du système, les API sont classées en lecture ou en écriture. Chaque édition de DataWorks impose des limites spécifiques de QPS (requêtes par seconde). L'édition Basic comporte également une limite d'appels quotidienne, contrairement aux éditions Standard, Professional et Enterprise. Chaque édition dispose d'un quota mensuel d'appels gratuits et de règles de facturation au paiement à l'utilisation pour les appels dépassant ce quota. Le tableau suivant résume ces détails.

    Version

    Limite QPS

    Limite d'appels quotidienne

    Quota mensuel d'appels gratuits

    Facturation au paiement à l'utilisation après dépassement du quota gratuit

    Édition Basic

    QPS total de toutes les API ≤ 5

    Total des appels API quotidiens ≤ 100

    3 100 appels/mois

    Des limites d'appel s'appliquent. La facturation supplémentaire au paiement à l'utilisation n'est pas prise en charge.

    Édition Standard

    Aucune limite d'appels quotidienne

    100 000 appels/mois

    0,05 USD pour 10 000 appels

    Édition Professional

    Aucune limite d'appels quotidienne

    500 000 appels/mois

    0,05 USD pour 10 000 appels

    Édition Enterprise

    • QPS total des API en lecture ≤ 50

    • QPS total des API en écriture ≤ 20

    Aucune limite d'appels quotidienne

    1 000 000 appels/mois

    0,05 USD pour 10 000 appels

    Les tâches de planification sous-jacentes de DataWorks ne s'exécutent pas via des opérations OpenAPI. L'épuisement du quota d'appels OpenAPI n'affecte pas l'exécution normale des tâches de planification planifiée ni des tâches par lots. Seules les tâches qui appellent elles-mêmes des opérations OpenAPI, telles que les nœuds Python ou PyODPS, peuvent être impactées. Les instances planifiées dans l'environnement de production sont générées à l'avance et ne sont pas soumises au quota d'appels API.

    Important
    • Le QPS des API et le nombre d'appels correspondent à la valeur cumulative de chaque compte Alibaba Cloud (y compris les utilisateurs RAM) dans chaque région.

    • Si la limite QPS est dépassée ou si la limite d'appels quotidienne de l'édition Basic est atteinte, les appels échouent. Contrôlez en conséquence la simultanéité et la fréquence de vos appels.

    • Pour l'édition Basic, les appels API réussis et échoués comptent tous deux dans la limite d'appels quotidienne. Les éditions Standard, Professional et Enterprise n'imposent aucune limite d'appels quotidienne et les appels échoués ne sont pas comptabilisés dans cette limite. Soyez attentif au quota mensuel d'appels gratuits et aux règles de facturation au paiement à l'utilisation.

    • Déterminez le type lecture/écriture de chaque API en fonction de son nom. Par exemple, CreateFile est une API en écriture, tandis que ListFiles est une API en lecture.

Prérequis

Avant d'appeler l'OpenAPI, assurez-vous que l'autorisation AliyunDataWorksFullAccess est activée. Dans le cas contraire, les appels OpenAPI risquent d'échouer en raison d'autorisations insuffisantes. Pour plus d'informations, consultez la section Accorder l'autorisation AliyunDataWorksFullAccess.

Quota gratuit et facturation

Le quota mensuel d'appels gratuits, le prix unitaire au paiement à l'utilisation après dépassement du quota, ainsi que les limites QPS et les limites d'appels quotidiennes pour chaque édition sont résumés dans le tableau de la section Limitations ci-dessus. Les informations suivantes fournissent des détails supplémentaires sur les métriques de facturation et les considérations associées.

Important
  • Chaque mois calendaire, un quota gratuit d'appels OpenAPI est attribué à chaque compte Alibaba Cloud (y compris les utilisateurs RAM) dans chaque région. Le quota mensuel gratuit varie selon l'édition de DataWorks.

  • L'édition Basic est soumise à la fois à la limite d'appels quotidienne et au quota mensuel d'appels gratuits (pour plus de détails, voir la section Limitations ci-dessus). Les appels sont rejetés une fois la limite dépassée et la facturation au paiement à l'utilisation n'est pas prise en charge. Les éditions Standard et Professional n'imposent aucune limite d'appels quotidienne et disposent chacune d'un quota mensuel d'appels gratuits (voir le tableau de la section Limitations ci-dessus). La facturation au paiement à l'utilisation est activée après dépassement du quota gratuit. Pour connaître les prix unitaires et les différences spécifiques à l'environnement, consultez la section Facturation OpenAPI dans Coûts des ressources. L'édition Enterprise n'impose aucune limite d'appels quotidienne et les mêmes règles de facturation au paiement à l'utilisation s'appliquent une fois le quota gratuit épuisé.

  • Les éditions Standard, Professional et Enterprise de DataWorks permettent de poursuivre les appels API aux tarifs du paiement à l'utilisation une fois le quota mensuel d'appels gratuits consommé. Les sites internationaux appliquent le prix unitaire et la facturation indiqués dans la documentation. Pour plus d'informations, consultez la section Coûts des ressources. Le prix de facturation réel correspond au prix affiché sur votre facture finale.

Comment appeler l'OpenAPI

Remarque

Pour plus d'informations sur l'OpenAPI Alibaba Cloud, consultez la section Alibaba Cloud OpenAPI.

Méthodes d'appel

Méthode d'appel

Statut de support

Description

SDK (recommandé)

Pris en charge

Pour connaître les langages pris en charge par le SDK DataWorks et les méthodes d'installation des dépendances, consultez la section SDK DataWorks.

Appel HTTP natif

Pris en charge

Les appels HTTP natifs nécessitent l'implémentation de l'algorithme de signature et la construction de requêtes personnalisées pour initier les appels HTTP. Pour plus d'informations sur le mécanisme de signature, consultez la section Mécanisme de signature.

Exemples d'appel

Style d'API

Style RPC.

Endpoints

Sélectionnez l'endpoint correspondant à la région où réside votre espace de travail DataWorks afin d'obtenir la latence la plus faible. Par exemple, l'endpoint VPC pour la région Chine (Zhangjiakou) est dataworks-vpc.cn-zhangjiakou.aliyuncs.com. Pour plus d'informations, consultez les sections Endpoints (2024-05-18) et Endpoints (2020-05-18).

Consulter l'utilisation de l'OpenAPI

Utilisez Open Platform pour consulter votre utilisation de l'OpenAPI, y compris la consommation du quota gratuit, le nombre d'appels et les détails des appels. Pour plus d'informations, consultez la section Consulter l'utilisation de l'OpenAPI.