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.

• Specification ID: urn:net:accelbyte:dsmcontroller
• Protobuf File Spec: dsmc.proto
• Default content type: application/json

Table of Contents

• Operations
  • PUB dsmcontroller

Operations

PUB dsmcontroller Operation

Accepts one of the following messages:

Message allocationComplete

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.server	string	server name	-	-	-
payload.allocationEvents	array<object>	-	-	-	-
payload.allocationEvents.time_stamp	string	-	-	format (date-time)	-
payload.allocationEvents.type	string	-	-	-	-
payload.allocationEvents.description	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
target_namespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
topic	string	-	-	-	-
service	string	-	-	-	-
sessionId	string	-	-	-	-
traceId	string	-	-	-	-
userId	string	-	-	-	-
clientId	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.dsClaimed	boolean	ds claimed or not	-	-	-
payload.sessionID	string	session ID	-	-	-
payload.dsClaimedAt	string	-	-	format (date-time)	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
target_namespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
topic	string	-	-	-	-
service	string	-	-	-	-
sessionId	string	-	-	-	-
traceId	string	-	-	-	-
userId	string	-	-	-	-
clientId	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	-
payload (additional properties)	object	-	-	-	-
payload (additional properties)	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
target_namespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
topic	string	-	-	-	-
service	string	-	-	-	-
sessionId	string	-	-	-	-
traceId	string	-	-	-	-
userId	string	-	-	-	-
clientId	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.server	object	-	-	-	additional properties are allowed
payload.server.allocation_events	array<object>	-	-	-	-
payload.server.allocation_events.time_stamp	string	-	-	format (date-time)	-
payload.server.allocation_events.type	string	-	-	-	-
payload.server.allocation_events.description	string	-	-	-	-
payload.server.allocation_id	string	nomad allocation id	-	-	-
payload.server.alternate_ips	array<string>	-	-	-	-
payload.server.alternate_ips (single item)	string	-	-	-	-
payload.server.cpu_limit	integer	server cpu limit	-	-	-
payload.server.created_at	string	-	-	format (date-time)	-
payload.server.custom_attribute	string	-	-	-	-
payload.server.deployment	string	the name of deployment	-	-	-
payload.server.game_version	string	the game version used in server	-	-	-
payload.server.image_version	string	the image version used in server	-	-	-
payload.server.ip	string	server IP address	-	-	-
payload.server.is_override_game_version	boolean	-	-	-	-
payload.server.job_id	string	job id	-	-	-
payload.server.last_update	string	-	-	format (date-time)	-
payload.server.mem_limit	integer	server memory limit	-	-	-
payload.server.namespace	string	server namespace	-	-	-
payload.server.params	string	-	-	-	-
payload.server.pod_name	string	-	-	-	-
payload.server.port	integer	-	-	-	-
payload.server.ports	object	-	-	-	-
payload.server.ports (additional properties)	integer	-	-	-	-
payload.server.protocol	string	-	-	-	-
payload.server.provider	string	infrastructure provider	-	-	-
payload.server.region	string	server region	-	-	-
payload.server.session_id	string	session id	-	-	-
payload.server.status	string	server status	allowed ("CREATING", "READY", "BUSY", "REMOVING", "UNREACHABLE", "FAILED")	-	-
payload.server.status_history	array<object>	-	-	-	-
payload.server.status_history.time_stamp	string	-	-	format (date-time)	-
payload.server.status_history.status	string	assigned server status	allowed ("CREATING", "READY", "BUSY", "REMOVING", "UNREACHABLE", "FAILED")	-	-
payload.server.is_core_dump_enabled	boolean	-	-	-	-
payload.server.artifact_path	string	artifact path. Not empty if provided by the image config.	-	-	-
payload.isBuffered	boolean	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
target_namespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
topic	string	-	-	-	-
service	string	-	-	-	-
sessionId	string	-	-	-	-
traceId	string	-	-	-	-
userId	string	-	-	-	-
clientId	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.session	object	-	-	-	additional properties are allowed
payload.session.id	string	session id	-	-	-
payload.session.namespace	string	session namespace	-	-	-
payload.session.provider	string	infrastructure provider	-	-	-
payload.session.region	string	session namespace	-	-	-
payload.session.Server	object	-	-	-	additional properties are allowed
payload.session.Server.allocation_events	array<object>	-	-	-	-
payload.session.Server.allocation_events.time_stamp	string	-	-	format (date-time)	-
payload.session.Server.allocation_events.type	string	-	-	-	-
payload.session.Server.allocation_events.description	string	-	-	-	-
payload.session.Server.allocation_id	string	nomad allocation id	-	-	-
payload.session.Server.alternate_ips	array<string>	-	-	-	-
payload.session.Server.alternate_ips (single item)	string	-	-	-	-
payload.session.Server.cpu_limit	integer	server cpu limit	-	-	-
payload.session.Server.created_at	string	-	-	format (date-time)	-
payload.session.Server.custom_attribute	string	-	-	-	-
payload.session.Server.deployment	string	the name of deployment	-	-	-
payload.session.Server.game_version	string	the game version used in server	-	-	-
payload.session.Server.image_version	string	the image version used in server	-	-	-
payload.session.Server.ip	string	server IP address	-	-	-
payload.session.Server.is_override_game_version	boolean	-	-	-	-
payload.session.Server.job_id	string	job id	-	-	-
payload.session.Server.last_update	string	-	-	format (date-time)	-
payload.session.Server.mem_limit	integer	server memory limit	-	-	-
payload.session.Server.namespace	string	server namespace	-	-	-
payload.session.Server.params	string	-	-	-	-
payload.session.Server.pod_name	string	-	-	-	-
payload.session.Server.port	integer	-	-	-	-
payload.session.Server.ports	object	-	-	-	-
payload.session.Server.ports (additional properties)	integer	-	-	-	-
payload.session.Server.protocol	string	-	-	-	-
payload.session.Server.provider	string	infrastructure provider	-	-	-
payload.session.Server.region	string	server region	-	-	-
payload.session.Server.session_id	string	session id	-	-	-
payload.session.Server.status	string	server status	allowed ("CREATING", "READY", "BUSY", "REMOVING", "UNREACHABLE", "FAILED")	-	-
payload.session.Server.status_history	array<object>	-	-	-	-
payload.session.Server.status_history.time_stamp	string	-	-	format (date-time)	-
payload.session.Server.status_history.status	string	assigned server status	allowed ("CREATING", "READY", "BUSY", "REMOVING", "UNREACHABLE", "FAILED")	-	-
payload.session.Server.is_core_dump_enabled	boolean	-	-	-	-
payload.session.Server.artifact_path	string	artifact path. Not empty if provided by the image config.	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
target_namespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
topic	string	-	-	-	-
service	string	-	-	-	-
sessionId	string	-	-	-	-
traceId	string	-	-	-	-
userId	string	-	-	-	-
clientId	string	-	-	-	-

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