API 権限付与は、アプリケーションと API の間の関係を確立します。アプリケーションは API を呼び出すために使用される ID であり、その API を呼び出すには権限が付与されている必要があります。
前提条件
API 認証方式が Alibaba Cloud アプリケーション認証に設定されていること。
アプリケーション
アプリケーションは、API を呼び出すために使用される ID です。デフォルトでは、各アプリケーションには AppKey と AppSecret で構成されるキーペアがあります。AppKey はリクエストヘッダーのパラメーターとして渡す必要があり、AppSecret はリクエスト署名の計算に使用されます。署名の計算方法と渡し方の詳細については、「ダイジェスト認証を使用した API の呼び出し」をご参照ください。
-
AppKey と AppSecret のキーペアは、アプリケーションに完全な権限を付与します。安全に保管してください。キーペアが漏洩した場合は、API Gateway コンソールでリセットできます。
-
ビジネスニーズに応じて、複数のアプリケーションを作成し、それぞれに異なる API の呼び出し権限を付与できます。API の権限は Alibaba Cloud アカウントではなく、アプリケーションに対して付与されることにご注意ください。
-
API Gateway コンソールでは、アプリケーションの作成、変更、削除、詳細の表示、キーの管理、および権限が付与された API の表示が可能です。
-
アプリケーションの詳細ページから、新しい AppKey と AppSecret のペアを追加できます。新しいキーペアは、アプリケーションのすべての権限を持ち、削除することも可能です。アプリケーション作成時に生成されるデフォルトのキーペアは削除できません。
アプリケーションの作成
-
API Gateway コンソールにログインします。左側のナビゲーションウィンドウで、 を選択し、右上隅の [アプリの作成] をクリックします。
-
[アプリの作成] ページで、[アプリ名] を入力し、[作成] をクリックします。
アプリケーションの作成時に、オプションでタグの設定、カスタム AK 情報の提供、拡張フィールドの設定ができます。
-
タグ設定:タグを使用してアプリケーションを整理します。
-
カスタム AK 情報:アプリケーションの作成時に、カスタムの AppKey と AppCode を定義できます。本番環境のアプリケーションの AppKey と AppCode を変更することもでき、変更は即時に有効になります。
-
拡張フィールド:アプリケーションの拡張フィールドを設定できます。API Gateway はこのフィールドを
CaAppExtInfoシステムパラメーターとしてバックエンドサービスに渡します。重要2023 年 8 月より前に購入した専用インスタンスで、拡張フィールドが有効にならない場合は、チケットを送信してインスタンスバージョンをアップグレードしてください。
アプリケーションの無効化
-
API Gateway コンソールにログインします。左側のナビゲーションウィンドウで、 を選択します。
-
対象のアプリケーションをクリックして [アプリケーション詳細] ページに移動します。その後、右上隅の [アプリ認証を無効にする] をクリックします。
説明無効化されると、アプリケーションは権限が付与された API を呼び出せなくなります。いつでもアプリケーションを再度有効にして、API の呼び出しを再開できます。
重要2025 年 7 月より前に購入した専用インスタンスで、この機能が動作しない場合は、チケットを送信してインスタンスバージョンをアップグレードしてください。
API 権限付与
権限付与とは、アプリケーションに API の呼び出し権限を付与するプロセスです。アプリケーションが API を呼び出すには、事前に権限が付与されている必要があります。
-
自身のアプリケーションに、自身の API を呼び出す権限を直接付与できます。
-
Alibaba Cloud Marketplace から購入した API を呼び出す権限を、自身のアプリケーションに付与できます。アプリケーションをお持ちでない場合、購入プロセス中に Alibaba Cloud Marketplace がアプリケーションを作成し、権限を付与します。詳細については、Alibaba Cloud Marketplace のコンソールにアクセスしてください。
-
オフライン契約を通じてパートナー (別の Alibaba Cloud アカウント) の API を使用するには、アプリケーションを作成し、そのアプリケーション ID をパートナーに提供します。パートナーは、その ID を検索することで、ご利用のアプリケーションに権限を付与できます。
操作手順
-
API Gateway コンソールにログインします。左側のナビゲーションウィンドウで を選択し、対象の API を見つけ、[操作] 列で
> [権限付与] をクリックします。 -
権限付与ページで、[環境] と [権限付与の有効期間] を選択し、[権限を付与するアプリを選択] で権限を付与するアプリケーションを選択します。自身のアカウント内のアプリケーションに権限を付与するには、[マイアプリ] を選択し、[検索] をクリックしてアカウント内のすべてのアプリケーションをロードします。
別のアカウントのアプリケーションに権限を付する場合は、[App ID] を選択して対応するアプリケーション ID をテキストボックスに入力し、[検索] をクリックします。
重要2023 年 11 月より前に購入した専用インスタンスで、新しく追加したキーペアが有効にならない場合は、チケットを送信してインスタンスバージョンをアップグレードしてください。アプリケーション作成時に生成されるデフォルトのキーペアは、インスタンスのバージョンの影響を受けません。