Share via


Multiplayer Server - List Title Multiplayer Servers Quota Changes

List all server quota change requests for a title.

Allowed entity token types: title

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

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

ListTitleMultiplayerServersQuotaChangesResponse

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
CoreCapacityChange
ListTitleMultiplayerServersQuotaChangesRequest

List all server quota change requests for a title.

ListTitleMultiplayerServersQuotaChangesResponse
QuotaChange

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

CoreCapacityChange

Name Type Description
NewCoreLimit

number

New quota core limit for the given vm family/region.

Region

AzureRegion

Region to change.

VmFamily

AzureVmFamily

Virtual machine family to change.

ListTitleMultiplayerServersQuotaChangesRequest

List all server quota change requests for a title.

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

ListTitleMultiplayerServersQuotaChangesResponse

Name Type Description
Changes

QuotaChange[]

All change requests for this title.

QuotaChange

Name Type Description
ChangeDescription

string

A brief description of the requested changes.

Changes

CoreCapacityChange[]

Requested changes to make to the titles cores quota.

IsPendingReview

boolean

Whether or not this request is pending a review.

Notes

string

Additional information about this request that our team can use to better understand the requirements.

RequestId

string

Id of the change request.

ReviewComments

string

Comments by our team when a request is reviewed.

WasApproved

boolean

Whether or not this request was approved.

Error Codes

Name Code
APINotEnabledForGameClientAccess 1082
MultiplayerServerBadRequest 1382
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerUnauthorized 1383