通过应用授权APP认证方式API
应用定义了一个API调用者的身份。对于使用APP认证方式的API,必须在创建APP类型应用并将API授权给应用后,才能获得认证信息以用于API调用。
一个APP认证方式的API可以授权给多个APP类型的应用,多个APP认证方式的API也可以授权给同一个APP类型的应用。API授权后,在调用时就可以使用任意授权应用的密钥对(AppKey和AppSecret)进行安全认证,对调用者本身的用户身份无要求。
约束与限制
- 使用APP认证方式的API必须先通过应用授权才能调用。
- APP认证方式的API只能授权给APP类型的应用。
- 如果对无认证方式的API进行应用授权,则系统会忽略此操作。
- 仅数据服务专享版支持重置APP类型应用的AppSecret。
- 仅DAYU Administrator、Tenant Administrator或者工作空间管理员支持重置APP类型应用的AppSecret。
- APPSecret限制一分钟内重置一次,重置记录可在事件管理内查看。
- 重置APPSecret会导致已授权的API调用失败,请谨慎操作。
创建APP类型的应用
- 在DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
- 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
- 单击“调用API > 应用管理”,进入到应用管理页面。单击“新建”,弹出“新建应用”对话框。填写如表1所示信息。
- 单击“确定”,创建应用。
- 单击“应用名称”,进入应用详情页面可查看AppKey和AppSecret,并可以重置AppSecret。
重置APPSecret会导致已授权的API调用失败,请谨慎操作。
图1 应用详情
将APP认证方式的API授权给APP类型的应用
使用APP认证方式的API,必须将API授权给应用后,才能进行API调用。授权可以分为API开发者主动授权和API调用者申请授权,本文以API开发者主动授权为例进行介绍。
- 在DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
- 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
- 单击“开发API > API管理”,进入到API管理页面。
- 在待绑定应用的APP认证方式API所在行,单击“更多 > 查看授权”,进入API完整信息界面。在“授权信息”页签中,单击“授权”。
- 在添加授权页面,设置授权的截止时间、选择集群(仅专享版涉及),勾选应用名称,然后单击“确认授权”,完成API的授权。
如果生成API时设置入参位置为Static,则还需设置静态参数值。如果未配置Static参数值,则SDK调用时会使用API入参默认值,API工具调用时会导致缺少Static参数值的报错。
图2 添加授权
- 授权成功后,可以在应用管理详情页面查看已绑定的API。
- 如果已绑定API列表中包含无需绑定的API,在此API所在行的操作列,单击“解绑”,将无需绑定的API删除。
- 如果需要调试已绑定的API,单击“测试”,进入调试页面。
- 如果需要对已绑定的API延长授权时间,单击“续约”。
相关操作
批量授权应用:您可以在专享版的
页面,勾选需要授权应用的API后,依次单击API列表上方的“批量操作 > 批量授权应用”,实现多个API的批量授权应用。批量授权应用时,不支持同时授权多种认证类型API。