With the HostCapacityTemplate element you can define how many game instances you want deployed on any specified BM instance types and / or VM instance types. The actual definitions of the instance types and capacities themselves are defined in the InstanceTypeCapacity elements, which are assigned to this HostCapacityTemplate upon creation.

Element Structure

Table 1: HostCapacityTemplate element structure

API example

Create a new HostCapacityTemplate within your i3D.net account.

HTTP request

Request body

Response body

Assignment to a Fleet

A HostCapacityTemplate can be assigned to a . Here is a simple example to show you how:

HTTP request

Request body

Response body

Assignment to an ApplicationBuild

A HostCapacityTemplate can also be assigned to an . This will override a HostCapacityTemplate set in the Fleet. This is useful if you want to test optimizations of a new build, to see if you can deploy more game instances than before.

HTTP request

Request body

Response body

Related element

This element contains a list of elements.

The InstanceTypeCapacity element is a child of the HostCapacityTemplate and defines how many game instances you want deployed on a certain BM instance type and / or VM instance type. during creation, you provide the ID of the HostCapacityTemplate that you want this element to become part of.

Element Structure

Table 1: InstanceTypeCapacity element structure

Obtaining BM and VM instance types

You can get a list of BM instance types using the /host/instanceType endpoint.

You can get a list of VM instance types using the /cloud/instanceType endpoint.

Note that within this InstanceTypeCapacity element you must provide the name of the instance type and not the ID. This is because the HostCapacityTemplate is region agnostic and therefore we have to use the names and not the IDs of the instance types.

Capacity explained

The capacity you indicate is related to the amount of physical cores in a machine. It is therefore important to differentiate between BMs and VMs, because the core count of VMs is usually indicated as vCpus, which are based on logical cores (threads) and not physical cores.

The maximum number of game server instances you can deploy per physical core is 60.

The following table illustrates a few different examples:

Assignment to a HostCapacityTemplate

Assignment of an InstanceTypeCapacity element to a HostCapacityTemplate is done during creation of this element by providing the ID of the HostCapacityTemplate in the hostCapacityTemplateId property.

API example

Create a new InstanceTypeCapacity for an already existing HostCapacityTemplate.

HTTP request

Request body

Response body

Related element

This element is a child of the element.