APIを公開した後、他のワークスペースにAPIを呼び出す権限を付与したり、ワークスペースが呼び出し権限を付与されているAPIを表示してデータ共有を実装したりできます。このトピックでは、さまざまなシナリオでAPIを呼び出すために必要な権限を付与する方法について説明します。
前提条件
APIは、公開された後にのみ、公開の取り消し、アクセス権限の付与、またはプロトコルの変更を行うことができます。詳細については、「API の公開」をご参照ください。
API管理ページに移動する
DataWorksコンソールにログオンします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションペインで、 を選択します。表示されるページで、ドロップダウンリストから目的のワークスペースを選択し、[dataservice Studioに移動] をクリックします。
DataService Studioページの上部ナビゲーションバーで、[サービス管理] をクリックします。[公開済み API] タブが表示されます。
APIを呼び出す権限を付与する
[公開済み API] タブで、目的のAPIを見つけ、[アクション] 列の [承認] をクリックします。
[API 認証] ダイアログボックスで、パラメーターを設定します。
パラメーター
説明
API名
ワークスペースに呼び出し権限を付与するAPIの名前。このパラメーターの値は変更できません。
テナントアカウント ID
APIの呼び出し権限を付与するAlibaba CloudアカウントのID。アカウントセンターの セキュリティ設定 ページに移動して、アカウントIDを確認できます。
承認済みワークスペース
APIの呼び出し権限を付与するワークスペースの名前。ドロップダウンリストから、現在のAlibaba Cloudアカウントに属するワークスペースを選択できます。
有効期間
API呼び出し権限の有効期間。有効な値：[制限付き] および [無制限]。
[制限付き]：有効期限を選択する必要があります。ワークスペースは、有効期限が切れる前にのみAPIを呼び出すことができます。
[無制限]：ワークスペースはAPIを[永続的に] 呼び出すことができます。
[OK] をクリックします。
[公開済み API] タブでは、次の操作も実行できます。
目的のAPIを見つけ、[アクション] 列の [公開の取り消し] をクリックします。[APIの公開を取り消しますか？] メッセージで、[OK] をクリックしてAPIの公開を取り消します。
説明ワークスペースにAPIの呼び出し権限を付与した後にAPIの公開を取り消したり削除したりすると、ワークスペースはAPIを呼び出すことができなくなります。
APIの公開を取り消しまたは変更した後にAPIを再公開する場合は、関連するワークスペースにAPIの呼び出し権限を再度付与する必要があります。
目的のAPIを見つけ、[アクション] 列の [テスト] をクリックして、[APIのテスト] ページでAPIをテストします。詳細については、「API のテスト」をご参照ください。
目的のAPIを見つけ、[詳細] にポインターを移動し、[プロトコルの変更] を選択します。[プロトコルの変更] ダイアログボックスで、APIで使用されるプロトコルを変更し、[OK] をクリックします。
説明プロトコルを削除すると、そのプロトコルを使用してAPIを呼び出すことができなくなります。この操作を実行する際は注意してください。
プロトコルの変更はリアルタイムで有効になります。
ワークスペースに呼び出し権限が付与されている API を表示する
[APIの管理] ページで、[使用が承認済み] タブをクリックして、ワークスペースに呼び出し権限が付与されているAPIを表示します。
ワークスペースに呼び出し権限が付与されているAPIに対して、次の操作を実行できます。
目的のAPIを見つけ、[アクション] 列の [テスト] をクリックして、[APIのテスト] ページでAPIをテストします。詳細については、「API のテスト」をご参照ください。
目的のAPIを見つけ、[アクション] 列の [削除] をクリックします。[承認済みを削除] メッセージで、[OK] をクリックします。
他のワークスペースに呼び出し権限を付与した API を表示する
[APIの管理] ページで、[他のユーザーに使用を承認] タブをクリックして、他のワークスペースに呼び出し権限を付与したAPIを表示します。
他のワークスペースに呼び出し権限を付与したAPIに対して、次の操作を実行できます。
目的のAPIを見つけ、[アクション] 列の [テスト] をクリックして、[APIのテスト] ページでAPIをテストします。詳細については、「API のテスト」をご参照ください。
目的のAPIを見つけ、[アクション] 列の [管理] をクリックします。[認証] ダイアログボックスで、[アクション] 列の [失効] または [変更] をクリックして、APIに対するワークスペースの権限を取り消しまたは変更します。
API認証機能
API認証機能は、アプリケーションにAPIを呼び出す権限を付与するために使用されます。アプリケーションは、APIを呼び出すために使用されるIDです。APIを呼び出すには、アプリケーションにAPIを呼び出す権限を付与する必要があります。デフォルトでは、DataWorks DataService StudioでサポートされているAlibaba Cloud APPが、ワークスペースでのAPI呼び出し中のユーザーID認証に使用されます。DataWorks DataService Studioは、ワークスペースと同じ名前のアプリケーションに、ワークスペース内のAPIを呼び出す権限を付与します。この場合、呼び出し側は、アプリケーションのAppCode、AppKey、およびAppSecretを使用して、安全な方法でAPIを呼び出すことができます。詳細については、「API を呼び出すための認証情報を表示する」をご参照ください。
APIを呼び出すときに、呼び出し元の識別と区別方法、呼び出しを認証するための認証情報の適切な割り当て方法など、特定の問題が発生する可能性があります。このセクションでは、ビジネス要件に基づいて、さまざまなシナリオでさまざまな粒度でDataService Studio APIを呼び出す権限を付与する方法について説明します。
シナリオ 1：DataWorksワークスペースのメンバーが同じアプリケーションを使用して API を呼び出す
シナリオ 2：各 RAM ユーザーが、RAM ユーザーに属する個別のアプリケーションを使用して API を呼び出す
シナリオ 3：同じグループの RAM ユーザーが同じアプリケーションを使用して API を呼び出す
