다음을 통해 공유


Multiplayer Server - Update Build Regions

Updates a multiplayer server build's regions.

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

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 Required Type Description
BuildId True

string

The guid string ID of the build we want to update regions for.

BuildRegions True

BuildRegionParams[]

The updated region configuration that should be applied to the specified build.

CustomTags

object

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

Responses

Name Type Description
200 OK

EmptyResponse

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
BuildRegionParams
DynamicStandbySettings
DynamicStandbyThreshold
EmptyResponse
Schedule
ScheduledStandbySettings
UpdateBuildRegionsRequest

Updates a multiplayer server build's regions.

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
CanadaCentral
CentralIndia
CentralUs
EastAsia
EastUs
EastUs2
FranceCentral
JapanEast
JapanWest
KoreaCentral
MexicoCentral
NorthCentralUs
NorthEurope
SouthAfricaNorth
SouthCentralUs
SoutheastAsia
SwedenCentral
UaeNorth
UkSouth
WestCentralUs
WestEurope
WestUs
WestUs2

AzureVmSize

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

BuildRegionParams

Name Type Description
DynamicStandbySettings

DynamicStandbySettings

Optional settings to control dynamic adjustment of standby target. If not specified, dynamic standby is disabled

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 number of standby multiplayer servers for the region.

VmSize

AzureVmSize

Regional override for the VM size the build was created on.

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

EmptyResponse

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

UpdateBuildRegionsRequest

Updates a multiplayer server build's regions.

Name Type Description
BuildId

string

The guid string ID of the build we want to update regions for.

BuildRegions

BuildRegionParams[]

The updated region configuration that should be applied to the specified build.

CustomTags

object

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

Error Codes

Name Code
APINotEnabledForGameClientAccess 1082
MultiplayerServerBadRequest 1382
MultiplayerServerConflict 1386
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerNotFound 1385
MultiplayerServerTitleQuotaCoresExceeded 1445
MultiplayerServerUnauthorized 1383
MultiplayerServerUnavailable 1388