サーバー状況
警告: この API ドキュメントは Clanforge 用です。Multiplay Hosting を使用している場合は、Multiplay Hosting API のドキュメント を参照してください。
<serverid> によって識別されるゲームサーバーの状況を取得します。
https://api.multiplay.co.uk/cfp/v1/server/<serverid>/statusメソッド |
| GET |
リクエストパラメーター
| 変数 | 説明 | 任意 |
| serverid | <serverid> パラメーターには、状況を取得するゲームサーバーのゲームサーバー ID を指定します。 | いいえ |
| query_info | <query_info> パラメーターを使用すると、状況に加えてゲームサーバーに関するクエリ情報もリクエストできます。
| はい |
レスポンスフィールド
| フィールド | 型 | 説明 | 任意 |
|---|---|---|---|
| active | integer | アクティビティの状態を表す数値 (0 は停止、1 は起動済み、>=2 は再起動中) | いいえ |
| allocated_uuid | string | このサーバーの現在の割り当ての UUID、ない場合は空の文字列 | いいえ |
| admin_locked | integer | ロック状態を表す数値 (1 はサーバーがメンテナンス中か、ゲームセッションに適さない状態) | いいえ |
| country_code | string | 2 文字の国コード (使用可能な国コードは、サーバーの国 エンドポイントを参照) | いいえ |
| game_port | integer | ゲームサーバーを使用できるポート | いいえ |
| ip | string | ゲームサーバーを使用できる IP アドレス | いいえ |
| locationid | string | ゲームサーバーがある場所の ID | いいえ |
| machineid | integer | ゲームサーバーがあるマシンの ID | いいえ |
| name | string | ゲームサーバーの名前 (通常、作成時に自動的に作成される) | いいえ |
| profileid | integer | サーバーが現在実行しているプロファイルの ID | いいえ |
| query_port | string | ゲームサーバーが SQP などのクエリプロトコルを介してクエリ情報を提供するポート | いいえ |
| serverid | integer | サーバーの ID | いいえ |
| query_info | object | 追加のサーバー情報を含むクエリオブジェクト (query_info がリクエストに設定される場合) | はい |
クエリオブジェクト
クエリサービスのすべてのフィールドは、リクエスト時に、ゲームサーバーのクエリサービスから直接返されます。これが機能するにはゲームがクエリをサポートする必要があります。
| フィールド | 型 | 説明 | 任意 |
|---|---|---|---|
| players | integer | サーバー上の現在のプレイヤーの数 | いいえ |
| max_players | integer | 現在の最大マッチプレイヤー数 | いいえ |
| map | string | 現在のマップ名 | いいえ |
| status | string | 現在の状況 | いいえ |
| name | string | 現在の名前 | いいえ |
リクエストの例
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/<serverid>/status?query_info=<query_info>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'レスポンスの例
{
"server: {
"active: <active>,
"allocated_uuid: <allocated_uuid>,
"admin_locked: <admin_locked>,
"country_code: <country_code>,
"game_port: <game_port>,
"ip: <ip>,
"locationid: <locationid>,
"machineid: <machineid>,
"name: <name>,
"profileid: <profileid>,
"query_port: <query_port>,
"serverid: <serverid>,
"query_info: {
"players: <players>,
"max_players: <max_players>,
"map: <map>,
"status: <status>
"name": <name>
}
}
}