创建应用并申请API授权
应用定义了一个API调用者的身份。您可以将一个API授权给多个应用,也可以将多个API授权给同一个应用。
对于使用APP或IAM认证方式的API,必须在创建应用并将API授权给应用后,才能进行API调用。
![](https://support.huaweicloud.com/usermanual-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png)
数据服务共享版中使用IAM认证方式的API无需进行授权,即可进行调用。而专享版中使用IAM认证方式的API则必须先授权才能调用。
如果API开发者已完成创建应用并添加API授权,则API调用者无需再创建应用并申请授权,可跳过本章节直接进行API调用操作。
约束与限制
- IAM类型的应用每个DataArts Studio实例下仅能创建1个,名称固定为华为账号且不支持修改。
- 仅数据服务专享版支持重置APP类型应用的AppSecret。
- 仅DAYU Administrator、Tenant Administrator或者工作空间管理员支持重置APP类型应用的AppSecret。
- APPSecret限制一分钟内重置一次,重置记录可在事件管理内查看。
- 重置APPSecret会导致已授权的API调用失败,请谨慎操作。
创建应用
当待调用的API为APP或IAM认证方式时,需要进行此操作。
- 在DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
- 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
- 单击“调用API > 应用管理”,进入到应用管理页面。单击“新建”,弹出“新建应用”对话框。填写如表1所示信息。
- 单击“确定”,创建应用。
- 单击“应用名称”,进入应用详情页面。APP类型的应用支持查看AppKey和AppSecret,并可以重置AppSecret。
重置APPSecret会导致已授权的API调用失败,请谨慎操作。
图1 应用详情
将API授权给应用
使用APP或IAM认证方式的API,必须将API授权给应用后,才能进行API调用。授权可以分为API开发者主动授权和API调用者申请授权,本文以API调用者申请授权为例进行介绍。
- 在DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
- 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
- 通过申请授权,将API授权给应用。
- 单击 ,可查看到所有已发布的API信息。
- 单击待绑定应用的API名称,进入API信息页面。
- 在“调用信息”页面,单击“申请权限”。
- 在申请权限页面,设置使用截止时间、选择应用,然后单击“确认”,完成API的权限申请。
生成API时,如果设置入参位置为Static,则还需设置静态参数值。如果授权时未配置参数值,则SDK调用时会使用API入参默认值,API工具调用时会导致缺少Static参数值的报错。
图2 申请权限 - 申请后,需要等待审核中心审核,方可授权成功。
- 授权成功后,可以在应用管理详情页面查看已绑定的API。
- 如果已绑定API列表中包含无需绑定的API,在此API所在行的操作列,单击“解绑”,将无需绑定的API删除。
- 如果需要调试已绑定的API,单击“测试”,进入调试页面。
- 如果需要对已绑定的API延长授权时间,单击“续约”。