Multiplayer Server - Get Title Multiplayer Servers Quotas
Gets the quotas for a title in relation to multiplayer servers.
Allowed entity token types: title
POST https://titleId.playfabapi.com/MultiplayerServer/GetTitleMultiplayerServersQuotasRequest 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 | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
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 |
|
|
Azure |
|
|
Core |
|
|
Get |
Gets the quotas for a title in relation to multiplayer servers. |
|
Get |
|
|
Title |
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 |
AzureVmFamily
| Value | Description |
|---|---|
| A | |
| Av2 | |
| Dv2 | |
| Dv3 | |
| F | |
| Fsv2 | |
| Dasv4 | |
| Dav4 | |
| Dadsv5 | |
| Dadsv6 | |
| Eav4 | |
| Easv4 | |
| Ev4 | |
| Esv4 | |
| Dsv3 | |
| Dsv2 | |
| NCasT4_v3 | |
| Ddv4 | |
| Ddsv4 | |
| HBv3 | |
| Ddv5 | |
| Ddsv5 |
CoreCapacity
| Name | Type | Description |
|---|---|---|
| Available |
number |
The available core capacity for the (Region, VmFamily) |
| Region |
The AzureRegion |
|
| Total |
number |
The total core capacity for the (Region, VmFamily) |
| VmFamily |
The AzureVmFamily |
GetTitleMultiplayerServersQuotasRequest
Gets the quotas for a title in relation to multiplayer servers.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
GetTitleMultiplayerServersQuotasResponse
| Name | Type | Description |
|---|---|---|
| Quotas |
The various quotas for multiplayer servers for the title. |
TitleMultiplayerServersQuotas
| Name | Type | Description |
|---|---|---|
| CoreCapacities |
The core capacity for the various regions and VM Family |
Error Codes
| Name | Code |
|---|---|
| APINotEnabledForGameClientAccess | 1082 |
| MultiplayerServerBadRequest | 1382 |
| MultiplayerServerForbidden | 1384 |
| MultiplayerServerInternalServerError | 1387 |
| MultiplayerServerNotFound | 1385 |
| MultiplayerServerUnauthorized | 1383 |
| MultiplayerServerUnavailable | 1388 |