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

API Gateway:概要

最終更新日:Jan 22, 2025

概要

Alibaba Cloud API Gatewayサービスをご選択いただきありがとうございます。 このドキュメントで説明するAPIを使用して、API Gatewayサービスで関連する操作を実行できます。

これらのインターフェイスを使用する前に、API Gatewayサービスの指示、ユーザー契約、および課金方法を十分に理解していることを確認してください。

用語集

用語

フルネーム

説明

リージョン

-

APIをデプロイするためにAPI Gatewayで選択したリージョン。 バックエンドサービスが配置されているリージョンを選択することを推奨します。

API

-

APIをデプロイし、APIを介して外部にサービスまたはデータを提供するためにAPI Gatewayに入力するAPI。

グループ

APIグループ

APIのグループ。

  • APIを作成およびデプロイするAPIグループ。

  • 各APIグループには、第2レベルのドメイン名と2つのステージがあります。

  • 独立ドメイン名がAPIグループの第2レベルドメイン名にファイルおよび解決された後、独立ドメイン名をAPIグループにバインドする必要があります。

  • 同じグループ内のAPIには、バインドされた独立ドメイン名を使用してアクセスできます。

サブドメイン

-

APIをデプロイするために作成する各APIグループには、第2レベルのドメイン名があります。 独立したドメイン名は、テスト段階でAPIを呼び出すために直接アクセスできる第2レベルのドメイン名に解決する必要があります。

CustomDomain

カスタムドメイン

APIをデプロイするためにバインドする独立したドメイン名。 独立ドメイン名のCNAMEは、APIグループの第2レベルドメイン名に解決する必要があります。独立ドメイン名は、Alibaba Cloudに提出するか、アクセスのために提出する必要があります。 HTTPSサポートの場合、ドメイン名のSSLコンプライアンス証明書をアップロードする必要があります。

段階

-

APIをデプロイするために作成する各APIグループのテストとオンラインの2つのステージ。 手動でステージにリリースされたAPIのみを呼び出すことができます。 デフォルトでは、テスト段階のAPIは、APIグループの第2レベルドメイン名に直接アクセスすることによって呼び出されます。

Signature

バックエンド署名

APIをデプロイするためにAPI Gatewayに付与する認証キー。 APIにバインドされた後、バックエンド署名キーはそれらのAPIに対して即座に有効になります。 APIからリクエストを受信すると、API Gatewayは、バックエンドサービスがAPI Gatewayを認証するために使用する署名情報を運ぶことによって、バックエンドサービスをリクエストします。

TrafficControl

-

APIをデプロイするために選択したスロットリング。 APIにバインドされると、スロットルポリシーはそれらのAPIに対して即座に有効になります。 ポリシーは、API、アプリ、ユーザーの3つのディメンションからのAPI呼び出しを管理します。 スロットリングポリシーの下に特別なスロットリングポリシーを設定できます。 たとえば、アプリまたはユーザーが特別な調整ポリシーでバインドされたAPIを呼び出すと、特別な値に基づいてAPIアクセスに対して調整が実行されます。

Special

特別なスロットル

「Special」は「TrafficControl」の下に設定され、指定されたアプリまたはユーザーに適用される個別の値に基づいて、スロットリングポリシーにバインドされたAPIへのアクセスをスロットリングするために使用されます。

アプリ

-

別のユーザーによってデプロイされたAPIを呼び出すためにIDとして作成するアプリ。 API Gatewayがリクエストを受信すると、AppKeyとAppSecretを使用して署名検証を実行します。

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

API Gatewayは、作成できるAPIグループとAPIの数、およびAPI Gatewayを介して呼び出すことができるAPIに制限を課します。 使用制限の詳細については、「OpenAPI使用制限」をご参照ください。

インタフェース記述セクションでは、先行する文書との競合が発生するたびに、文書内の情報が優先される。