メインコンテンツへスキップ
POST
Get Remote Login Endpoint

承認

X-EntityToken
string
header
必須

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

ボディ

application/json

Gets a remote login endpoint to a VM that is hosting a multiplayer server build in a specific region.

Gets a remote login endpoint to a VM that is hosting a multiplayer server build in a specific region.

BuildId
string
必須

The guid string build ID of the multiplayer server to get remote login information for.

Region
enum<string>
必須

The region of the multiplayer server to get remote login information for.

利用可能なオプション:
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,
WestUs3,
CanadaEast,
UkWest,
FranceSouth,
SouthIndia,
SpainCentral,
GermanyWestCentral,
ItalyNorth,
IndonesiaCentral,
ChileCentral,
PolandCentral,
NewZealandNorth,
BrazilSoutheast,
NorwayEast,
SwitzerlandNorth,
MalaysiaWest,
IsraelCentral,
QatarCentral,
UaeCentral,
GermanyNorth,
AustriaEast,
BelgiumCentral,
DenmarkEast,
SwitzerlandWest,
SwedenSouth,
NorwayWest,
SouthAfricaWest,
MalaysiaSouth
VmId
string
必須

The virtual machine ID the multiplayer server is located on.

CustomTags
object

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

レスポンス

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
例:
最終更新日 2026年10月6日