Skip to main content

AsyncAPI for dedicated server manager controller service 0.0.1 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

Table of Contents

Operations

PUB dsmcontroller Operation

Accepts one of the following messages:

Message allocationComplete

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.serverstringserver name---
payload.allocationEventsarray<object>----
payload.allocationEvents.time_stampstring--format (date-time)-
payload.allocationEvents.typestring----
payload.allocationEvents.descriptionstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
target_namespacestring----
timestampstring--format (date-time)-
topicstring----
servicestring----
sessionIdstring----
traceIdstring----
userIdstring----
clientIdstring----

Examples of payload (generated)

{
"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"
}

Message dsClaimed

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.dsClaimedbooleands claimed or not---
payload.sessionIDstringsession ID---
payload.dsClaimedAtstring--format (date-time)-
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
target_namespacestring----
timestampstring--format (date-time)-
topicstring----
servicestring----
sessionIdstring----
traceIdstring----
userIdstring----
clientIdstring----

Examples of payload (generated)

{
"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"
}

Message dsCount

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject----
payload (additional properties)object----
payload (additional properties)integer----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
target_namespacestring----
timestampstring--format (date-time)-
topicstring----
servicestring----
sessionIdstring----
traceIdstring----
userIdstring----
clientIdstring----

Examples of payload (generated)

{
"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"
}

Message dsStatusChanged

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.serverobject---additional properties are allowed
payload.server.allocation_eventsarray<object>----
payload.server.allocation_events.time_stampstring--format (date-time)-
payload.server.allocation_events.typestring----
payload.server.allocation_events.descriptionstring----
payload.server.allocation_idstringnomad allocation id---
payload.server.alternate_ipsarray<string>----
payload.server.alternate_ips (single item)string----
payload.server.cpu_limitintegerserver cpu limit---
payload.server.created_atstring--format (date-time)-
payload.server.custom_attributestring----
payload.server.deploymentstringthe name of deployment---
payload.server.game_versionstringthe game version used in server---
payload.server.image_versionstringthe image version used in server---
payload.server.ipstringserver IP address---
payload.server.is_override_game_versionboolean----
payload.server.job_idstringjob id---
payload.server.last_updatestring--format (date-time)-
payload.server.mem_limitintegerserver memory limit---
payload.server.namespacestringserver namespace---
payload.server.paramsstring----
payload.server.pod_namestring----
payload.server.portinteger----
payload.server.portsobject----
payload.server.ports (additional properties)integer----
payload.server.protocolstring----
payload.server.providerstringinfrastructure provider---
payload.server.regionstringserver region---
payload.server.session_idstringsession id---
payload.server.statusstringserver statusallowed ("CREATING", "READY", "BUSY", "REMOVING", "UNREACHABLE", "FAILED")--
payload.server.status_historyarray<object>----
payload.server.status_history.time_stampstring--format (date-time)-
payload.server.status_history.statusstringassigned server statusallowed ("CREATING", "READY", "BUSY", "REMOVING", "UNREACHABLE", "FAILED")--
payload.server.is_core_dump_enabledboolean----
payload.server.artifact_pathstringartifact path. Not empty if provided by the image config.---
payload.isBufferedboolean----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
target_namespacestring----
timestampstring--format (date-time)-
topicstring----
servicestring----
sessionIdstring----
traceIdstring----
userIdstring----
clientIdstring----

Examples of payload (generated)

{
"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"
}

Message sessionEnded

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.sessionobject---additional properties are allowed
payload.session.idstringsession id---
payload.session.namespacestringsession namespace---
payload.session.providerstringinfrastructure provider---
payload.session.regionstringsession namespace---
payload.session.Serverobject---additional properties are allowed
payload.session.Server.allocation_eventsarray<object>----
payload.session.Server.allocation_events.time_stampstring--format (date-time)-
payload.session.Server.allocation_events.typestring----
payload.session.Server.allocation_events.descriptionstring----
payload.session.Server.allocation_idstringnomad allocation id---
payload.session.Server.alternate_ipsarray<string>----
payload.session.Server.alternate_ips (single item)string----
payload.session.Server.cpu_limitintegerserver cpu limit---
payload.session.Server.created_atstring--format (date-time)-
payload.session.Server.custom_attributestring----
payload.session.Server.deploymentstringthe name of deployment---
payload.session.Server.game_versionstringthe game version used in server---
payload.session.Server.image_versionstringthe image version used in server---
payload.session.Server.ipstringserver IP address---
payload.session.Server.is_override_game_versionboolean----
payload.session.Server.job_idstringjob id---
payload.session.Server.last_updatestring--format (date-time)-
payload.session.Server.mem_limitintegerserver memory limit---
payload.session.Server.namespacestringserver namespace---
payload.session.Server.paramsstring----
payload.session.Server.pod_namestring----
payload.session.Server.portinteger----
payload.session.Server.portsobject----
payload.session.Server.ports (additional properties)integer----
payload.session.Server.protocolstring----
payload.session.Server.providerstringinfrastructure provider---
payload.session.Server.regionstringserver region---
payload.session.Server.session_idstringsession id---
payload.session.Server.statusstringserver statusallowed ("CREATING", "READY", "BUSY", "REMOVING", "UNREACHABLE", "FAILED")--
payload.session.Server.status_historyarray<object>----
payload.session.Server.status_history.time_stampstring--format (date-time)-
payload.session.Server.status_history.statusstringassigned server statusallowed ("CREATING", "READY", "BUSY", "REMOVING", "UNREACHABLE", "FAILED")--
payload.session.Server.is_core_dump_enabledboolean----
payload.session.Server.artifact_pathstringartifact path. Not empty if provided by the image config.---
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
target_namespacestring----
timestampstring--format (date-time)-
topicstring----
servicestring----
sessionIdstring----
traceIdstring----
userIdstring----
clientIdstring----

Examples of payload (generated)

{
"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"
}