注釈

制限状態時のAPI呼び出しの無効化と制限開始・終了時の通知バー表示は 2025/06/26 のリリースで導入される予定です。

VCI通信流量制限機能#

VCI通信流量制限とは#

VCI通信流量制限とは、ルーム全体の動作の安定化のために通信量を監視・制限する機能です。 この機能は、クライアントやサーバーの APIの秒間リクエスト数 (RPS : Requests Per Second ) に応じての警告状態や制限状態を表現し、制限状態中は 対象API の呼び出しを無効化し実行しません。

制限の対象#

対象API#

本機能において制限の対象となるのは、以下のネットワーク通信を行うAPIです。

対象の通信#

本機能において制限の対象となるのは以下の通信量です。

通信量の詳細については、通信量の種類と計測方法 をご確認ください。

通信状態#

対象の通信 における各通信量ごとに許容値が設定されています。 この許容値に近づいた場合は警告状態となり、超過すると制限状態となります。 制限状態になると、対象API の呼び出しが無効化される可能性があります。 なお制限状態は一時的なものであり、通信量が低下すると解除されます。

制限状態の挙動#

各通信の制限状態の挙動は以下の通りです。

制限状態

条件

挙動

確認方法

サーバー制限状態

サーバー送信量が許容値を超える

自身が参加するルームの参加者全員の環境において、送信量の多い順にVCIインスタンス単位で対象APIの呼び出しが無効化される可能性がある

VCINetworkPanel のサーバー送信量

クライアント制限状態

クライアントあたりの送信量が許容値を超える

自身のクライアントにおいて、送信量の多い順にVCIインスタンス単位で対象APIの呼び出しが無効化される可能性がある

VCINetworkPanel のクライアントあたりの送信量

VCIインスタンス制限状態

VCIインスタンスあたり送信量が許容値を超える

自身のクライアントにおいて、そのVCIの対象APIの呼び出しを無効化する

VCINetworkPanel のVCIインスタンスあたりの送信量

通信状態の確認方法#

通信の状態や秒間リクエスト数 (RPS) を、以下の方法で確認できます。

VCINetworkPanel#

サーバー送信量や複数VCIの送信量を一覧できる SystemConsole 内の VCINetworkPanel と、特定のVCIインスタンスの送信量を確認できる ItemConsole 内の VCINetworkPanel の2種類があります。 これらのパネルに表示される送信量は、本機能の対象APIの呼び出しによる通信量に限定されます。

SystemConsole 内の VCINetworkPanel#

図3: SystemConsole内VCINetworkPanelの表示例

  • サーバー送信量 : サーバー送信量 (RPS) とサーバーの通信状態（通常:白色、警告状態:黄色、制限状態:赤色）が示されます。

  • クライアントあたりの送信量 : クライアントあたりの送信量 (RPS) とクライアントの通信状態（通常:白色、警告状態:黄色、制限状態:赤色）が示されます。

  • VCIインスタンスあたり送信量 : 送信量の多い順にVCIインスタンスがリストアップされ、各VCIインスタンスの送信量 (RPS) とVCIインスタンスの通信状態（通常:白色、警告状態:黄色、制限状態:赤色）が示されます。

また、　クライアントあたりの送信量（ピーク） と VCIインスタンスあたりの送信量（ピーク） では、自身のルーム入室時またはVCIインスタンス生成時から、現在までの最大送信量が表示されます。この値は SystemConsole を Use することでリセットできます。

ItemConsole 内の VCINetworkPanel#

図4: ItemConsole内VCINetworkPanelの表示例

  • VCIインスタンス送信量 : このVCIインスタンスの送信量と通信状態（通常:白色、警告状態:黄色、制限状態:赤色）が示されます。

また、　VCIインスタンス送信量（ピーク） では、自身のルーム入室時またはVCIインスタンス生成時から、現在までの最大送信量が表示されます。

確認・対応すべき点#

  • 警告状態（黄色）を確認した場合

    • ルーム内に配置したVCIインスタンスの数を見直してください。

    • API呼び出し最適化ガイドを参考にVCIスクリプトを見直してください。

      • VCIインスタンス・クライアントの警告状態の許容値は、デフォルトで 150 RPS に設定されていますが、サーバー負荷により150RPSを下回る可能性があります。そのため、ルーム安定稼働のためにRPS値をできるだけ低く抑えることを目指してください

  • 制限状態（赤色）を確認した場合

    • 制限対象のVCIインスタンスをルームから削除してください。

    • ルーム内に配置したVCIインスタンスの数を見直してください。

    • API呼び出し最適化ガイドを参考にVCIスクリプトを見直してください。

通知バー表示#

制限状態開始時と終了時に、視界の前方に通知バーが表示されることがあります。（警告状態の開始・終了時には表示されません）

制限状態開始時

図5: 制限開始時の通知

制限状態解除時

図6: 制限解除時の通知