文档

使用OpenAPI

更新时间:

本文为您介绍使用大数据开发治理平台 DataWorks OpenAPI的基本信息。

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

基本信息

版本说明

版本号

说明

2020-05-18

推荐使用。

接入点说明

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

接口风格

RPC风格。

调用方式支持情况

调用方式

支持情况

说明

阿里云SDK(推荐)

支持

大数据开发治理平台 DataWorks SDK支持语言及依赖安装方法请参见大数据开发治理平台 DataWorks SDK

支持的API列表

详情请参见API概览

版本与地域要求

  • 版本要求:

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

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

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

  • 可用地域:

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

调用限制

为规范DataWorks OpenAPI的调用,保障系统稳定性,将OpenAPI分为1级、2级和3级。不同版本和不同分级的OpenAPI分别有相应的QPS限制和每日调用次数限制,具体如下。

说明

查看OpenAPI免费额度、调用次数、调用明细等详情请参见查看OpenAPI使用情况

版本

QPS限制

每日调用次数上限

基础版

1级、2级、3级API总QPS≤5

每日API总调用次数≤100次

标准版

每日API总调用次数≤1000次

专业版

每日API总调用次数≤10000次

企业版

  • 1级API QPS≤50

  • 2级API QPS≤20

  • 3级API QPS≤5

  • 1级、2级API 每日API总调用次数不限

  • 3级API 每日API总调用次数≤10000次

重要
  • API QPS和调用次数的统计口径:每个主账号及其子账号在每个地域的累计值。

  • 当超过QPS或每日调用次数限制后,将会出现调用失败,请合理控制调用并发和次数。

  • API调用成功和调用失败的次数都会计入每日调用限制次数中。

免费额度与计费方式

OpenAPI采用版本结合按量计费的商业化方式,计费标准如下。

版本

免费调用额度

超出免费调用额度后按量计费

基础版

3100次/月

有调用限制,不支持额外按量付费。

标准版

31000次/月

专业版

310000次/月

企业版

1000000次/月

0.3元/万次

重要
  • 每个自然月会给与每个主账号(包含子账号)在每个地域的OpenAPI一定的免费调用额度,不同版本的DataWorks每月可用的免费额度不一样。

  • 受不同版本DataWorks日调用次数限制(详情见调用限制),基础版、标准版、专业版的每月实际可调用量可能无法超过免费调用额度,且不支持按量付费。

  • DataWorks企业版免费额度用尽后,支持根据按量计费的价格进行收费,公共云的计费如上所示,政务云环境下超出后的计费为0.6元/万次,金融云环境下超出后的计费为0.57元/万次,实际计费价格以最终账单显示的价格为准。

  • 只有当API调用成功后,才会消耗免费调用额度并且在超过免费调用额度后按量计费,API调用失败的话不会消耗免费调用额度且不计量计费。

  • 本页导读 (1)