Multiplayer Server - List Build Summaries V2

Service:

Multiplayer

API Version:

240412

Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.

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

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.).
PageSize	number	The page size for the request.
SkipToken	string	The skip token for the paged request.

Responses

Name	Type	Description
200 OK	ListBuildSummariesResponse
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
AzureVmSize
BuildRegion
BuildSummary
CurrentServerStats
DynamicStandbySettings
DynamicStandbyThreshold
ListBuildSummariesRequest	Returns a list of summarized details of all multiplayer server builds for a title.
ListBuildSummariesResponse
Schedule
ScheduledStandbySettings

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

AzureVmSize

Name	Type	Description
Standard_A1	string
Standard_A1_v2	string
Standard_A2	string
Standard_A2_v2	string
Standard_A3	string
Standard_A4	string
Standard_A4_v2	string
Standard_A8_v2	string
Standard_D16_v3	string
Standard_D16a_v4	string
Standard_D16ads_v5	string
Standard_D16as_v4	string
Standard_D16d_v4	string
Standard_D16ds_v4	string
Standard_D16s_v3	string
Standard_D1_v2	string
Standard_D2_v2	string
Standard_D2_v3	string
Standard_D2a_v4	string
Standard_D2ads_v5	string
Standard_D2as_v4	string
Standard_D2d_v4	string
Standard_D2ds_v4	string
Standard_D2s_v3	string
Standard_D3_v2	string
Standard_D4_v2	string
Standard_D4_v3	string
Standard_D4a_v4	string
Standard_D4ads_v5	string
Standard_D4as_v4	string
Standard_D4d_v4	string
Standard_D4ds_v4	string
Standard_D4s_v3	string
Standard_D5_v2	string
Standard_D8_v3	string
Standard_D8a_v4	string
Standard_D8ads_v5	string
Standard_D8as_v4	string
Standard_D8d_v4	string
Standard_D8ds_v4	string
Standard_D8s_v3	string
Standard_DS1_v2	string
Standard_DS2_v2	string
Standard_DS3_v2	string
Standard_DS4_v2	string
Standard_DS5_v2	string
Standard_E16a_v4	string
Standard_E16as_v4	string
Standard_E2a_v4	string
Standard_E2as_v4	string
Standard_E4a_v4	string
Standard_E4as_v4	string
Standard_E8a_v4	string
Standard_E8as_v4	string
Standard_F1	string
Standard_F16	string
Standard_F16s_v2	string
Standard_F2	string
Standard_F2s_v2	string
Standard_F4	string
Standard_F4s_v2	string
Standard_F8	string
Standard_F8s_v2	string
Standard_HB120_16rs_v3	string
Standard_HB120_32rs_v3	string
Standard_HB120_64rs_v3	string
Standard_HB120_96rs_v3	string
Standard_HB120rs_v3	string
Standard_NC4as_T4_v3	string

BuildRegion

Name	Type	Description
CurrentServerStats	CurrentServerStats	The current multiplayer server stats for the region.
DynamicStandbySettings	DynamicStandbySettings	Optional settings to control dynamic adjustment of standby target
IsAssetReplicationComplete	boolean	Whether the game assets provided for the build have been replicated to this region.
MaxServers	number	The maximum number of multiplayer servers for the region.
MultiplayerServerCountPerVm	number	Regional override for the number of multiplayer servers to host on a single VM of the build.
Region	AzureRegion	The build region.
ScheduledStandbySettings	ScheduledStandbySettings	Optional settings to set the standby target to specified values during the supplied schedules
StandbyServers	number	The target number of standby multiplayer servers for the region.
Status	string	The status of multiplayer servers in the build region. Valid values are - Unknown, Initialized, Deploying, Deployed, Unhealthy, Deleting, Deleted.
VmSize	AzureVmSize	Regional override for the VM size the build was created on.

BuildSummary

Name	Type	Description
BuildId	string	The guid string build ID of the build.
BuildName	string	The build name.
CreationTime	string	The time the build was created in UTC.
Metadata	object	The metadata of the build.
RegionConfigurations	BuildRegion[]	The configuration and status for each region in the build.

CurrentServerStats

Name	Type	Description
Active	number	The number of active multiplayer servers.
Propping	number	The number of multiplayer servers still downloading game resources (such as assets).
StandingBy	number	The number of standingby multiplayer servers.
Total	number	The total number of multiplayer servers.

DynamicStandbySettings

Name	Type	Description
DynamicFloorMultiplierThresholds	DynamicStandbyThreshold[]	List of auto standing by trigger values and corresponding standing by multiplier. Defaults to 1.5X at 50%, 3X at 25%, and 4X at 5%
IsEnabled	boolean	When true, dynamic standby will be enabled
RampDownSeconds	number	The time it takes to reduce target standing by to configured floor value after an increase. Defaults to 30 minutes

DynamicStandbyThreshold

Name	Type	Description
Multiplier	number	When the trigger threshold is reached, multiply by this value
TriggerThresholdPercentage	number	The multiplier will be applied when the actual standby divided by target standby floor is less than this value

ListBuildSummariesRequest

Returns a list of summarized details of all multiplayer server builds for a title.

Name	Type	Description
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.

ListBuildSummariesResponse

Name	Type	Description
BuildSummaries	BuildSummary[]	The list of build summaries for a title.
PageSize	number	The page size on the response.
SkipToken	string	The skip token for the paged response.

Schedule

Name	Type	Description
Description	string	A short description about this schedule. For example, "Game launch on July 15th".
EndTime	string	The date and time in UTC at which the schedule ends. If IsRecurringWeekly is true, this schedule will keep renewing for future weeks until disabled or removed.
IsDisabled	boolean	Disables the schedule.
IsRecurringWeekly	boolean	If true, the StartTime and EndTime will get renewed every week.
StartTime	string	The date and time in UTC at which the schedule starts.
TargetStandby	number	The standby target to maintain for the duration of the schedule.

ScheduledStandbySettings

Name	Type	Description
IsEnabled	boolean	When true, scheduled standby will be enabled
ScheduleList	Schedule[]	A list of non-overlapping schedules

Error Codes

Name	Code
APINotEnabledForGameClientAccess	1082
MultiplayerServerBadRequest	1382
MultiplayerServerForbidden	1384
MultiplayerServerInternalServerError	1387
MultiplayerServerNotFound	1385
MultiplayerServerTooManyRequests	1380
MultiplayerServerUnauthorized	1383
MultiplayerServerUnavailable	1388