更新时间:2024-07-11 GMT+08:00
调用API
您作为API调用者,需要实现一个API的调用,那么您需要完成以下工作:
约束与限制
- 仅DAYU Administrator、Tenant Administrator或者工作空间管理员支持重置APP类型应用的AppSecret。
- APPSecret限制一分钟内重置一次,重置记录可在事件管理内查看。
- 重置APPSecret会导致已授权的API调用失败,请谨慎操作。
(可选)创建应用
当待调用的API为APP认证方式时,需要进行此操作。
- 在DataArts Studio控制台首页,选择实例,单击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。
图1 选择数据服务
- 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
- 单击“调用API > 应用管理”,进入到应用管理页面。单击“新建”,弹出“新建应用”对话框。填写如表1所示信息。
- 单击“确定”,创建应用。
- 单击“应用名称”,进入应用详情页面。APP类型的应用支持查看AppKey和AppSecret,并可以重置AppSecret。
重置APPSecret会导致已授权的API调用失败,请谨慎操作。
图2 应用详情
(可选)将API授权给应用
当待调用的API为APP认证方式时,需要进行此操作。
- 在DataArts Studio控制台首页,选择实例,单击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。
图3 选择数据服务
- 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
- 通过以下任意一种方式,将API授权给应用。
申请授权:
- 单击 ,可查看到所有已发布的API信息。
- 单击待绑定应用的API名称,进入API完整信息页面。
- 在“调用信息”页面,单击“申请权限”。
- (可选)生成API时,如果设置入参位置为Static,则需要设置静态参数值。如果此处未配置参数值,则会使用API入参默认值作为替代。
- 设置使用截止时间并选择应用名称,单击“确认”。
- 申请后,需要等待审核中心审核,方可授权成功。
- 授权成功后,可以在应用管理详情页面查看已绑定的API。
- 如果已绑定API列表中包含无需绑定的API,在此API所在行的操作列,单击“解绑”,将无需绑定的API删除。
- 如果需要调试已绑定的API,单击“测试”,进入调试页面。
- 如果需要对已绑定的API延长授权时间,单击“续约”。
调用API
创建API时,有如下三种认证方式可选。三种方式的区别在于认证方式和调用方法不同,推荐使用安全性更高的“APP认证方式”。
- “APP认证方式”:API调用者通过APP认证方式调用API。Appkey & Appsecret安全级别高,推荐使用。
使用APP认证时,需要通过SDK访问,其中SDK访问提供了基于Java、Go、Python、JavaScript、C#、PHP、C++、C、Android等多种语言的SDK包。各语言调用API示例请参考使用APP认证调用API章节。
- “IAM认证”:需要借助IAM服务进行安全认证。IAM认证只允许华为云用户访问,安全级别中等。
使用IAM认证时,需要通过调用IAM服务的获取用户Token接口获取Token,然后通过在请求消息头中添加“X-Auth-Token”参数并将所获取的Token作为参数值,再通过API调用工具或SDK方式调用已发布的API。
- “无认证”:不需要认证。安全级别低,所有用户均可访问,建议仅在测试接口时使用,不推荐正式使用。若调用方为不可信任用户,则存在数据库安全风险(如数据泄露、数据库高并发访问导致宕机、SQL注入等风险)。
使用无认证方式时,无需鉴权认证信息。通过API调用工具或SDK方式,直接使用已发布API域名并填写入参即可进行调用。
父主题: 数据服务组件