您需要申请API权限后,才能调用API。本文为您介绍如何申请和交还API权限。
申请API权限
在Dataphin首页的顶部菜单栏,选择管理中心 > 权限管理。
在左侧导航栏选择我的权限 > 数据服务权限,再单击顶部菜单栏的API权限,在API权限页签,单击右上角的+申请API权限按钮。
在API权限申请页面,配置参数。
参数
描述
API权限对象
API
根据服务项目与API分组选择API。
账号类型
选择为API授权的账号类型,支持选择应用和个人账号。系统默认选中应用。
个人账号:当账号类型为个人账号,API选择开发环境且为Basic模式,访问的数据环境为生产数据环境,请谨慎操作;若API选择开发环境且为Dev-Prod模式,访问的数据环境为开发数据环境。
API运行环境
当账号类型为应用时需配置。选择API的运行环境,支持开发环境和生产环境,可多选。
说明API的运行根据所选的运行环境进行运行。当API运行环境选择开发环境时,API基于提交至开发环境的配置运行;当API运行环境选择生产环境时,API基于发布至生产环境的配置运行。
权限所属项目
根据API所选择的服务项目展示,不支持修改。
应用
当账号类型选择应用时需配置。根据应用分组选择应用。
权限字段表
当账号类型选择应用时需配置。可选字段将根据API运行环境选择生产环境或开发环境下需授权的字段。若API关联了行级权限,系统会以行级权限生效中进行标识,您可以单击查看行级权限按钮,在查看行级权限面板中,切换查看对应环境的行级权限信息。
说明当API选择开发环境且为Basic模式,访问的数据环境为生产数据环境,请谨慎操作。
当API运行环境为生产环境时,可选择当前API线上版本的返回参数;当API运行环境为开发环境时,可选择当前API最新版本开发环境下的返回参数。
当应用申请代理模式权限调用API时,系统会根据被代理用户的行级权限返回数据范围;若应用没有代理模式权限,则根据应用的行级权限返回数据。
权限配置
权限类型
系统默认选中使用权限,不支持修改;当账号类型选择应用时,支持选择代理权限。
代理权限:当API开启了行级权限且配置的DelegationUid参数非空(即在数据服务 > 调用 > 已授权API服务的调用页面的公共参数列表区域配置行级权限参数值)时生效。在调用API时,需申请代理模式权限,应用才能代理用户调用关联了行级权限的API,更多API调用的直连模式和代理模式说明,请参见API调用/测试直连模式和代理模式说明。
有效期
系统支持选择30天,90天,180天和长期,您也可以选中自定义后,选择截止日期。
申请原因
填写申请原因,便于审批者查看审批原因。不超过128个字符。
单击提交,完成API权限申请。
交还API权限
在API权限页签,单击目标API操作列下的交还。
在是否进行交还该权限对话框中,单击确定,完成API权限的交还。