调用DataWorks OpenAPI-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

本文为您介绍使用大数据开发治理平台DataWorks OpenAPI的基本信息、使用限制、计费及调用说明。

基本信息

版本	OpenAPI门户	支持的API列表	支持的地域
2024-05-18（新版OpenAPI）	OpenAPI门户	支持的API列表	华东1（杭州）、华东2（上海）、华南1（深圳）、华北2（北京）、华北3（张家口）、北京政务云、华东2（上海）金融云、西南1（成都）、中国（香港）、亚太东南1（新加坡）、印度尼西亚（雅加达）、美国（硅谷）、美国（弗吉尼亚）和德国（法兰克福）、英国（伦敦）、日本（东京）、马来西亚（吉隆坡）重要数据开发相关API使用说明：如果您使用新版数据开发（Data Studio），请使用2024-05-18版本。如果您未使用新版数据开发（Data Studio），请使用2020-05-18版本。请您确认是否已使用新版数据开发（Data Studio），并选择对应的OpenAPI版本。若未正确选择，可能导致查询失败或无法获取预期结果。
2020-05-18（旧版OpenAPI）	OpenAPI门户	支持的API列表

DataWorks为您提供不同功能模块的OpenAPI，如租户、元数据、数据开发、运维中心等功能模块。各功能模块的OpenAPI对DataWorks的版本要求与功能本身对DataWorks版本的要求一致。

为规范DataWorks OpenAPI的调用，保障系统稳定性，将OpenAPI分为读、写两类。不同DataWorks版本中的读、写OpenAPI分别有相应的QPS限制；其中基础版还设有每日调用次数上限，标准版、专业版、企业版不设每日调用次数上限，具体如下。

重要

API QPS和调用次数的统计口径：每个主账号及其子账号在每个地域的累计值。
当超过QPS限制，或基础版超过每日调用次数上限后，将会出现调用失败，请合理控制调用并发和次数。
对基础版，API调用成功和调用失败的次数均计入每日调用次数上限；标准版、专业版、企业版不设每日调用次数上限，调用失败次数不计入每日调用次数上限，请关注每月免费调用额度及按量计费规则。
各API的读写类型可以根据API名称判断，例如CreateFile为写API，ListFiles为读API。

您在调用OpenAPI前，请检查是否开启AliyunDataWorksFullAccess权限，以防因权限问题导致调用OpenAPI失败，详情可参考用户权限控制。

各版本OpenAPI的每月免费调用额度及超出后是否支持按量计费不同，可免费调用的额度及后续按量计费的详情如下。

重要

每个自然月会给每个主账号（包含子账号）在每个地域的OpenAPI一定的免费调用额度，不同版本的DataWorks每月可用的免费额度不一样。
基础版同时受每日调用次数与每月免费调用额度限制（详情见上文使用限制），超出后不可继续调用，且不支持按量付费。标准版、专业版不设每日调用次数上限，每月各有免费调用额度（见上表）；超出免费额度后支持按量计费，单价与环境差异请参见资源成本中的OpenAPI计费。企业版不设每日调用次数上限，免费额度用尽后按量计费规则保持不变。
DataWorks标准版、专业版和企业版在每月免费调用额度用完后，支持按按量计费的价格继续调用。不同云环境（公有云、政务云、金融云等）的单价详见「OpenAPI计费」章节「费用详情」表格。详情请参见资源成本，实际计费价格以最终账单显示的价格为准。

说明

关于使用阿里云OpenAPI的详细介绍，请参见阿里云OpenAPI。

调用方式	支持情况	说明
阿里云SDK（推荐）	支持	大数据开发治理平台 DataWorks SDK支持语言及依赖安装方法请参见大数据开发治理平台 DataWorks SDK。
原生HTTP调用	支持	原生HTTP调用需要您自己实现签名算法，并构建自定义请求，发起HTTP调用。有关签名机制的更多详细信息，请参见请求结构和签名机制。

RPC风格。

根据DataWorks项目空间所在的地域，选择对应的服务接入点地址，以获得最低延迟。例如华北3（张家口）的VPC接入地址为dataworks-vpc.cn-zhangjiakou.aliyuncs.com，更多信息请参见服务接入点（2024-05-18）和服务接入点（2020-05-18）。

您可以通过开放平台，轻松获取OpenAPI的使用情况，包括免费额度使用情况、调用次数和调度明细等信息。详情请参见开放API（OpenAPI）。