Dataphin数据服务API开启IP白名单调用鉴权

本文涉及的产品
智能数据建设与治理Dataphin,200数据处理单元
简介: Dataphin数据服务API提供便捷的API开发及运维、应用调用权限管理等功能,为数据业务化提供了坚实的支撑。在应用调用API的时候,Dataphin可支持通过AcessKey方式的调用鉴权。而在企业内部网络中,也可以使用IP白名单方式简化调用。本文将为您介绍如何开启IP白名单的调用鉴权。

限制条件

通过IP白名单调用方式仅在私有网关下支持,公共云网关及专有云网关均不支持该方式调用。

1. 系统设置开启应用IP白名单

1.1 Dataphin V3.14及以上版本

路径:数据服务-管理-系统配置

操作:API调用鉴权配置,“是否开启应用IP白名单”设置为“开启”


1.2 Dataphin V3.13及以前的版本

Dataphin V3.13及以前的版本不支持界面化开启或关闭使用白名单鉴权,需要提交申请到Dataphin运维团队进行后台的配置。


2. 调用应用中设置IP白名单

路径:数据服务 - 调用 - 应用管理 - 应用IP白名单配置

操作

  1. IP白名单调用:开启
  2. 添加调用方应用程序所在的IP地址


3. 应用程序调用API

3.1 获取API服务的域名

需要获取API网关的域名地址,用于API调用。

进入 数据服务 -> 管理 -> 网络配置,开启域名开关,可看到API域名信息。该域名将在后续步骤中使用。


3.2 获取应用的AppKey

需要应用的AppKey,用于API调用。

进入 数据服务 -> 调用 -> 应用管理,获取对应的应用的AppKey。该AppKey即为后续应用调用时的识别码,在调用API作为参数传入。


3.3 获取API ID、协议及请求方式

路径:数据服务 -> 市场 -> API服务

选择需要调用的API,点击“API文档”

在API中文档中,获取APP_ID、请求方式、协议。


3.4 在应用程序中调用API

可在应用程序中通过HTTP/HTTPS调用API,配置参数如下:

  1. URL:scheme://host/request_method/API_ID?appKey=appKeyValue[&env=env_value]
  • scheme:HTTP。访问协议,私有网关下仅支持HTTP,不支持HTTPS
  • host:在3.1 获取API服务的域名中获取的API服务的域名
  • request_method:需要调用的API的请求方式
  • appKeyValue:在 3.2获取应用的AppKey 中获取的应用的AppKey
  • env_value:可选择填写PROD、PRE,根据API的不同模式,可查询不同的环境

API模式

PROD

PRE

Basic

访问线上生产环境的API

不支持输入PRE

Dev-Prod

访问线上生产环境的API,且访问生产环境的数据源中的数据

访问线上开发环境的API,且对于开发环境的数据源中的数据

2)Headers参数

参数名称

是否必填

说明

示例值

x-ca-key

输入应用对应的AppKey

12345667

whitelist-flag

输入固定值1

1

Content-Type

application/json

application/json


6)Body格式:JSON

{
  "conditions": {"queryfield1":queryvalue1},
  "pageStart":0,
  "pageSize":10,
  "orderBys": [ 
    {"field":"字段名名称","order":"DESC"}
  ],
  "returnFields": [
    "returnField1","returnField2"
  ],
  "useModelCache": false,
  "useResultCache": false
}


Body参数说明:

参数名称

说明

conditions

queryfield1为请求参数名称,queryvalue1为请求参数输入值

pageStart

分页码

pageSize

每页数量

orderBys

排序参数设置。如果查询是分页的,为了保障每次分页的稳定性,需要指定orderBys的字段。

returnFields

API返回参数集合,返回参数名称

useModelCache

查询参数是否缓存

useResultCache

结果是否缓存


3.5 Postman调用示例


  1. Scheme:Post
  2. URL:根据数据服务的域名、API ID、API请求方式、调用应用的appKey值,拼接出URL

  1. Headers:


  1. Body信息


image.png


相关实践学习
基于函数计算快速搭建Hexo博客系统
本场景介绍如何使用阿里云函数计算服务命令行工具快速搭建一个Hexo博客。
相关文章
|
1月前
|
数据可视化 Linux API
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
|
6天前
|
API Go
使用Go语言通过API获取代理IP并使用获取到的代理IP
使用Go语言通过API获取代理IP并使用获取到的代理IP
|
6天前
|
安全 Java API
java借助代理ip,解决访问api频繁导致ip被禁的问题
java借助代理ip,解决访问api频繁导致ip被禁的问题
|
1月前
|
分布式计算 资源调度 DataWorks
dataworks常见问题之数据服务api返回超时如何解决
DataWorks是阿里云提供的一站式大数据开发与管理平台,支持数据集成、数据开发、数据治理等功能;在本汇总中,我们梳理了DataWorks产品在使用过程中经常遇到的问题及解答,以助用户在数据处理和分析工作中提高效率,降低难度。
28 2
|
5月前
|
SQL API 数据安全/隐私保护
带你读《构建企业级好数据(Dataphin智能数据建设与治理白皮书)》——6. 数据服务:集中管控,快速服务业务系统
带你读《构建企业级好数据(Dataphin智能数据建设与治理白皮书)》——6. 数据服务:集中管控,快速服务业务系统
147 0
|
5月前
|
存储 网络协议 API
网络编程必备:深入理解TCP/IP协议栈(含posix API实现)(下)
网络编程必备:深入理解TCP/IP协议栈(含posix API实现)
|
5月前
|
网络协议 算法 API
网络编程必备:深入理解TCP/IP协议栈(含posix API实现)(上)
网络编程必备:深入理解TCP/IP协议栈(含posix API实现)
|
6月前
|
SQL DataWorks NoSQL
阿里云DataWorks的数据服务可以帮助企业统一管理对内对外的API服务
阿里云DataWorks的数据服务可以帮助企业统一管理对内对外的API服务
176 2
|
API 定位技术
百度地图IP对应的API查询
http://developer.baidu.com/map/ip-location-api.htm
875 0
|
16天前
|
缓存 前端开发 API
API接口封装系列
API(Application Programming Interface)接口封装是将系统内部的功能封装成可复用的程序接口并向外部提供,以便其他系统调用和使用这些功能,通过这种方式实现系统之间的通信和协作。下面将介绍API接口封装的一些关键步骤和注意事项。