すべてのプロダクト
Search
ドキュメントセンター

API の管理

最終更新日: Mar 20, 2020
API 定義とは、API を作成するときの API リクエスト構造に関連する定義のことです。 コンソール上で API 定義を作成、閲覧、編集、削除、またはコピーすることができます。 API を定義する際、次の点にご注意ください
  1. デプロイ(公開)済み API の定義を編集しても、ステージ(環境)にデプロイしない限り、ステージ(環境)の定義には影響しません。
  2. 直接デプロイ(公開)済み API を削除することはできません。 削除する前に API をアンデプロイ(非公開)にしてください。
  3. テストステージ(環境)や本番ステージ(環境)から定義をコピーしてカレントの定義を上書きすることができます。その後、必要に応じて編集をクリックして定義を変更できます。

API のデプロイ(公開)管理

次の点を考慮して、テストステージ(環境)または本番ステージ(環境)で API をデプロイ(公開)またはアンデプロイ(非公開)できます。

  1. サブドメイン名または独自ドメイン名にアクセスして、テストステージまたは本番ステージに公開された API を呼び出すことができます。
  2. 公開 API の最新バージョンは、テストステージまたは本番ステージの前のバージョンを上書きし、リアルタイムに反映されます。
  3. テストステージまたは本番ステージで API をアンデプロイ(非公開)にすると、API がプロダクト環境に再び公開されない限り、バインドされているポリシー、鍵、アプリ、および権限は自動的に非公開となります。 この関係を取り消すには、それを削除する必要があります。

API の権限管理

API およびアプリとの間の権限関係を確立または取り消すことができます。 API Gateway は権限の関係を検証します。 権限付与の際には、次の点に注意してください。

  1. 1 つまたは複数のアプリに 1 つまたは複数の API の権限を付与することができます。 バッチ処理の際は、同時に複数のグループに属する API を操作しないことをお勧めします。
  2. バッチ操作の際は、API と関連するステージを選択します。 たとえば、テストステージおよび本番ステージの両方に API がデプロイされ、テストステージのみが選択された場合、テストステージの API のみが承認されます。
  3. ユーザーの提供する AppID または AlibabaCloud アカウントID よりアプリを特定できます。
  4. API 下のアプリの権限を解除する必要がある場合は、API の承認リストを表示してリストからアプリの承認を取り消します。

デプロイ(公開)履歴およびバージョンの切り替え

バージョン番号、説明、テストや本番、デプロイの時間など、各 API のデプロイ履歴を表示できます。

デプロイ履歴を表示して、バージョンを選択してそのバージョンに切り替えることができます。 新しいバージョンは直前のバージョンを直接上書きし、すぐに反映されます。