更新时间:2024-11-06 GMT+08:00

数据服务API概览

表1 数据服务API类型

类型

说明

API管理接口

API管理接口。

申请管理接口

申请管理接口。

消息管理接口

消息管理接口。

授权管理接口

授权管理接口。

服务目录管理接口

服务目录管理接口。

网关管理接口

网关管理接口。

应用管理接口

应用管理接口。

总览接口

总览接口。

集群管理接口

集群管理接口。

API管理接口

表2 API管理接口

API

说明

API流量限制(次/10s)

用户流量限制(次/10s)

创建API

创建API。

2400

120

查询API列表

查询API列表。

2400

120

更新API

更新API。

2400

120

查询API信息

查询API信息。

2400

120

批量删除API

批量删除API。

2400

120

发布API

发布API。API只有发布后,才能够被调用。API发布时,可以将API发送至指定网关。

2400

120

API操作(下线/停用/恢复)

下线API。将已发布的API下线。下线后,所有授权关系都会被解除,API将无法再被调用。

2400

120

批量授权API(专享版)

APP创建成功后,还不能访问API,如果想要访问某个API,需要将该API授权给APP。API主动授权成功后,在有效期内,APP即可访问该API。

2400

120

调试API

调试API。

2400

120

API授权操作(授权/取消授权/申请/续约)

API主动授权: API审核人可发起,API主动授权成功后,在有效期内,APP即可访问该API。API授权包含授权和续约两部分功能。

2400

120

查看API发布信息(专享版)

查看API在不同集群上的发布信息。

2400

120

查看API不同操作对应的实例信息(专享版)

查看API不同操作对应的实例信息。

2400

120

查看API调试信息(专享版)

查看API在不同集群上的调试信息。

2400

120

导入包含API信息的EXCEL文件

导入包含API信息的EXCEL文件。

2400

120

导出包含API信息的EXCEL文件

导出包含API信息的EXCEL文件。

2400

120

全量导出包含API的EXCEL压缩文件

全量导出包含API的EXCEL压缩文件。

2400

120

下载EXCEL模板

下载EXCEL模板。

2400

120

申请管理接口

表3 申请管理接口

API

说明

API流量限制(次/10s)

用户流量限制(次/10s)

查询申请列表

查询申请列表。

2400

120

审核申请

审核申请。

2400

120

获取申请详情

获取申请详情。

2400

120

消息管理接口

表4 消息管理接口

API

说明

API流量限制(次/10s)

用户流量限制(次/10s)

查询消息列表

查询审核中心的通知消息列表。与申请不同,通知类消息,无法驳回,仅能在指定的时间范围内作出处理。

2400

120

处理消息

对收到的通知消息进行确认,可以在指定的时间范围内选择何时进行处理。

2400

120

获取消息详情

获取消息详情。此功能仅用作信息详情展示,不用做业务处理,因此不展示编号等后台参数。

2400

120

授权管理接口

表5 授权管理接口

API

说明

API流量限制(次/10s)

用户流量限制(次/10s)

查询API已授权的APP

查询API已授权的APP。

2400

120

查询APP已拥有授权的API

查询APP已拥有授权的API。

2400

120

服务目录管理接口

表6 服务目录管理接口

API

说明

API流量限制(次/10s)

用户流量限制(次/10s)

获取当前目录下的所有类型列表

获取当前目录下所有类型列表(包括API和目录,均以目录的数据格式形式展示)。

2400

120

获取当前目录下的API列表

获取当前目录下的API列表。

2400

120

获取当前目录下的目录列表(全量)

获取当前目录下的目录列表(全量数据,不分页,推荐仅用于生成目录树等无法分页的场景)。

2400

120

更新服务目录

更新服务目录。

2400

120

查询服务目录

查询服务目录。

2400

120

创建服务目录

创建服务目录。根目录编号为0。

2400

120

批量删除目录

批量删除服务目录。

2400

120

移动当前目录至新目录

移动当前目录至新目录。

2400

120

批量移动API至新目录

批量移动API至新目录。

2400

120

通过路径获取ID

通过路径获取ID。

2400

120

通过ID获取路径

通过ID获取路径。

2400

120

通过目录ID获取路径对象

通过目录id获取路径对象。

2400

120

查询服务目录API列表

查询服务目录API列表。

2400

120

网关管理接口

表7 网关管理接口

API

说明

API流量限制(次/10s)

用户流量限制(次/10s)

获取网关实例(专享版)

获取网关实例(专享版)。

2400

120

获取网关分组

获取网关分组。

2400

120

应用管理接口

表8 应用管理接口

API

说明

API流量限制(次/10s)

用户流量限制(次/10s)

创建应用

创建应用。

2400

120

查询应用列表

查询应用列表。

2400

120

更新应用

更新应用。

2400

120

删除应用

删除应用。

2400

120

查询应用详情

查询应用详情。

2400

120

总览接口

表9 总览接口

API

说明

API流量限制(次/10s)

用户流量限制(次/10s)

查询统计用户相关的总览开发指标

查询统计用户相关的总览开发指标。

2400

120

查询统计用户相关的总览调用指标

查询统计用户相关的总览调用指标。

2400

120

查询API服务调用TopN

查询API服务调用TopN。

2400

120

查询APP服务使用TopN

查询APP服务使用TopN。

2400

120

查询API统计数据详情

查询API统计数据详情。

2400

120

查询APP统计数据详情

查询APP统计数据详情。

2400

120

查询API仪表板数据详情

查询API仪表板数据详情。

2400

120

查询指定API仪表板数据详情

查询指定API仪表板数据详情。

2400

120

查询APP仪表板数据详情

查询APP仪表板数据详情。

2400

120

查询指定API应用调用TopN

查询指定API应用调用TopN。

2400

120

集群管理接口

表10 集群管理接口

API

说明

API流量限制(次/10s)

用户流量限制(次/10s)

查询集群概览信息列表

查询集群概览信息列表。

2400

120

查询集群详情信息列表

查询集群详情信息列表。

2400

120

查询集群详情信息

查询集群详情信息。

2400

120

查询数据服务集群访问日志列表

查询数据服务集群访问日志列表。

2400

120

开启数据服务集群OBS日志转储

开启数据服务集群OBS日志转储。

2400

120

开启数据服务集群LTS日志转储

开启数据服务集群LTS日志转储。

2400

120