AsyncAPI for dedicated server manager controller service 0.0.1 documentation

• Protobuf File Spec: dsm.proto

Published Messages (dsmcontroller)

The service publishes one of these messages below.

allocationComplete

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "server": "string",
    "allocationEvents": [
      {
        "time_stamp": "2019-08-24T14:15:22Z",
        "type": "string",
        "description": "string"
      }
    ]
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "target_namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "topic": "string",
  "service": "string",
  "sessionId": "string",
  "traceId": "string",
  "userId": "string",
  "clientId": "string"
}

payload

Name	Type	Description
server	string	server name
allocationEvents	array<allocationEvent>	-

dsClaimed

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "dsClaimed": true,
    "sessionID": "string",
    "dsClaimedAt": "2019-08-24T14:15:22Z"
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "target_namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "topic": "string",
  "service": "string",
  "sessionId": "string",
  "traceId": "string",
  "userId": "string",
  "clientId": "string"
}

payload

Name	Type	Description
dsClaimed	boolean	ds claimed or not
sessionID	string	session ID
dsClaimedAt	string (date-time)	-

dsCount

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "target_namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "topic": "string",
  "service": "string",
  "sessionId": "string",
  "traceId": "string",
  "userId": "string",
  "clientId": "string"
}

payload

This is a free-form object.

dsStatusChanged

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "server": {
      "allocation_events": [
        {
          "time_stamp": "2019-08-24T14:15:22Z",
          "type": "string",
          "description": "string"
        }
      ],
      "allocation_id": "string",
      "alternate_ips": [
        "string"
      ],
      "cpu_limit": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "custom_attribute": "string",
      "deployment": "string",
      "game_version": "string",
      "image_version": "string",
      "ip": "string",
      "is_override_game_version": true,
      "job_id": "string",
      "last_update": "2019-08-24T14:15:22Z",
      "mem_limit": 0,
      "namespace": "string",
      "params": "string",
      "pod_name": "string",
      "port": 0,
      "ports": {
        "property1": 0,
        "property2": 0
      },
      "protocol": "string",
      "provider": "string",
      "region": "string",
      "session_id": "string",
      "status": "CREATING",
      "status_history": [
        {
          "time_stamp": "2019-08-24T14:15:22Z",
          "status": "CREATING"
        }
      ],
      "is_core_dump_enabled": true,
      "artifact_path": "string"
    },
    "isBuffered": true
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "target_namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "topic": "string",
  "service": "string",
  "sessionId": "string",
  "traceId": "string",
  "userId": "string",
  "clientId": "string"
}

payload

Name	Type	Description
server	server	-
isBuffered	boolean	-

sessionEnded

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "session": {
      "id": "string",
      "namespace": "string",
      "provider": "string",
      "region": "string",
      "Server": {
        "allocation_events": [
          {
            "time_stamp": "2019-08-24T14:15:22Z",
            "type": "string",
            "description": "string"
          }
        ],
        "allocation_id": "string",
        "alternate_ips": [
          "string"
        ],
        "cpu_limit": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "custom_attribute": "string",
        "deployment": "string",
        "game_version": "string",
        "image_version": "string",
        "ip": "string",
        "is_override_game_version": true,
        "job_id": "string",
        "last_update": "2019-08-24T14:15:22Z",
        "mem_limit": 0,
        "namespace": "string",
        "params": "string",
        "pod_name": "string",
        "port": 0,
        "ports": {
          "property1": 0,
          "property2": 0
        },
        "protocol": "string",
        "provider": "string",
        "region": "string",
        "session_id": "string",
        "status": "CREATING",
        "status_history": [
          {
            "time_stamp": "2019-08-24T14:15:22Z",
            "status": "CREATING"
          }
        ],
        "is_core_dump_enabled": true,
        "artifact_path": "string"
      }
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "target_namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "topic": "string",
  "service": "string",
  "sessionId": "string",
  "traceId": "string",
  "userId": "string",
  "clientId": "string"
}

payload

Name	Type	Description
session	object	-

payload.session

Name	Type	Description
id	string	session id
namespace	string	session namespace
provider	string	infrastructure provider
region	string	session namespace
Server	server	-

Schemas

allocationEvent

Name	Type	Description
time_stamp	string (date-time)	-
type	string	-
description	string	-

server

Name	Type	Description
allocation_events	array<allocationEvent>	-
allocation_id	string	nomad allocation id
alternate_ips	array	-
cpu_limit	integer	server cpu limit
created_at	string (date-time)	-
custom_attribute	string	-
deployment	string	the name of deployment
game_version	string	the game version used in server
image_version	string	the image version used in server
ip	string	server IP address
is_override_game_version	boolean	-
job_id	string	job id
last_update	string (date-time)	-
mem_limit	integer	server memory limit
namespace	string	server namespace
params	string	-
pod_name	string	-
port	integer	-
ports	object	-
protocol	string	-
provider	string	infrastructure provider
region	string	server region
session_id	string	session id
status	string	server status
status_history	array<object>	-
is_core_dump_enabled	boolean	-
artifact_path	string	artifact path. Not empty if provided by the image config.

ports

This is a free-form object.

status_history[number]

Name	Type	Description
time_stamp	string (date-time)	-
status	string	assigned server status

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
target_namespace	string	-
timestamp	string (date-time)	-
topic	string	-
service	string	-
sessionId	string	-
traceId	string	-
userId	string	-
clientId	string	-