开放API（OpenAPI）

使用限制

• 版本要求：

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

  • 各版本的OpenAPI有相应的调用限制，详情请参见调用限制。

  • 各版本的OpenAPI分别提供相应的每月免费调用额度，超过之后则需按量付费，可免费调用的额度及后续按量计费的详情请参见免费额度与计费方式。

  • 各个OpenAPI对应的版本，请参见OpenAPI列表。

• 可用地域：

  华东1（杭州）、华东2（上海）、华南1（深圳）、华北2（北京）、华北3（张家口）、北京政务云、华东2（上海）金融云、西南1（成都）、中国（香港）、亚太东南1（新加坡）、印度尼西亚（雅加达）、美国（硅谷）、美国（弗吉尼亚）、德国（法兰克福）、英国（伦敦）、日本（东京）、马来西亚（吉隆坡） 。

查看OpenAPI使用情况

登录DataWorks控制台，切换至目标地域后，单击左侧导航栏的更多 > 开放平台，进入开放平台的开发者后台页面。

您可在该页面查看OpenAPI的使用情况，以及DataWorks为您提供的OpenAPI最佳实践。

OpenAPI功能区简介

OpenAPI页面可以为您展示OpenAPI的使用情况，具体如下：

• OpenAPI免费额度：可以查看每个自然月截止当前日期API的免费额度使用情况。目前，不同版本的DataWorks会为您提供不同的免费调用额度，免费额度使用完后，超出部分会按量计费，具体请参考DataWorks OpenAPI概述。

• OpenAPI调用次数：可以查看每个自然月截止当前日期所有OpenAPI的总调用次数，按自然月累计，每月1日清零重新累计。

• OpenAPI调用明细：可以查看特定时间段内API的调用信息，包括调用日期、API类别、API级别、当天调用次数和本月累计调用次数。您可以通过API类型和API级别筛选所要查找的API信息。不同版本的DataWorks每日可调用的次数上限不同，详情请参见DataWorks OpenAPI概述。

OpenAPI最佳实践

在开放平台的OpenAPI页面上，有OpenAPI最佳实践模块，在模块下直接单击最佳实践，可跳转到相应的最佳实践文档。或者，您也可以点击以下链接跳转到相应的最佳实践文档，供您参考。

• 最佳实践：文件管理OpenAPI基础实践。

• 最佳实践：表管理OpenAPI基础实践。

• 最佳实践：通过OpenAPI创建、修改、删除离线同步任务。

• 最佳实践：数据开发、提交与运行OpenAPI基础实践。

• 最佳实践：数据ETL操作全流程实践。

更多OpenAPI参考，详情请参见API概览。