使用處理序型伺服器建立組建

Creates a multiplayer server build with the server running as a process.

Allowed entity token types: title

Error codes

This operation may return the following PlayFab errors:

Error	Code
APINotEnabledForGameClientAccess	1082
MultiplayerServerBadRequest	1382
MultiplayerServerConflict	1386
MultiplayerServerForbidden	1384
MultiplayerServerInternalServerError	1387
MultiplayerServerTitleQuotaCoresExceeded	1445
MultiplayerServerUnauthorized	1383
MultiplayerServerUnavailable	1388
ProductDisabledForTitle	1609

POST

MultiplayerServer

CreateBuildWithProcessBasedServer

Create Build With Process Based Server

curl --request POST \
  --url https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "GameAssetReferences": [
    {
      "FileName": "game.zip"
    }
  ],
  "StartMultiplayerServerCommand": "gameserver.exe -startserver",
  "InstrumentationConfiguration": {
    "ProcessesToMonitor": [
      "GameServerProcessName"
    ],
    "IsEnabled": true
  },
  "GameWorkingDirectory": "C:\\Assets",
  "IsOSPreview": false,
  "VmSize": "Standard_D2_v2",
  "MultiplayerServerCountPerVm": 10,
  "Ports": [
    {
      "Name": "PortName",
      "Num": 1243
    }
  ],
  "RegionConfigurations": [
    {
      "Region": "EastUs",
      "MaxServers": 10,
      "StandbyServers": 5
    },
    {
      "Region": "WestUs",
      "MaxServers": 12,
      "StandbyServers": 8
    },
    {
      "Region": "NorthEurope",
      "MaxServers": 7,
      "StandbyServers": 3
    }
  ],
  "GameCertificateReferences": [
    {
      "Name": "CertName",
      "GsdkAlias": "CertGsdkAlias"
    }
  ],
  "GameSecretReferences": [
    {
      "Name": "SecretName"
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer"

payload = {
    "GameAssetReferences": [{ "FileName": "game.zip" }],
    "StartMultiplayerServerCommand": "gameserver.exe -startserver",
    "InstrumentationConfiguration": {
        "ProcessesToMonitor": ["GameServerProcessName"],
        "IsEnabled": True
    },
    "GameWorkingDirectory": "C:\Assets",
    "IsOSPreview": False,
    "VmSize": "Standard_D2_v2",
    "MultiplayerServerCountPerVm": 10,
    "Ports": [
        {
            "Name": "PortName",
            "Num": 1243
        }
    ],
    "RegionConfigurations": [
        {
            "Region": "EastUs",
            "MaxServers": 10,
            "StandbyServers": 5
        },
        {
            "Region": "WestUs",
            "MaxServers": 12,
            "StandbyServers": 8
        },
        {
            "Region": "NorthEurope",
            "MaxServers": 7,
            "StandbyServers": 3
        }
    ],
    "GameCertificateReferences": [
        {
            "Name": "CertName",
            "GsdkAlias": "CertGsdkAlias"
        }
    ],
    "GameSecretReferences": [{ "Name": "SecretName" }]
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    GameAssetReferences: [{FileName: 'game.zip'}],
    StartMultiplayerServerCommand: 'gameserver.exe -startserver',
    InstrumentationConfiguration: {ProcessesToMonitor: ['GameServerProcessName'], IsEnabled: true},
    GameWorkingDirectory: 'C:\Assets',
    IsOSPreview: false,
    VmSize: 'Standard_D2_v2',
    MultiplayerServerCountPerVm: 10,
    Ports: [{Name: 'PortName', Num: 1243}],
    RegionConfigurations: [
      {Region: 'EastUs', MaxServers: 10, StandbyServers: 5},
      {Region: 'WestUs', MaxServers: 12, StandbyServers: 8},
      {Region: 'NorthEurope', MaxServers: 7, StandbyServers: 3}
    ],
    GameCertificateReferences: [{Name: 'CertName', GsdkAlias: 'CertGsdkAlias'}],
    GameSecretReferences: [{Name: 'SecretName'}]
  })
};

fetch('https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'GameAssetReferences' => [
        [
                'FileName' => 'game.zip'
        ]
    ],
    'StartMultiplayerServerCommand' => 'gameserver.exe -startserver',
    'InstrumentationConfiguration' => [
        'ProcessesToMonitor' => [
                'GameServerProcessName'
        ],
        'IsEnabled' => true
    ],
    'GameWorkingDirectory' => 'C:\\Assets',
    'IsOSPreview' => false,
    'VmSize' => 'Standard_D2_v2',
    'MultiplayerServerCountPerVm' => 10,
    'Ports' => [
        [
                'Name' => 'PortName',
                'Num' => 1243
        ]
    ],
    'RegionConfigurations' => [
        [
                'Region' => 'EastUs',
                'MaxServers' => 10,
                'StandbyServers' => 5
        ],
        [
                'Region' => 'WestUs',
                'MaxServers' => 12,
                'StandbyServers' => 8
        ],
        [
                'Region' => 'NorthEurope',
                'MaxServers' => 7,
                'StandbyServers' => 3
        ]
    ],
    'GameCertificateReferences' => [
        [
                'Name' => 'CertName',
                'GsdkAlias' => 'CertGsdkAlias'
        ]
    ],
    'GameSecretReferences' => [
        [
                'Name' => 'SecretName'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer"

	payload := strings.NewReader("{\n  \"GameAssetReferences\": [\n    {\n      \"FileName\": \"game.zip\"\n    }\n  ],\n  \"StartMultiplayerServerCommand\": \"gameserver.exe -startserver\",\n  \"InstrumentationConfiguration\": {\n    \"ProcessesToMonitor\": [\n      \"GameServerProcessName\"\n    ],\n    \"IsEnabled\": true\n  },\n  \"GameWorkingDirectory\": \"C:\\\\Assets\",\n  \"IsOSPreview\": false,\n  \"VmSize\": \"Standard_D2_v2\",\n  \"MultiplayerServerCountPerVm\": 10,\n  \"Ports\": [\n    {\n      \"Name\": \"PortName\",\n      \"Num\": 1243\n    }\n  ],\n  \"RegionConfigurations\": [\n    {\n      \"Region\": \"EastUs\",\n      \"MaxServers\": 10,\n      \"StandbyServers\": 5\n    },\n    {\n      \"Region\": \"WestUs\",\n      \"MaxServers\": 12,\n      \"StandbyServers\": 8\n    },\n    {\n      \"Region\": \"NorthEurope\",\n      \"MaxServers\": 7,\n      \"StandbyServers\": 3\n    }\n  ],\n  \"GameCertificateReferences\": [\n    {\n      \"Name\": \"CertName\",\n      \"GsdkAlias\": \"CertGsdkAlias\"\n    }\n  ],\n  \"GameSecretReferences\": [\n    {\n      \"Name\": \"SecretName\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"GameAssetReferences\": [\n    {\n      \"FileName\": \"game.zip\"\n    }\n  ],\n  \"StartMultiplayerServerCommand\": \"gameserver.exe -startserver\",\n  \"InstrumentationConfiguration\": {\n    \"ProcessesToMonitor\": [\n      \"GameServerProcessName\"\n    ],\n    \"IsEnabled\": true\n  },\n  \"GameWorkingDirectory\": \"C:\\\\Assets\",\n  \"IsOSPreview\": false,\n  \"VmSize\": \"Standard_D2_v2\",\n  \"MultiplayerServerCountPerVm\": 10,\n  \"Ports\": [\n    {\n      \"Name\": \"PortName\",\n      \"Num\": 1243\n    }\n  ],\n  \"RegionConfigurations\": [\n    {\n      \"Region\": \"EastUs\",\n      \"MaxServers\": 10,\n      \"StandbyServers\": 5\n    },\n    {\n      \"Region\": \"WestUs\",\n      \"MaxServers\": 12,\n      \"StandbyServers\": 8\n    },\n    {\n      \"Region\": \"NorthEurope\",\n      \"MaxServers\": 7,\n      \"StandbyServers\": 3\n    }\n  ],\n  \"GameCertificateReferences\": [\n    {\n      \"Name\": \"CertName\",\n      \"GsdkAlias\": \"CertGsdkAlias\"\n    }\n  ],\n  \"GameSecretReferences\": [\n    {\n      \"Name\": \"SecretName\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"GameAssetReferences\": [\n    {\n      \"FileName\": \"game.zip\"\n    }\n  ],\n  \"StartMultiplayerServerCommand\": \"gameserver.exe -startserver\",\n  \"InstrumentationConfiguration\": {\n    \"ProcessesToMonitor\": [\n      \"GameServerProcessName\"\n    ],\n    \"IsEnabled\": true\n  },\n  \"GameWorkingDirectory\": \"C:\\\\Assets\",\n  \"IsOSPreview\": false,\n  \"VmSize\": \"Standard_D2_v2\",\n  \"MultiplayerServerCountPerVm\": 10,\n  \"Ports\": [\n    {\n      \"Name\": \"PortName\",\n      \"Num\": 1243\n    }\n  ],\n  \"RegionConfigurations\": [\n    {\n      \"Region\": \"EastUs\",\n      \"MaxServers\": 10,\n      \"StandbyServers\": 5\n    },\n    {\n      \"Region\": \"WestUs\",\n      \"MaxServers\": 12,\n      \"StandbyServers\": 8\n    },\n    {\n      \"Region\": \"NorthEurope\",\n      \"MaxServers\": 7,\n      \"StandbyServers\": 3\n    }\n  ],\n  \"GameCertificateReferences\": [\n    {\n      \"Name\": \"CertName\",\n      \"GsdkAlias\": \"CertGsdkAlias\"\n    }\n  ],\n  \"GameSecretReferences\": [\n    {\n      \"Name\": \"SecretName\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "StartMultiplayerServerCommand": "gameserver.exe -startserver",
    "InstrumentationConfiguration": {
      "ProcessesToMonitor": [
        "GameServerProcessName"
      ],
      "IsEnabled": true
    },
    "GameWorkingDirectory": "C:\\Assets",
    "IsOSPreview": false,
    "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
    "BuildName": "GameBuildName",
    "CreationTime": "2014-04-07T09:04:28",
    "Metadata": {
      "MetadataKey": "MetadataValue"
    },
    "VmSize": "Standard_D2_v2",
    "ServerType": "Process",
    "ContainerFlavor": "Invalid",
    "Ports": [
      {
        "Name": "PortName",
        "Num": 1243
      }
    ],
    "RegionConfigurations": [
      {
        "Region": "EastUs",
        "Status": "Initializing",
        "MaxServers": 10,
        "StandbyServers": 5
      },
      {
        "Region": "WestUs",
        "Status": "Succeeded",
        "MaxServers": 12,
        "StandbyServers": 8
      },
      {
        "Region": "NorthEurope",
        "Status": "Unhealthy",
        "MaxServers": 7,
        "StandbyServers": 3
      }
    ],
    "GameAssetReferences": [
      {
        "FileName": "gameserver.zip"
      }
    ],
    "GameCertificateReferences": [
      {
        "Name": "CertName",
        "GsdkAlias": "CertGsdkAlias"
      }
    ],
    "GameSecretReferences": [
      {
        "Name": "SecretName"
      }
    ],
    "MultiplayerServerCountPerVm": 10
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

授權

X-EntityToken

string

header

必填

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

主體

application/json

Creates a multiplayer server build with the game server running as a process and returns information about the build creation request.

BuildName

string

必填

The build name.

GameAssetReferences

object[]

必填

The list of game assets related to the build.

Show child attributes

MultiplayerServerCountPerVm

number

必填

The number of multiplayer servers to host on a single VM.

Ports

object[]

必填

The ports to map the build on.

Show child attributes

RegionConfigurations

object[]

必填

The region configurations for the build.

Show child attributes

StartMultiplayerServerCommand

string

必填

The command to run when the multiplayer server is started, including any arguments. The path to any executable should be relative to the root asset folder when unzipped.

AreAssetsReadonly

boolean

When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or will have the same assets mounted in the container.

CustomTags

object

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

GameCertificateReferences

object[]

The game certificates for the build.

Show child attributes

GameSecretReferences

object[]

The game secrets for the build.

Show child attributes

GameWorkingDirectory

string

The working directory for the game process. If this is not provided, the working directory will be set based on the mount path of the game server executable.

InstrumentationConfiguration

object

The instrumentation configuration for the Build. Used only if it is a Windows Build.

Show child attributes

IsOSPreview

boolean

Indicates whether this build will be created using the OS Preview versionPreview OS is recommended for dev builds to detect any breaking changes before they are released to retail. Retail builds should set this value to false.

LinuxInstrumentationConfiguration

object

The Linux instrumentation configuration for the Build. Used only if it is a Linux Build.

Show child attributes

Metadata

object

Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100

OsPlatform

enum<string>

The OS platform used for running the game process.

可用選項:

Windows,

Linux

VmSize

enum<string>

The VM size to create the build on.

可用選項:

Standard_A1,

Standard_A2,

Standard_A3,

Standard_A4,

Standard_A1_v2,

Standard_A2_v2,

Standard_A4_v2,

Standard_A8_v2,

Standard_D1_v2,

Standard_D2_v2,

Standard_D3_v2,

Standard_D4_v2,

Standard_D5_v2,

Standard_D2_v3,

Standard_D4_v3,

Standard_D8_v3,

Standard_D16_v3,

Standard_F1,

Standard_F2,

Standard_F4,

Standard_F8,

Standard_F16,

Standard_F2s_v2,

Standard_F4s_v2,

Standard_F8s_v2,

Standard_F16s_v2,

Standard_F2as_v6,

Standard_F4as_v6,

Standard_F8as_v6,

Standard_F16as_v6,

Standard_F2as_v7,

Standard_F4as_v7,

Standard_F8as_v7,

Standard_F16as_v7,

Standard_F2ads_v7,

Standard_F4ads_v7,

Standard_F8ads_v7,

Standard_F16ads_v7,

Standard_D2as_v4,

Standard_D4as_v4,

Standard_D8as_v4,

Standard_D16as_v4,

Standard_D2a_v4,

Standard_D4a_v4,

Standard_D8a_v4,

Standard_D16a_v4,

Standard_D2ads_v5,

Standard_D4ads_v5,

Standard_D8ads_v5,

Standard_D16ads_v5,

Standard_D2ads_v6,

Standard_D4ads_v6,

Standard_D8ads_v6,

Standard_D16ads_v6,

Standard_D2ads_v7,

Standard_D4ads_v7,

Standard_D8ads_v7,

Standard_D16ads_v7,

Standard_E2a_v4,

Standard_E4a_v4,

Standard_E8a_v4,

Standard_E16a_v4,

Standard_E2as_v4,

Standard_E4as_v4,

Standard_E8as_v4,

Standard_E16as_v4,

Standard_E2ads_v5,

Standard_E4ads_v5,

Standard_E8ads_v5,

Standard_E16ads_v5,

Standard_E2ads_v6,

Standard_E4ads_v6,

Standard_E8ads_v6,

Standard_E16ads_v6,

Standard_E2ads_v7,

Standard_E4ads_v7,

Standard_E8ads_v7,

Standard_E16ads_v7,

Standard_E2ds_v4,

Standard_E4ds_v4,

Standard_E8ds_v4,

Standard_E16ds_v4,

Standard_E2ds_v5,

Standard_E4ds_v5,

Standard_E8ds_v5,

Standard_E16ds_v5,

Standard_E2ds_v6,

Standard_E4ds_v6,

Standard_E8ds_v6,

Standard_E16ds_v6,

Standard_D2s_v3,

Standard_D4s_v3,

Standard_D8s_v3,

Standard_D16s_v3,

Standard_DS1_v2,

Standard_DS2_v2,

Standard_DS3_v2,

Standard_DS4_v2,

Standard_DS5_v2,

Standard_NC4as_T4_v3,

Standard_D2d_v4,

Standard_D4d_v4,

Standard_D8d_v4,

Standard_D16d_v4,

Standard_D2ds_v4,

Standard_D4ds_v4,

Standard_D8ds_v4,

Standard_D16ds_v4,

Standard_HB120_16rs_v3,

Standard_HB120_32rs_v3,

Standard_HB120_64rs_v3,

Standard_HB120_96rs_v3,

Standard_HB120rs_v3,

Standard_D2d_v5,

Standard_D4d_v5,

Standard_D8d_v5,

Standard_D16d_v5,

Standard_D32d_v5,

Standard_D2ds_v5,

Standard_D4ds_v5,

Standard_D8ds_v5,

Standard_D16ds_v5,

Standard_D32ds_v5,

Standard_D2ds_v6,

Standard_D4ds_v6,

Standard_D8ds_v6,

Standard_D16ds_v6,

Standard_D2pds_v6,

Standard_D4pds_v6,

Standard_D8pds_v6,

Standard_D16pds_v6

VmStartupScriptConfiguration

object

The configuration for the VmStartupScript for the build

Show child attributes

回應

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

Show child attributes

範例:

{
  "StartMultiplayerServerCommand": "gameserver.exe -startserver",
  "InstrumentationConfiguration": {
    "ProcessesToMonitor": ["GameServerProcessName"],
    "IsEnabled": true
  },
  "GameWorkingDirectory": "C:\\Assets",
  "IsOSPreview": false,
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "BuildName": "GameBuildName",
  "CreationTime": "2014-04-07T09:04:28",
  "Metadata": { "MetadataKey": "MetadataValue" },
  "VmSize": "Standard_D2_v2",
  "ServerType": "Process",
  "ContainerFlavor": "Invalid",
  "Ports": [{ "Name": "PortName", "Num": 1243 }],
  "RegionConfigurations": [
    {
      "Region": "EastUs",
      "Status": "Initializing",
      "MaxServers": 10,
      "StandbyServers": 5
    },
    {
      "Region": "WestUs",
      "Status": "Succeeded",
      "MaxServers": 12,
      "StandbyServers": 8
    },
    {
      "Region": "NorthEurope",
      "Status": "Unhealthy",
      "MaxServers": 7,
      "StandbyServers": 3
    }
  ],
  "GameAssetReferences": [{ "FileName": "gameserver.zip" }],
  "GameCertificateReferences": [
    {
      "Name": "CertName",
      "GsdkAlias": "CertGsdkAlias"
    }
  ],
  "GameSecretReferences": [{ "Name": "SecretName" }],
  "MultiplayerServerCountPerVm": 10
}

最後修改於 2026年10月6日

⌘I

Create Build With Process Based Server

curl --request POST \
  --url https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "GameAssetReferences": [
    {
      "FileName": "game.zip"
    }
  ],
  "StartMultiplayerServerCommand": "gameserver.exe -startserver",
  "InstrumentationConfiguration": {
    "ProcessesToMonitor": [
      "GameServerProcessName"
    ],
    "IsEnabled": true
  },
  "GameWorkingDirectory": "C:\\Assets",
  "IsOSPreview": false,
  "VmSize": "Standard_D2_v2",
  "MultiplayerServerCountPerVm": 10,
  "Ports": [
    {
      "Name": "PortName",
      "Num": 1243
    }
  ],
  "RegionConfigurations": [
    {
      "Region": "EastUs",
      "MaxServers": 10,
      "StandbyServers": 5
    },
    {
      "Region": "WestUs",
      "MaxServers": 12,
      "StandbyServers": 8
    },
    {
      "Region": "NorthEurope",
      "MaxServers": 7,
      "StandbyServers": 3
    }
  ],
  "GameCertificateReferences": [
    {
      "Name": "CertName",
      "GsdkAlias": "CertGsdkAlias"
    }
  ],
  "GameSecretReferences": [
    {
      "Name": "SecretName"
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer"

payload = {
    "GameAssetReferences": [{ "FileName": "game.zip" }],
    "StartMultiplayerServerCommand": "gameserver.exe -startserver",
    "InstrumentationConfiguration": {
        "ProcessesToMonitor": ["GameServerProcessName"],
        "IsEnabled": True
    },
    "GameWorkingDirectory": "C:\Assets",
    "IsOSPreview": False,
    "VmSize": "Standard_D2_v2",
    "MultiplayerServerCountPerVm": 10,
    "Ports": [
        {
            "Name": "PortName",
            "Num": 1243
        }
    ],
    "RegionConfigurations": [
        {
            "Region": "EastUs",
            "MaxServers": 10,
            "StandbyServers": 5
        },
        {
            "Region": "WestUs",
            "MaxServers": 12,
            "StandbyServers": 8
        },
        {
            "Region": "NorthEurope",
            "MaxServers": 7,
            "StandbyServers": 3
        }
    ],
    "GameCertificateReferences": [
        {
            "Name": "CertName",
            "GsdkAlias": "CertGsdkAlias"
        }
    ],
    "GameSecretReferences": [{ "Name": "SecretName" }]
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    GameAssetReferences: [{FileName: 'game.zip'}],
    StartMultiplayerServerCommand: 'gameserver.exe -startserver',
    InstrumentationConfiguration: {ProcessesToMonitor: ['GameServerProcessName'], IsEnabled: true},
    GameWorkingDirectory: 'C:\Assets',
    IsOSPreview: false,
    VmSize: 'Standard_D2_v2',
    MultiplayerServerCountPerVm: 10,
    Ports: [{Name: 'PortName', Num: 1243}],
    RegionConfigurations: [
      {Region: 'EastUs', MaxServers: 10, StandbyServers: 5},
      {Region: 'WestUs', MaxServers: 12, StandbyServers: 8},
      {Region: 'NorthEurope', MaxServers: 7, StandbyServers: 3}
    ],
    GameCertificateReferences: [{Name: 'CertName', GsdkAlias: 'CertGsdkAlias'}],
    GameSecretReferences: [{Name: 'SecretName'}]
  })
};

fetch('https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'GameAssetReferences' => [
        [
                'FileName' => 'game.zip'
        ]
    ],
    'StartMultiplayerServerCommand' => 'gameserver.exe -startserver',
    'InstrumentationConfiguration' => [
        'ProcessesToMonitor' => [
                'GameServerProcessName'
        ],
        'IsEnabled' => true
    ],
    'GameWorkingDirectory' => 'C:\\Assets',
    'IsOSPreview' => false,
    'VmSize' => 'Standard_D2_v2',
    'MultiplayerServerCountPerVm' => 10,
    'Ports' => [
        [
                'Name' => 'PortName',
                'Num' => 1243
        ]
    ],
    'RegionConfigurations' => [
        [
                'Region' => 'EastUs',
                'MaxServers' => 10,
                'StandbyServers' => 5
        ],
        [
                'Region' => 'WestUs',
                'MaxServers' => 12,
                'StandbyServers' => 8
        ],
        [
                'Region' => 'NorthEurope',
                'MaxServers' => 7,
                'StandbyServers' => 3
        ]
    ],
    'GameCertificateReferences' => [
        [
                'Name' => 'CertName',
                'GsdkAlias' => 'CertGsdkAlias'
        ]
    ],
    'GameSecretReferences' => [
        [
                'Name' => 'SecretName'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer"

	payload := strings.NewReader("{\n  \"GameAssetReferences\": [\n    {\n      \"FileName\": \"game.zip\"\n    }\n  ],\n  \"StartMultiplayerServerCommand\": \"gameserver.exe -startserver\",\n  \"InstrumentationConfiguration\": {\n    \"ProcessesToMonitor\": [\n      \"GameServerProcessName\"\n    ],\n    \"IsEnabled\": true\n  },\n  \"GameWorkingDirectory\": \"C:\\\\Assets\",\n  \"IsOSPreview\": false,\n  \"VmSize\": \"Standard_D2_v2\",\n  \"MultiplayerServerCountPerVm\": 10,\n  \"Ports\": [\n    {\n      \"Name\": \"PortName\",\n      \"Num\": 1243\n    }\n  ],\n  \"RegionConfigurations\": [\n    {\n      \"Region\": \"EastUs\",\n      \"MaxServers\": 10,\n      \"StandbyServers\": 5\n    },\n    {\n      \"Region\": \"WestUs\",\n      \"MaxServers\": 12,\n      \"StandbyServers\": 8\n    },\n    {\n      \"Region\": \"NorthEurope\",\n      \"MaxServers\": 7,\n      \"StandbyServers\": 3\n    }\n  ],\n  \"GameCertificateReferences\": [\n    {\n      \"Name\": \"CertName\",\n      \"GsdkAlias\": \"CertGsdkAlias\"\n    }\n  ],\n  \"GameSecretReferences\": [\n    {\n      \"Name\": \"SecretName\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"GameAssetReferences\": [\n    {\n      \"FileName\": \"game.zip\"\n    }\n  ],\n  \"StartMultiplayerServerCommand\": \"gameserver.exe -startserver\",\n  \"InstrumentationConfiguration\": {\n    \"ProcessesToMonitor\": [\n      \"GameServerProcessName\"\n    ],\n    \"IsEnabled\": true\n  },\n  \"GameWorkingDirectory\": \"C:\\\\Assets\",\n  \"IsOSPreview\": false,\n  \"VmSize\": \"Standard_D2_v2\",\n  \"MultiplayerServerCountPerVm\": 10,\n  \"Ports\": [\n    {\n      \"Name\": \"PortName\",\n      \"Num\": 1243\n    }\n  ],\n  \"RegionConfigurations\": [\n    {\n      \"Region\": \"EastUs\",\n      \"MaxServers\": 10,\n      \"StandbyServers\": 5\n    },\n    {\n      \"Region\": \"WestUs\",\n      \"MaxServers\": 12,\n      \"StandbyServers\": 8\n    },\n    {\n      \"Region\": \"NorthEurope\",\n      \"MaxServers\": 7,\n      \"StandbyServers\": 3\n    }\n  ],\n  \"GameCertificateReferences\": [\n    {\n      \"Name\": \"CertName\",\n      \"GsdkAlias\": \"CertGsdkAlias\"\n    }\n  ],\n  \"GameSecretReferences\": [\n    {\n      \"Name\": \"SecretName\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"GameAssetReferences\": [\n    {\n      \"FileName\": \"game.zip\"\n    }\n  ],\n  \"StartMultiplayerServerCommand\": \"gameserver.exe -startserver\",\n  \"InstrumentationConfiguration\": {\n    \"ProcessesToMonitor\": [\n      \"GameServerProcessName\"\n    ],\n    \"IsEnabled\": true\n  },\n  \"GameWorkingDirectory\": \"C:\\\\Assets\",\n  \"IsOSPreview\": false,\n  \"VmSize\": \"Standard_D2_v2\",\n  \"MultiplayerServerCountPerVm\": 10,\n  \"Ports\": [\n    {\n      \"Name\": \"PortName\",\n      \"Num\": 1243\n    }\n  ],\n  \"RegionConfigurations\": [\n    {\n      \"Region\": \"EastUs\",\n      \"MaxServers\": 10,\n      \"StandbyServers\": 5\n    },\n    {\n      \"Region\": \"WestUs\",\n      \"MaxServers\": 12,\n      \"StandbyServers\": 8\n    },\n    {\n      \"Region\": \"NorthEurope\",\n      \"MaxServers\": 7,\n      \"StandbyServers\": 3\n    }\n  ],\n  \"GameCertificateReferences\": [\n    {\n      \"Name\": \"CertName\",\n      \"GsdkAlias\": \"CertGsdkAlias\"\n    }\n  ],\n  \"GameSecretReferences\": [\n    {\n      \"Name\": \"SecretName\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "StartMultiplayerServerCommand": "gameserver.exe -startserver",
    "InstrumentationConfiguration": {
      "ProcessesToMonitor": [
        "GameServerProcessName"
      ],
      "IsEnabled": true
    },
    "GameWorkingDirectory": "C:\\Assets",
    "IsOSPreview": false,
    "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
    "BuildName": "GameBuildName",
    "CreationTime": "2014-04-07T09:04:28",
    "Metadata": {
      "MetadataKey": "MetadataValue"
    },
    "VmSize": "Standard_D2_v2",
    "ServerType": "Process",
    "ContainerFlavor": "Invalid",
    "Ports": [
      {
        "Name": "PortName",
        "Num": 1243
      }
    ],
    "RegionConfigurations": [
      {
        "Region": "EastUs",
        "Status": "Initializing",
        "MaxServers": 10,
        "StandbyServers": 5
      },
      {
        "Region": "WestUs",
        "Status": "Succeeded",
        "MaxServers": 12,
        "StandbyServers": 8
      },
      {
        "Region": "NorthEurope",
        "Status": "Unhealthy",
        "MaxServers": 7,
        "StandbyServers": 3
      }
    ],
    "GameAssetReferences": [
      {
        "FileName": "gameserver.zip"
      }
    ],
    "GameCertificateReferences": [
      {
        "Name": "CertName",
        "GsdkAlias": "CertGsdkAlias"
      }
    ],
    "GameSecretReferences": [
      {
        "Name": "SecretName"
      }
    ],
    "MultiplayerServerCountPerVm": 10
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

使用處理序型伺服器建立組建

Error codes

授權

主體

回應