更新时间:2024-08-05 GMT+08:00

申请API授权

对于API调用者而言,如果API开发者未授权APP或IAM认证方式的API,则需要自行申请API授权,等待审批通过后才能进行API调用。

如果API开发者已完成授权APP或IAM认证方式的API给应用(详见通过应用授权APP认证方式API通过应用授权IAM认证方式API通过白名单授权IAM认证方式API),则无需再进行本章的相关操作。

约束与限制

  • 专享版中使用IAM认证方式的API必须先通过应用或白名单授权才能调用。
  • 申请API授权时,仅支持通过应用授权的方式,暂不支持白名单授权方式。
  • APP认证方式的API只能授权给APP类型的应用。
  • IAM认证方式的API只能授权给IAM类型的应用。

申请将API授权给应用

使用APP或IAM认证方式的API,在将API授权后,才能进行API调用。授权可以分为API开发者主动授权和API调用者申请授权,本文以API调用者申请授权为例进行介绍。

  1. DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
  1. 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
  2. 单击“调用API > 服务目录”,可查看到所有已发布的API信息。
  3. 单击待绑定应用的API名称,进入API信息页面。
  4. 在“调用信息”页面,单击“申请权限”。
  5. 在申请权限页面,设置使用截止时间、选择应用,然后单击“确认”,完成API的权限申请。

    如果生成API时设置入参位置为Static,则还需设置静态参数值。如果未配置Static参数值,则SDK调用时会使用API入参默认值,API工具调用时会导致缺少Static参数值的报错。

    图1 申请权限

  6. 申请后,需要等待审核中心审核,方可授权成功。
  7. 授权成功后,可以在应用管理详情页面查看已绑定的API。
    • 如果已绑定API列表中包含无需绑定的API,在此API所在行的操作列,单击“解绑”,将无需绑定的API删除。
    • 如果需要调试已绑定的API,单击“测试”,进入调试页面。
    • 如果需要对已绑定的API延长授权时间,单击“续约”。