DataWorks:API呼び出し権限の付与

「APIの管理」ページへの移動

1. DataWorks コンソールにログインします。 左側のナビゲーションウィンドウで、[DataService Studio] をクリックします。 表示されるページで、ドロップダウンリストから目的のワークスペースを選択し、[DataService Studioに移動] をクリックします。

2. トップメニューバーで Service Management をクリックして、Manage APIs ページに移動します。

API呼び出し権限の付与

1. Published APIs タブで、目的の API を見つけ、承認 をクリックします。

2. API Authorization ダイアログボックスで、パラメーターを設定します。

   権限を付与すると、対象のワークスペースのメンバーは [APIの管理] > [自分に権限付与された API] タブで API を表示し、ワークスペースの AppCode または AppKey と AppSecret を使用して呼び出すことができます。権限付与を管理または取り消すには、[APIの管理] > [他者に権限付与した API] タブに移動し、[権限管理] をクリックします。他の認証情報を追加するには、API Gateway コンソールに移動し、[API呼び出し] > [アプリケーション管理] に移動して新しいアプリケーションを作成し、権限を付与します。注意：API を公開停止または削除すると、既存の権限は無効になります。これらの操作は慎重に行ってください。

   パラメーター	説明
   [API Name]	呼び出し権限を付与する対象の API 名です。このパラメーターの値は変更できません。
   [Tenant Account ID]	API の呼び出し権限を付与する対象となる Alibaba Cloud アカウントの ID です。[セキュリティ設定] ページで表示できます。
   [Authorized Workspace]	API の呼び出し権限を付与する対象のワークスペース名です。ドロップダウンリストから、現在の Alibaba Cloud アカウントに属するワークスペースを選択できます。
   [Authorization Validity Period]	API 呼び出し権限の有効期間には、LimitedとUnlimitedがあります。 [Limited]: 有効期限を選択する必要があります。この日付まで API を呼び出すことができます。 [Unlimited]: Unlimited を選択すると、API を呼び出す永続的な権限が付与されます。

3. Confirm をクリックします。

   Published APIs タブでは、次の操作も実行できます。

   • API の横にあるオフラインをクリックします。Unpublish API ダイアログボックスで、Confirmをクリックします。

     説明

     • API の呼び出し権限をワークスペースに付与した後に API を公開停止または削除した場合、そのワークスペースは API を呼び出せなくなります。

     • API を公開停止または変更した後に再公開した場合、対象のワークスペースに API の呼び出し権限を再度付与する必要があります。

   • API の横にあるテストをクリックすると、[API テスト] ページに移動します。 詳細については、「API をテストする」をご参照ください。

   • API の横にある More にカーソルを合わせ、Change Protocol をクリックします。Change Protocol ダイアログボックスで、新しい API プロトコルを設定し、Confirm をクリックします。

     説明

     • プロトコルを削除すると、そのプロトコルを使用して API を呼び出すことはできなくなります。この操作は慎重に行ってください。

     • プロトコルの変更はリアルタイムで有効になります。

呼び出し権限を付与されたAPIの表示

Manage APIs ページで、Authorized to Use タブをクリックすると、使用が承認されたすべての API を表示できます。

他のワークスペースに権限を付与したAPIの表示

Manage APIs ページで Authorize Others to Use タブをクリックすると、他者に認可したすべての API が表示されます。

APIの権限付与機能

API の権限付与機能は、アプリケーションに API の呼び出し権限を付与するために使用されます。アプリケーションは、API を呼び出すために使用される ID です。API を呼び出すには、アプリケーションに API の呼び出し権限を付与する必要があります。デフォルトでは、ワークスペースでの API 呼び出しにおけるユーザー ID 認証には、DataWorks の DataService Studio でサポートされている Alibaba Cloud APP が使用されます。DataWorks の DataService Studio は、ワークスペースと同じ名前のアプリケーションに、そのワークスペース内の API を呼び出す権限を付与します。この場合、呼び出し元は、アプリケーションの AppCode、AppKey、AppSecret を使用して、安全に API を呼び出すことができます。詳細については、「APIの呼び出し」をご参照ください。

API を呼び出す際に、呼び出し元を識別・区別する方法や、呼び出しを認証するための認証情報を適切に割り当てる方法など、特定の問題が発生する可能性があります。このセクションでは、ビジネス要件に基づき、さまざまなシナリオで、異なる粒度で DataService Studio の API を呼び出す権限を付与する方法について説明します。

シナリオ1：DataWorks ワークスペース内のメンバーが同じアプリケーションを使用して API を呼び出す

シナリオ2：各 RAM ユーザーが、その RAM ユーザーに属する個別のアプリケーションを使用して API を呼び出す

シナリオ3：同じグループ内の RAM ユーザーが同じアプリケーションを使用して API を呼び出す