API 権限付与機能は、アプリケーションに API の呼び出し権限を付与するために使用されます。アプリケーションは、API を呼び出すために使用される ID です。アプリケーションを使用して API を呼び出すには、事前に権限が付与されている必要があります。
前提条件
API 認証方式は Alibaba Cloud App です。
アプリケーション
アプリケーションは、API を呼び出すために使用される ID です。各アプリケーションには、AppKey と AppSecret で構成されるキーペアがあります。アプリケーションを使用して API を呼び出す場合、アプリケーションの AppKey をリクエストのヘッダーとして指定し、AppSecret を使用して計算した署名文字列をリクエストにアタッチする必要があります。署名を計算して渡す方法の詳細については、「ダイジェスト認証を使用して API を呼び出す」をご参照ください。
アプリケーションの AppKey と AppSecret のペアを取得した人は誰でも、そのアプリケーションに対するすべての権限を持ちます。AppKey と AppSecret のペアは機密情報として保持する必要があります。誤って AppKey と AppSecret のペアを漏洩した場合は、API Gateway コンソールでペアをリセットできます。
必要に応じて複数のアプリケーションを作成し、異なる API を呼び出す権限を付与できます。API の呼び出し権限を付与できるのは、Alibaba Cloud アカウントではなく、アプリケーションのみであることに注意してください。
API Gateway コンソールでは、アプリケーションの作成、変更、削除、アプリケーションの詳細の表示、キーペアの管理、およびアプリケーションが呼び出すことを許可されている API の表示ができます。
アプリケーションに新しい AppKey と AppSecret のペアを追加し、追加されたキーペアをアプリケーションの詳細ページで表示できます。新しい各キーペアは、アプリケーションに対するすべての権限を持ちます。追加したキーペアが不要になった場合は、そのキーペアを削除することもできます。ただし、アプリケーション作成時に生成されるデフォルトのキーペアは削除できません。
アプリケーションの作成
API Gateway コンソールにログインし、左側のナビゲーションウィンドウで を選択してから、右上隅にある [アプリの作成] をクリックします。
[アプリの作成] ダイアログボックスで、[アプリ名] パラメーターを設定し、[確認] をクリックします。
アプリケーションの作成時に、オプションでアプリケーションタグの設定、AccessKey 情報のカスタマイズ、および [拡張フィールド] の設定ができます。
タグの設定: タグを使用してアプリケーションをマークします。
AccessKey 情報のカスタマイズ: アプリケーション用にカスタムの AccessKey ペアと AppCode を作成できます。アプリケーションの作成後に、カスタムの AccessKey ペアと AppCode を変更することもできます。変更はすぐに有効になります。
拡張フィールド: アプリケーションに拡張フィールドを設定できます。システムは、拡張フィールドを CaAppExtInfo という名前のシステムパラメーターとしてバックエンドサービスに渡します。
重要2023 年 8 月より前に購入した専用型インスタンスの場合、拡張フィールドが有効にならない場合は、チケットを送信してインスタンスをスペックアップする必要があります。
アプリケーションの無効化
API Gateway コンソールにログインし、左側のナビゲーションウィンドウで を選択します。
対象のアプリケーションをクリックして [アプリケーションの詳細] ページに移動し、右上隅にある [アプリ認証の無効化] をクリックします。
説明アプリケーションを無効にすると、このアプリケーションに権限が付与されている API は、このアプリケーションでは呼び出せなくなります。アプリケーションを再度有効にすると、引き続き API を呼び出すことができます。
重要2025 年 7 月より前に購入した専用型インスタンスの場合、アプリケーションの無効化機能が有効にならない場合は、チケットを送信してインスタンスをスペックアップする必要があります。
API 権限付与
アプリケーションは、API を呼び出すために使用される前に権限を付与される必要があります。権限を付与されたアプリケーションのみが API を呼び出すことができます。
独自のアプリケーションと API を作成した場合、コンソールで直接アプリケーションに API の呼び出し権限を付与できます。
Alibaba Cloud Marketplace から API を購入した場合、購入した API を呼び出す権限をアプリケーションに付与できます。アプリケーションがない場合、Alibaba Cloud Marketplace は購入時に権限が付与されたアプリケーションを作成します。詳細については、Alibaba Cloud Marketplace コンソールにアクセスしてください。
別の Alibaba Cloud アカウントの API を呼び出す場合、API 権限付与は、API プロバイダーとも呼ばれるそのアカウントによって実行される必要があります。アプリケーションを作成し、そのアプリケーションの ID を API プロバイダーに提供する必要があります。その後、API プロバイダーはアプリケーション ID を使用してアプリケーションを検索し、API を呼び出す権限をアプリケーションに付与できます。
手順
API Gateway コンソールにログインし、左側のナビゲーションウィンドウで を選択し、API の [アクション] 列で
> [承認] を選択します。
承認ページで、[承認する環境の選択]、[承認有効期間]、および [承認するアプリケーションの選択] を選択します。[マイアプリ] で [検索] を直接クリックすると、アカウント配下のアプリケーションが自動的に読み込まれます。
別のアカウントに属するアプリケーションを承認する場合は、[承認するアプリの選択] ドロップダウンリストから [App ID] を選択し、アプリケーションの ID を入力して [検索] をクリックします。アプリケーションが表示されます。
重要2023 年 11 月より前に購入した専用型インスタンスで、アプリケーションに追加された新しいキーペアが有効にならない場合は、チケットを送信してインスタンスをスペックアップする必要があります。アプリケーションの作成時に生成されるデフォルトのキーペアは、バージョンの制限を受けません。