Multiplayer Server - List Qos Servers For Title
Lists quality of service servers for the title. By default, servers are only returned for regions where a Multiplayer Servers build has been deployed.
POST https://titleId.playfabapi.com/MultiplayerServer/ListQosServersForTitle
Request Header
Name | Required | Type | Description |
---|---|---|---|
X-EntityToken | True |
|
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
Name | Type | Description |
---|---|---|
CustomTags |
|
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
IncludeAllRegions |
|
Indicates that the response should contain Qos servers for all regions, including those where there are no builds deployed for the title. |
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
Api |
The basic wrapper around every failed API response |
Azure |
|
List |
Returns a list of quality of service servers for a title. |
List |
|
Qos |
ApiErrorWrapper
The basic wrapper around every failed API response
Name | Type | Description |
---|---|---|
code |
|
Numerical HTTP code |
error |
|
Playfab error code |
errorCode |
|
Numerical PlayFab error code |
errorDetails |
|
Detailed description of individual issues with the request object |
errorMessage |
|
Description for the PlayFab errorCode |
status |
|
String HTTP code |
AzureRegion
Name | Type | Description |
---|---|---|
AustraliaEast |
|
|
AustraliaSoutheast |
|
|
BrazilSouth |
|
|
CentralIndia |
|
|
CentralUs |
|
|
EastAsia |
|
|
EastUs |
|
|
EastUs2 |
|
|
FranceCentral |
|
|
JapanEast |
|
|
JapanWest |
|
|
KoreaCentral |
|
|
NorthCentralUs |
|
|
NorthEurope |
|
|
SouthAfricaNorth |
|
|
SouthCentralUs |
|
|
SoutheastAsia |
|
|
UaeNorth |
|
|
UkSouth |
|
|
WestCentralUs |
|
|
WestEurope |
|
|
WestUs |
|
|
WestUs2 |
|
ListQosServersForTitleRequest
Returns a list of quality of service servers for a title.
Name | Type | Description |
---|---|---|
CustomTags |
|
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
IncludeAllRegions |
|
Indicates that the response should contain Qos servers for all regions, including those where there are no builds deployed for the title. |
ListQosServersForTitleResponse
Name | Type | Description |
---|---|---|
PageSize |
|
The page size on the response. |
QosServers |
The list of QoS servers. |
|
SkipToken |
|
The skip token for the paged response. |
QosServer
Name | Type | Description |
---|---|---|
Region |
The region the QoS server is located in. |
|
ServerUrl |
|
The QoS server URL. |
Error Codes
Name | Code |
---|---|
APINotEnabledForGameClientAccess | 1082 |
MultiplayerServerBadRequest | 1382 |
MultiplayerServerForbidden | 1384 |
MultiplayerServerInternalServerError | 1387 |
MultiplayerServerNotFound | 1385 |
MultiplayerServerUnauthorized | 1383 |
MultiplayerServerUnavailable | 1388 |