クラウドネイティブ API Gateway の作成 - API Gateway - Alibaba Cloud ドキュメントセンター

基本設定

初回権限付与

システム権限ポリシー：

AliyunServiceRoleForNativeApiGw：Container Service for Kubernetes (ACK)、Virtual Private Cloud (VPC)、Server Load Balancer (SLB)、Microservices Engine (MSE) などの他の Alibaba Cloud サービスへのアクセスを許可します。

AliyunServiceRolePolicyForNativeApiGwInvokeFC：Function Compute (FC) サービスへのアクセスを許可します。

Cloud-native API Gateway コンソールにログインします。左側のナビゲーションペインで、インスタンス をクリックします。インスタンスページで、Instance Creation をクリックします。 Cloud-native API Gateway 購入ページで、次のパラメーターを設定します。

[プロダクトタイプ]: Pay-as-you-go または サブスクリプション を選択します。「課金の概要」をご参照ください。
- 従量課金：時間単位で課金されます。1 時間未満の使用は 1 時間に切り上げられ、毎時間請求が決済されます。
- サブスクリプション：月単位で課金されます。年間サブスクリプションは 12 か月に相当します。
[Region]：バックエンドサービスが存在するリージョンを選択します。リージョンは作成後に変更できません。
[Gateway Name]：任意の名前を入力します (最大 64 文字)。環境とビジネスドメインを組み合わせた名前 (test や order-prod など) を使用してください。

[GatewaySpec]：容量評価を実施し、ビジネス要件に基づいてノード仕様を選択します。

各ノード仕様の容量しきい値

SLA 保証を維持するには、容量メトリクスを警告のしきい値未満に保ってください。コアビジネスワークロードの場合は、より高い安定性を確保するため、安全なしきい値未満に抑えることを推奨します。

安全なしきい値：トラフィックが 2 倍になっても、ゲートウェイは高いスループットと低レイテンシを維持します。
警告のしきい値：このレベルを超えると、トラフィックの急増時にゲートウェイのレイテンシが増加し、安定性リスクが生じる可能性があります。
シングルノードゲートウェイには SLA 保証がなく、テスト専用です。本番環境のワークロードには、マルチノード仕様が必要です。

ゲートウェイ仕様	クライアント接続数		新規 HTTPS 接続数		CPU 使用率		メモリ使用量
ゲートウェイ仕様	安全しきい値	警告しきい値	安全しきい値	警告しきい値	安全しきい値	警告しきい値	安全しきい値	警告しきい値
`apigw.dev.x1`	12,000	24,000	400	800	30%	60%	75%	75%
`apigw.small.x1`	24,000	48,000	800	1,600	30%	60%	75%	75%
`apigw.small.x2`	48,000	96,000	1,600	3,200	30%	60%	75%	75%
`apigw.small.x4`	96,000	192,000	3,200	6,400	30%	60%	75%	75%
`apigw.medium.x1`	192,000	384,000	6,400	12,800	30%	60%	75%	75%
`apigw.medium.x2`	384,000	768,000	12,800	25,600	30%	60%	75%	75%
`apigw.medium.x3`	576,000	1,152,000	19,200	38,400	30%	60%	75%	75%
`apigw.large.x1`	768,000	1,536,000	25,600	51,200	30%	60%	75%	75%
`apigw.large.x2`	1,536,000	3,072,000	51,200	102,400	30%	60%	75%	75%
`apigw.large.x3`	2,304,000	4,608,000	76,800	153,600	30%	60%	75%	75%
`apigw.large.x4`	3,072,000	6,144,000	102,400	204,800	30%	60%	75%	75%

[リソースグループ]: 既存のリソースグループを選択するか、デフォルトを使用します。リソースグループを使用すると、リソース、権限、およびモニタリングを一元的に管理できます。作成するには、リソースグループの作成 をクリックします。
[Network Type]：インターネット、Private Network、または[パブリック + プライベートネットワーク]を選択できます。
- [インターネット]：パブリックネットワークアクセスでは、BGP (マルチ ISP) モデルで Cloud Data Transfer (CDT) を通じて課金されるトラフィック料金が発生します。詳細については、「パブリックネットワークトラフィック」をご参照ください。
- [Private Network]：プライベートネットワーク経由のアクセスではトラフィック料金は発生しません。
- パブリック + プライベートネットワーク：パブリックアクセスでは CDT トラフィック料金 (BGP マルチ ISP モデル) が発生します。プライベートアクセスは無料です。
[VPC]：ゲートウェイが実行される VPC を選択します。ゲートウェイとバックエンドサービスは同じ VPC を共有する必要があります。
アベイラビリティーゾーンの選択：[自動割り当て] または [手動選択] を選択します。
- 自動割り当て：ゲートウェイノード用の vSwitches を選択します。システムは、2 つのアベイラビリティゾーンにわたってノードを自動的にデプロイします。
- 手動選択: ゲートウェイノードの アベイラビリティゾーン と vSwitches を手動で選択します。

[今すぐ購入] をクリックし、[注文の確認] ページで設定を確認して、Open now をクリックします。

ゲートウェイインスタンスの作成には 1 ~ 5 分かかります。
インスタンス ページで、インスタンスのステータスが 実行中 であることを確認します。

高度な機能

インスタンスの作成時に高度な機能を設定すると、ログ分析または Gzip 圧縮を有効にできます。Gzip ハードウェアアクセラレーションは作成時にのみ有効にできます。ログサービスはいつでも有効にできます。

Gzip ハードウェアアクセラレーションの有効化

Gzip ハードウェアアクセラレーションは、データの圧縮と展開を専用ハードウェアにオフロードし、CPU 負荷を低減して処理効率を向上させます。

操作手順

購入ページで基本設定を完了し、次の追加パラメータを設定します。その後、Open now をクリックします。
- Region：Gzip ハードウェアアクセラレーションは、次のリージョンで利用できます： China (Hangzhou)、China (Beijing)、China (Shanghai)、China (Shenzhen)、China (Ulanqab)、香港 (中国)、Singapore。
  
  サポート対象リージョン内でも、一部のアベイラビリティーゾーンでは本機能をサポートしていない場合があります。利用可否は、製品の購入ページに表示されるオプションによって決まります。
- GatewaySpec： apigw.medium.x1 以上の仕様を選択します。
- [Gzip ハードウェアアクセラレーション]：チェックボックスをオンにして、Gzip ハードウェアアクセラレーションを有効にします。
インスタンスの作成後、インスタンス名または ID をクリックして詳細ページに移動します。左側のナビゲーションペインで Parameters をクリックします。Gateway Engine Parameters セクションで、 EnableGzipHardwareAccelerate パラメータを編集します。

購入時に [Gzip ハードウェアアクセラレーション] のチェックボックスをオンにしなかった場合、この設定を有効にできません。
この機能を有効にした後、クライアントは Gzip 圧縮データを処理できる必要があります。また、リクエストに Accept-Encoding: gzip ヘッダーを含める必要があります。

パフォーマンスの参考値

Gzip によるトラフィック削減

Gzip の圧縮率 (圧縮後サイズ / 元のサイズ) はデータ特性に依存します。比率が低いほど圧縮効果が高くなります。

繰り返しパターン (文字、単語、句読点) を含むテキストは圧縮されやすく、圧縮率が低くなります。一方、エントロピーの高いデータ (画像、動画、すでに圧縮されたファイル) は圧縮率が高く、効果は限定的です。

コアリージョンで Gzip を有効にしたインスタンスの本番データでは、多くのケースで圧縮率が 10%～50% となり、平均で 50% を超えるトラフィックを削減しています。

ハードウェアアクセラレーションによるリソース削減

次のストレステストでは、同一の QPS を処理する場合において、ハードウェア Gzip を使用するシングルノードインスタンスと、ソフトウェア Gzip を使用する 4 ノードクラスター内の 1 ノードあたりの CPU 使用率を比較します。

この例では、圧縮対象データは約 120 KB の JSON テキストファイルです。

QPS	CPU 使用率 (ハードウェア Gzip)	CPU 使用率 (ソフトウェア Gzip、1 ノードあたり)
2,000	9%	11%
5,000	26%	28%
10,000	56%	56%
13,000	69%	72%

Gzip ハードウェアアクセラレーション有効化/単一ノード の CPU 使用率は ソフトウェア Gzip/4 ノード と同等で、インスタンスリソースを約 75% 節約します。

ゲートウェイログの配信の有効化

インスタンスの作成時に Simple Log Service (SLS) を有効にすると、ゲートウェイログを収集、保存、分析できます。

基本設定の設定中に、[Use Simple Log Service (SLS)] のチェックボックスをオンにします。システムが SLS を自動的にプロビジョニングし、ゲートウェイログの配信機能を有効にします。

ログの配信を有効にした後、 Observation and Analysis > Logs に移動してゲートウェイログを確認できます。

ログフィールドの説明

フィールド名	タイプ	説明
__time__	long	ログが生成された時間。
cluster_id	string	購入したゲートウェイインスタンス。
ai_log	json	Model API、Agent API、および MCP API 用に設計されたログフィールド。フィールドは JSON フォーマットです。このフィールドは、他のタイプの API では空です。 api: AI API の名前。 cache_status: Model API でコンテンツキャッシュが有効になっている場合、このフィールドはリクエストがキャッシュにヒットしたかどうかを示します。 consumer: コンシューマー認証が有効になっている場合、このフィールドは現在のリクエストのコンシューマーの ID を記録します。 fallback_from: Model API でフォールバックポリシーが有効になっている場合、このフィールドはリクエストがフォールバックしたルートを記録します。 input_token: LLM リクエストの入力トークン数。 llm_first_token_duration: LLM リクエストの最初のパケットの応答時間 (RT)。 llm_service_duration: LLM リクエストの全体的な RT。 model: LLM リクエストのモデル名。 output_token: LLM リクエストの出力トークン数。 response_type: ストリーミングや非ストリーミングなど、LLM リクエストの応答タイプ。 safecheck_status: LLM リクエストの Content Moderation ステータス。 token_ratelimit_status: LLM リクエストがトークンベースのレート制限によってブロックされたかどうかを示します。
authority	string	リクエストメッセージの Host ヘッダー。
bytes_received	long	ヘッダーを除くリクエストボディのサイズ。
bytes_sent	long	ヘッダーを除く応答本文のサイズ。
downstream_local_address	string	ゲートウェイ Pod のアドレス。
downstream_remote_address	string	ゲートウェイに接続するクライアントのアドレス。
duration	long	リクエストの処理にかかった合計時間。これは、ゲートウェイがダウンストリームサービスから最初のバイトを受信してから、応答の最後のバイトを送信するまでの期間です。単位: ミリ秒。
method	string	HTTP メソッド。
path	string	HTTP リクエストのパス。
protocol	string	HTTP プロトコルのバージョン。
request_duration	long	ゲートウェイがダウンストリームサービスから最初のバイトを受信してから、ダウンストリームサービスから最後のバイトを受信するまでの期間。単位: ミリ秒。
request_id	string	ゲートウェイは各リクエストの ID を生成し、それを `x-request-id` ヘッダーに含めます。バックエンドはこのフィールドをロギングとトラブルシューティングに使用できます。
requested_server_name	string	SSL 接続に使用されるサーバー名。
response_code_details	string	応答コードに関する追加情報を提供します。たとえば、`via_upstream` は応答コードがバックエンドサービスによって返されたことを示し、`route_not_found` はリクエストに一致するルートが見つからなかったことを示します。
response_tx_duration	long	ゲートウェイがアップストリームサービスから最初のバイトを受信してから、ダウンストリームサービスに最後のバイトを送信するまでの期間。単位: ミリ秒。
route_name	string	ルート名。
start_time	string	リクエストが開始された時間。フォーマット: UTC。
trace_id	string	トレース ID。
upstream_cluster	string	アップストリームクラスター。
upstream_host	string	アップストリーム IP アドレス。
upstream_local_address	string	アップストリームサービスへの接続に使用されるローカルアドレス。
upstream_service_time	long	アップストリームサービスがリクエストを処理するのにかかった時間 (ミリ秒単位)。これには、ゲートウェイがアップストリームサービスにアクセスするためのネットワーク遅延と、アップストリームサービス自体の処理時間が含まれます。
upstream_transport_failure_reason	string	アップストリームサービスへの接続が失敗した理由。
user_agent	string	HTTP リクエストの User-Agent ヘッダー。
x_forwarded_for	string	HTTP リクエストの `x-forwarded-for` ヘッダー。このヘッダーは通常、HTTP クライアントの送信元 IP アドレスを示します。

次のステップ

クラウドネイティブ API Gateway は、REST API、HTTP API、WebSocket API など、複数の API タイプをサポートしています。API タイプごとに、ルーティングルールとポリシーを柔軟に設定できます。
サービスを作成してバックエンドサービスをゲートウェイに追加すると、ゲートウェイがエンドポイントを検出し、一元的に管理します。
HTTP API を使用したコンテナサービス内アプリケーションの公開
よくある質問