Multiplayer Server - Get Title Multiplayer Servers Quotas

Service:

Multiplayer

API Version:

240514

Gets the quotas for a title in relation to multiplayer servers.

POST https://titleId.playfabapi.com/MultiplayerServer/GetTitleMultiplayerServersQuotas

Request 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	GetTitleMultiplayerServersQuotasResponse
400 Bad Request	ApiErrorWrapper	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
ApiErrorWrapper	The basic wrapper around every failed API response
AzureRegion
AzureVmFamily
CoreCapacity
GetTitleMultiplayerServersQuotasRequest	Gets the quotas for a title in relation to multiplayer servers.
GetTitleMultiplayerServersQuotasResponse
TitleMultiplayerServersQuotas

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

Name	Type	Description
AustraliaEast	string
AustraliaSoutheast	string
BrazilSouth	string
CentralIndia	string
CentralUs	string
EastAsia	string
EastUs	string
EastUs2	string
FranceCentral	string
JapanEast	string
JapanWest	string
KoreaCentral	string
NorthCentralUs	string
NorthEurope	string
SouthAfricaNorth	string
SouthCentralUs	string
SoutheastAsia	string
SwedenCentral	string
UaeNorth	string
UkSouth	string
WestCentralUs	string
WestEurope	string
WestUs	string
WestUs2	string

AzureVmFamily

Name	Type	Description
A	string
Av2	string
Dadsv5	string
Dasv4	string
Dav4	string
Ddsv4	string
Ddsv5	string
Ddv4	string
Ddv5	string
Dsv2	string
Dsv3	string
Dv2	string
Dv3	string
Easv4	string
Eav4	string
Esv4	string
Ev4	string
F	string
Fsv2	string
HBv3	string
NCasT4_v3	string

CoreCapacity

Name	Type	Description
Available	number	The available core capacity for the (Region, VmFamily)
Region	AzureRegion	The AzureRegion
Total	number	The total core capacity for the (Region, VmFamily)
VmFamily	AzureVmFamily	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	TitleMultiplayerServersQuotas	The various quotas for multiplayer servers for the title.

TitleMultiplayerServersQuotas

Name	Type	Description
CoreCapacities	CoreCapacity[]	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