文档

授权API

更新时间:

在API发布后,您可以将API授权给他人,或获取他人已授权的API,以实现数据共享。本文为您介绍如何对API进行授权及不同场景下API的授权方案。

前提条件

仅支持对已发布的API进行下线、授权和变更协议等操作,详情请参见发布API

进入API管理页面

  1. 登录DataWorks控制台,单击左侧导航栏的数据服务,在下拉框中选择对应工作空间后单击进入数据服务

  2. 单击页面顶部菜单栏的服务管理,进入API管理页面。

授权API

  1. 发布的API页签下,单击相应API后的授权

  2. API授权对话框中,配置各项参数。

    API授权

    参数

    描述

    API名称

    待授权API的名称,默认不可以修改。

    要授权的云账号ID

    需要获得当前API调用权限的阿里云账号ID。您可以在账号管理页面查看。

    要授权的工作空间

    在下拉列表中选择当前阿里云账号下,待授权的工作空间名称。

    授权有效期

    调用API权限的有效期,包括短期长期

    • 短期:您需要选择截止日期,在该日期前均有权调用API。

    • 长期:选中长期后,永久有权调用API。

  3. 单击确认

    您还可以在发布的API页签,进行以下操作:

    • 单击相应API后的下线,在下线API服务对话框中,单击确认,下线当前API。

      说明
      • 如果已授权的API被下线或删除,则获得授权的工作空间将无法继续调用该API。

      • 如果已授权的API被下线或修改后重新发布,则需要API的负责人对新发布的API重新授权。

    • 单击相应API后的测试,进入API测试页面测试API。详情请参见测试API

    • 鼠标悬停至相应API后的更多,单击协议变更。在API协议变更对话框中,设置变更后的API协议,单击确认

      说明
      • 如果您删除了原有协议,则原有协议的接口会调用失败,请谨慎操作。

      • 协议变更实时生效。

查看获得授权的API

API管理页面,单击获得授权的API,查看所有获得授权的API。

您可以对获得授权的API进行以下操作:

  • 单击相应API后的测试,进入API测试页面测试API。详情请参见测试API

  • 单击相应API后的删除,在删除授权对话框中,单击确认

查看授权给他人的API

API管理页面,单击授权给他人的API,查看所有授权给他人的API。

您可以对已授权的API进行以下操作:

  • 单击相应API后的测试,进入API测试页面测试API。详情请参见测试API

  • 单击相应API后的授权管理。在API授权管理对话框中,取消或修改相应工作空间的授权。

API授权方案

API授权是指应用(APP)与API建立授权关系。应用(APP)是调用API时的身份,应用(APP)需要获得API的授权才能调用该API。DataWorks数据服务默认会对工作空间下的API添加“阿里云APP认证”的认证方式,并授权给与工作空间同名的应用(APP)(详情请参见查看API调用的认证信息),这样一来,调用方即可使用获得授权的应用(APP)下的AppCode或AppKey&Secret来安全地调用API。

调用API的过程中,常见问题包括:如何标识及区分调用流量的来源、如何合理分配调用鉴权的身份认证信息等。以下将从不同场景及需求来说明如何对数据服务API进行不同粒度的授权。

场景一、相同DataWorks工作空间下的成员,共同使用同一个应用(APP)来调用API

场景1

场景二:每个RAM账号,分别使用各自账号的应用(APP)来调用API

场景2

场景三:多个RAM账号为一组,每组RAM账号共同使用一个应用(APP)来调用API

场景3

  • 本页导读 (1)
文档反馈