Enumerar servidores multijugador archivados

Lists archived multiplayer server sessions for a build.

Allowed entity token types: title

Error codes

This operation may return the following PlayFab errors:

Error	Code
APINotEnabledForGameClientAccess	1082
MultiplayerServerBadRequest	1382
MultiplayerServerForbidden	1384
MultiplayerServerInternalServerError	1387
MultiplayerServerNotFound	1385
MultiplayerServerUnauthorized	1383
MultiplayerServerUnavailable	1388
ProductDisabledForTitle	1609

POST

MultiplayerServer

ListArchivedMultiplayerServers

List Archived Multiplayer Servers

curl --request POST \
  --url https://{titleId}.playfabapi.com/MultiplayerServer/ListArchivedMultiplayerServers \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "Region": "SouthCentralUs"
}
'

import requests

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

payload = {
    "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
    "Region": "SouthCentralUs"
}
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({BuildId: '21781fa8-096d-4d9c-b699-75433d579285', Region: 'SouthCentralUs'})
};

fetch('https://{titleId}.playfabapi.com/MultiplayerServer/ListArchivedMultiplayerServers', 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/ListArchivedMultiplayerServers",
  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([
    'BuildId' => '21781fa8-096d-4d9c-b699-75433d579285',
    'Region' => 'SouthCentralUs'
  ]),
  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/ListArchivedMultiplayerServers"

	payload := strings.NewReader("{\n  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\"\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/ListArchivedMultiplayerServers")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "MultiplayerServerSummaries": [
      {
        "ServerId": "AMultiplayerGameServer",
        "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c",
        "VmId": "VmID1",
        "Region": "SouthCentralUs",
        "State": "Active",
        "ConnectedPlayers": [
          {
            "PlayerId": "10931352888739351331"
          },
          {
            "PlayerId": "10271352123739051532"
          }
        ],
        "IPV4Address": "10.250.24.54",
        "FQDN": "vm.azure.cloudapp.net",
        "Ports": [
          {
            "Name": "PortName",
            "Num": 1243
          }
        ]
      },
      {
        "ServerId": "SomeOtherMultiplayerGameServer",
        "SessionId": "82bdef0e-a21e-3b29-8efe-ff9e57a08c1d",
        "VmId": "VmID2",
        "Region": "SouthCentralUs",
        "State": "Terminated",
        "ConnectedPlayers": [],
        "IPV4Address": "10.250.24.54",
        "FQDN": "vm.azure.cloudapp.net",
        "Ports": [
          {
            "Name": "PortName",
            "Num": 1243
          }
        ]
      }
    ]
  }
}

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

Autorizaciones

X-EntityToken

string

header

requerido

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

Cuerpo

application/json

Returns a list of multiplayer servers for a build in a specific region.

BuildId

string

requerido

The guid string build ID of the multiplayer servers to list.

Region

enum<string>

requerido

The region the multiplayer servers to list.

Opciones disponibles:

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

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.

Respuesta

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

Ejemplo:

{
  "MultiplayerServerSummaries": [
    {
      "ServerId": "AMultiplayerGameServer",
      "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c",
      "VmId": "VmID1",
      "Region": "SouthCentralUs",
      "State": "Active",
      "ConnectedPlayers": [
        { "PlayerId": "10931352888739351331" },
        { "PlayerId": "10271352123739051532" }
      ],
      "IPV4Address": "10.250.24.54",
      "FQDN": "vm.azure.cloudapp.net",
      "Ports": [{ "Name": "PortName", "Num": 1243 }]
    },
    {
      "ServerId": "SomeOtherMultiplayerGameServer",
      "SessionId": "82bdef0e-a21e-3b29-8efe-ff9e57a08c1d",
      "VmId": "VmID2",
      "Region": "SouthCentralUs",
      "State": "Terminated",
      "ConnectedPlayers": [],
      "IPV4Address": "10.250.24.54",
      "FQDN": "vm.azure.cloudapp.net",
      "Ports": [{ "Name": "PortName", "Num": 1243 }]
    }
  ]
}

Última modificación el 6 de octubre de 2026

Temas relacionados

Enumerar servidores multijugador Archivado y recuperación de los registros de servidores multijugador Enumerar cambios de cuota de servidores multijugador del título Página de información general de servidores Servidores

⌘I

List Archived Multiplayer Servers

curl --request POST \
  --url https://{titleId}.playfabapi.com/MultiplayerServer/ListArchivedMultiplayerServers \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
  "Region": "SouthCentralUs"
}
'

import requests

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

payload = {
    "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
    "Region": "SouthCentralUs"
}
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({BuildId: '21781fa8-096d-4d9c-b699-75433d579285', Region: 'SouthCentralUs'})
};

fetch('https://{titleId}.playfabapi.com/MultiplayerServer/ListArchivedMultiplayerServers', 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/ListArchivedMultiplayerServers",
  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([
    'BuildId' => '21781fa8-096d-4d9c-b699-75433d579285',
    'Region' => 'SouthCentralUs'
  ]),
  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/ListArchivedMultiplayerServers"

	payload := strings.NewReader("{\n  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\"\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/ListArchivedMultiplayerServers")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n  \"Region\": \"SouthCentralUs\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "MultiplayerServerSummaries": [
      {
        "ServerId": "AMultiplayerGameServer",
        "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c",
        "VmId": "VmID1",
        "Region": "SouthCentralUs",
        "State": "Active",
        "ConnectedPlayers": [
          {
            "PlayerId": "10931352888739351331"
          },
          {
            "PlayerId": "10271352123739051532"
          }
        ],
        "IPV4Address": "10.250.24.54",
        "FQDN": "vm.azure.cloudapp.net",
        "Ports": [
          {
            "Name": "PortName",
            "Num": 1243
          }
        ]
      },
      {
        "ServerId": "SomeOtherMultiplayerGameServer",
        "SessionId": "82bdef0e-a21e-3b29-8efe-ff9e57a08c1d",
        "VmId": "VmID2",
        "Region": "SouthCentralUs",
        "State": "Terminated",
        "ConnectedPlayers": [],
        "IPV4Address": "10.250.24.54",
        "FQDN": "vm.azure.cloudapp.net",
        "Ports": [
          {
            "Name": "PortName",
            "Num": 1243
          }
        ]
      }
    ]
  }
}

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

PlayFab API

PlayFab REST API References

Enumerar servidores multijugador archivados

Error codes

Autorizaciones

Cuerpo

Respuesta