更新时间:2024-02-22 GMT+08:00
分享

调用API

概述

您作为API调用者,需要实现一个API的调用,那么您需要完成以下工作:
  1. 获取API

    从服务目录获取需要调用API。仅在API发布后,才支持被调用。

  2. (可选)创建应用并获取授权

    对于使用APP认证的API,需要完成创建应用将API授权给应用。在API调用过程中,使用所创建应用的密钥对(AppKey、AppSecret),数据服务根据密钥对进行身份核对,完成鉴权。关于使用APP认证的方法,具体请参考数据服务SDK参考

  3. 调用API

    API调用者完成以上步骤后,可以参考数据服务SDK参考进行API调用。

(可选)创建应用

当待调用的API为APP认证方式时,需要进行此操作。

  1. DataArts Studio控制台首页,选择实例,单击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。
    图1 选择数据服务

  1. 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
  2. 单击“调用API > 应用管理”,进入到应用管理页面。单击“新建”,弹出“新建应用”对话框。填写如表1所示信息。
    表1 应用信息

    信息项

    描述

    应用名称

    应用名称。

    应用类型

    IAM:使用IAM认证,即token访问。

    APP:对接APP,通过APP认证方式访问。

    描述

    对应用的介绍。

  3. 单击“确定”,创建应用。

    创建应用成功后,在“应用管理”页面的列表中显示新创建的应用和应用ID。

  4. 单击“应用名称”,进入应用详情页面,查看AppKey和AppSecret。
    图2 应用详情

(可选)将API授权给应用

当待调用的API为APP认证方式时,需要进行此操作。

  1. DataArts Studio控制台首页,选择实例,单击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。
    图3 选择数据服务

  1. 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
  2. 通过以下任意一种方式,将API授权给应用。
    主动授权:
    1. 单击“开发API > API管理”,进入到API管理页面。
    2. 在待绑定应用的API所在行,单击“查看授权”,进入API完整信息界面。

      “授权信息”页签中,单击“添加授权”

    3. (可选)生成API时,如果设置入参位置为Static,则需要设置静态参数值。如果此处未配置参数值,则会使用API入参默认值作为替代。
    4. 设置授权的截止时间,勾选应用名称,单击“确认授权”,完成API的授权。

    申请授权:

    1. 单击调用API > 服务目录,可查看到所有已发布的API信息。
    2. 单击待绑定应用的API名称,进入API完整信息页面。
    3. 在“调用信息”页面,单击“申请权限”
    4. (可选)生成API时,如果设置入参位置为Static,则需要设置静态参数值。如果此处未配置参数值,则会使用API入参默认值作为替代。
    5. 设置使用截止时间并选择应用名称,单击“确认”
    6. 申请后,需要等待审核中心审核,方可授权成功。
  3. 授权成功后,可以在应用管理详情页面查看已绑定的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域名并填写入参即可进行调用。

分享:

    相关文档

    相关产品