edit-icon download-icon

概要

最終更新日: Aug 13, 2018

Alibaba Cloud API Gateway サービスをお選びいただき、ありがとうございます。本ドキュメントで詳述する API を使って、API Gateway サービスに関連した操作ができます。

インターフェイスを使い始める前に、サービスの手順、ユーザー規約および課金方法をしっかり理解しておきます。

用語集

単語 完全名 説明
リージョン - API のデプロイに選択されたリージョン。バックエンド サービスと同じリージョンを選択することを推奨します。
API - API をデプロイし、API から外部にサービスやデータを提供するために API Gateway に入力する API。
グループ API グループ API の集まり。
  • API を作成し、デプロイする API グループ。
  • 各 API グループには第 2 レベル ドメイン名と 2 つのステージがあります。
  • 独自ドメイン名が認知され、API グループの第 2 レベル ドメイン名に解決されてから、API グループに独自ドメイン名をバインドする必要があります。
  • グループ内の API は、バインドされた独自ドメイン名でアクセスできます。
サブドメイン - API をデプロイするために作成する各 API グループには、第 2 レベル ドメイン名がつきます。独自ドメイン名は第 2 レベル ドメイン名に解決されなければなりません。テスト ステージで直接 API を呼び出すため第 2 レベル ドメイン名にアクセスできます。
カスタム ドメイン カスタム ドメイン API をデプロイするためにバインドする独自ドメイン名。独自ドメイン名の CNAMEは、API グループの第 2 レベル ドメイン名に名前解決されなければなりません。また、独自ドメイン名は Alibaba Cloud に認知されるか、アクセスできるよう認知させる必要があります。HTTPS に対応させるには、ドメイン名の SSL 対応の証明書をアップロードしなければなりません。
ステージ - API をデプロイするために作成した各 API グループのテストおよびオンラインの 2 つのステージ。手動でステージにリリースされた API のみ呼び出し可能です。デフォルトでは、テスト ステージの API を呼び出すには、API グループの第 2 レベル ドメイン名に直接アクセスします。
署名 バックエンド署名 API をデプロイするために API Gateway に付与する認証鍵。API にバインドされると即座にバックエンド署名鍵は有効になります。API からリクエストを受け取ると、API Gateway は、署名情報を格納してバックエンド サービスにリクエストします。署名情報は API Gateway の認証にバックエンド サービスが使用します。
スロットリング - API のデプロイに選択したスロットリング。API にバインドされた後、スロットリング ポリシーは即座に API に反映されます。ポリシーは、API、アプリ、ユーザーの 3 つのディメンションで API 呼び出しを管理します。スロットリング ポリシー下にスペシャル スロットリング ポリシーを設定できます。たとえば、アプリやユーザーがスペシャル スロットリング ポリシーにバインドされた API を呼び出すと、スペシャル値に基づいて API アクセスに対してスロットルされます。
スペシャル スペシャル スロットリング 「スロットリング」で「スペシャル」を設定します。スロットリング ポリシーにバインドされた API へのアクセスをアプリまたはユーザーそれぞれに指定された値に基づいてスロットリングする際に使用します。
アプリ - 他のユーザーがデプロイした API を呼び出すために作成するアプリ。API Gateway はリクエストを受け取ると、AppKey および AppSecret で署名を検証します。

ビジネス制約とタイプ制約

API Gateway は作成する API グループと API の数、および、API Gateway から呼び出すことのできる API には制約があります。使用における制約の詳細については、 Open API の使用制約 および API 呼び出しの制約をご参照ください。

インターフェイスの詳細セクションで、前述のドキュメントと異なる箇所は、本ドキュメントの情報が有効となります。