기술 자료

QoS Discovery API

QoS Discovery API

QoS Discovery

Overview

The QoS Discovery API enables clients to query the connection info of QoS servers in their regions of interest. Clients can use these servers to measure each region's quality of service (QoS) and make informed decisions to provide the best experience.
All responses are in JSON format and follow the JSON:API specification.
Download OpenAPI specification:

Get Servers

Query for QoS servers with optional filters.
This endpoint returns a list of QoS server connection information that you can use to determine connection quality between a client and a given region. You can filter the response to only include servers in the specified regions or servers used by a specified service.
Note: Multiplay service is deprecated.
Authorizations
Client
HTTP: Client
HTTP Authorization Scheme: bearer

Query parameters for "{title}"

region

array
No description

service

string
The service for which the client is requesting QoS servers. Valid values are:
  • relay
Note: Multiplay service is deprecated.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://qos-discovery.services.api.unity.com/v1/servers"

Response example

{ "data": { "servers": [ { "region": "us-east1", "services": [ "relay" ], "endpoints": [ "127.0.0.1:9999", "[::1]:9999" ] } ] }}

Get Service Servers

Query for QoS servers for a specific service with optional filters.
This endpoint returns a list of QoS server connection information that you can use to determine connection quality between a client and a given server.
Note: Multiplay service is deprecated.
Authorizations
Client
HTTP: Client
HTTP Authorization Scheme: bearer

Path parameters for "{title}"

serviceId

string
필수
The service for which the client is requesting QoS servers. Valid values are:
  • relay
Note: Multiplay service is deprecated.

Query parameters for "{title}"

region

array
No description

fleet

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://qos-discovery.services.api.unity.com/v1/services/{serviceId}/servers"

Response example

{ "data": { "servers": [ { "region": "us-east1", "endpoints": [ "127.0.0.1:9999", "[::1]:9999" ], "annotations": { "service": [ "multiplay" ], "fleet": [ "fleet1", "fleet2" ] } } ] }}