Multiplayer Server - List Virtual Machine Summaries
Lists virtual machines for a title.
Allowed entity token types: title
POST https://titleId.playfabapi.com/MultiplayerServer/ListVirtualMachineSummariesRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| BuildId | True |
string |
The guid string build ID of the virtual machines to list. |
| Region | True |
The region of the virtual machines to list. |
|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
| PageSize |
number |
The page size for the request. |
|
| SkipToken |
string |
The skip token for the paged request. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Azure |
|
|
List |
Returns a list of virtual machines for a title. |
|
List |
|
|
Virtual |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
AzureRegion
| Value | Description |
|---|---|
| AustraliaEast | |
| AustraliaSoutheast | |
| BrazilSouth | |
| CentralUs | |
| EastAsia | |
| EastUs | |
| EastUs2 | |
| JapanEast | |
| JapanWest | |
| NorthCentralUs | |
| NorthEurope | |
| SouthCentralUs | |
| SoutheastAsia | |
| WestEurope | |
| WestUs | |
| SouthAfricaNorth | |
| WestCentralUs | |
| KoreaCentral | |
| FranceCentral | |
| WestUs2 | |
| CentralIndia | |
| UaeNorth | |
| UkSouth | |
| SwedenCentral | |
| CanadaCentral | |
| MexicoCentral |
ListVirtualMachineSummariesRequest
Returns a list of virtual machines for a title.
| Name | Type | Description |
|---|---|---|
| BuildId |
string |
The guid string build ID of the virtual machines to list. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| PageSize |
number |
The page size for the request. |
| Region |
The region of the virtual machines to list. |
|
| SkipToken |
string |
The skip token for the paged request. |
ListVirtualMachineSummariesResponse
| Name | Type | Description |
|---|---|---|
| PageSize |
number |
The page size on the response. |
| SkipToken |
string |
The skip token for the paged response. |
| VirtualMachines |
The list of virtual machine summaries. |
VirtualMachineSummary
| Name | Type | Description |
|---|---|---|
| HealthStatus |
string |
The virtual machine health status. |
| State |
string |
The virtual machine state. |
| VmId |
string |
The virtual machine ID. |
Error Codes
| Name | Code |
|---|---|
| APINotEnabledForGameClientAccess | 1082 |
| MultiplayerServerBadRequest | 1382 |
| MultiplayerServerForbidden | 1384 |
| MultiplayerServerInternalServerError | 1387 |
| MultiplayerServerNotFound | 1385 |
| MultiplayerServerUnauthorized | 1383 |
| MultiplayerServerUnavailable | 1388 |