Schemas

UUID or name of the instance to attach the volume to.

Path of the mountpoint.

The path must be absolute, not contain . and .. components, and not contain colons (:). The path must point to an empty directory. If the directory does not exist, it is created.

The UUID of the volume to attach. Mutually exclusive with name. Exactly one of uuid or name must be provided.

The name of the volume to attach. Mutually exclusive with UUID. Exactly one of uuid or name must be provided.

Whether the volume should be mounted read-only.

The status of the response.

The UUID of the volume that was attached.

The name of the volume that was attached.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The volume(s) which were attached by the request.

The name of the policy.

If the policy is enabled.

Metric to use for the step policy.

The type of adjustment to be made in the step policy.

The steps for the step policy. Each step defines an adjustment value and optional bounds.

The adjustment value for the step.

Lower bound for the step.

Upper bound for the step.

The UUID of the certificate.

This is a unique identifier for the certificate that is generated when the certificate is created. The UUID is used to reference the certificate in API calls and can be used to identify the certificate in all API calls that require an identifier.

The name of the certificate.

This is a human-readable name that can be used to identify the certificate. The name must be unique within the context of your account. The name can also be used to identify the certificate in API calls.

The time the certificate was created.

The common name (CN) field from the certificate's subject.

This is typically the primary domain name that the certificate is issued for. It represents the main identity that the certificate validates.

The complete subject distinguished name (DN) of the certificate.

This contains the full subject information from the certificate, including the common name, organization, organizational unit, locality, state, and country. The subject identifies the entity that the certificate is issued to.

The complete issuer distinguished name (DN) of the certificate.

This identifies the Certificate Authority (CA) that issued the certificate. It contains information about the CA including its common name, organization, and country.

The unique serial number assigned to the certificate by the issuing CA.

This is a unique identifier within the scope of the issuing CA that can be used to identify and track the certificate. Serial numbers are typically represented as hexadecimal strings.

The date and time when the certificate becomes valid.

The certificate should not be trusted before this date. This timestamp marks the beginning of the certificate's validity period.

The date and time when the certificate expires.

The certificate should not be trusted after this date. This timestamp marks the end of the certificate's validity period. Certificates should be renewed before this date to maintain service availability.

The current state of the certificate.

This indicates whether the certificate is pending issuance, valid and ready for use, or in an error state. See CertificateState enum for detailed state descriptions.

An optional field representing the status of the request. This field is only set when this message object is used as a response message.

An optional message providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

An optional error code providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

The UUID of the service to create a configuration for. Mutually exclusive with name.

The minimum number of instances to keep running.

The maximum number of instances to keep running.

The warmup time in milliseconds for new instances.

The cooldown time in milliseconds for the autoscale configuration.

The arguments to use when creating the autoscale configuration.

The policies to apply to the autoscale configuration.

The Name of the service to add a policy to.

The policy type to add to the autoscale configuration.

The policies which were added by the request.

The status of the response.

The UUID of the service of the added policy.

The name of the service of the added policy.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The UUID of the service to create a configuration for. Mutually exclusive with name.

The name of the service to create a configuration for. Mutually exclusive with UUID.

The minimum number of instances to keep running.

The maximum number of instances to keep running.

The warmup time in milliseconds for new instances.

The cooldown time in milliseconds for the autoscale configuration.

The arguments to use when creating the autoscale configuration.

The policies to apply to the autoscale configuration.

The status of the response.

The UUID of the service where the configuration was created.

The name of the service where the configuration was created.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The configuration(s) which were created by the request.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The certificate which was created by this request.

Note: only one certificate can be specified in the request, so this will always contain a single entry.

The image to use for the instance.

(Optional). The name of the instance.

If not provided, a random name will be generated. The name must be unique.

(Optional). The arguments to pass to the instance when it starts.

(Optional). Environment variables to set for the instance.

(Optional). Memory in MB to allocate for the instance. Default is 128.

(Optional). The service group configuration when creating an instance.

When creating an instance, either a previously created (persistent) service group can be referenced (either through its name or UUID), or a new (ephemeral) service group can be created for the instance by specifying the list of services it should expose and optionally the domains it should use.

Volumes to attach to the instance.

This list can contain both existing and new volumes to create as part of the instance creation. Existing volumes can be referenced by their name or UUID. New volumes can be created by specifying a name, size in MiB, and mount point in the instance. The mount point is the directory in the instance where the volume will be mounted.

Whether the instance should start automatically on creation.

Number of replicas for the instance.

Restart policy for the instance. This defines how the instance should behave when it stops or crashes.

Scale-to-zero configuration for the instance.

Number of vCPUs to allocate for the instance.

Timeout to wait for all new instances to reach running state in milliseconds. If you autostart your new instance, you can wait for it to finish starting with a blocking API call if you specify a wait timeout greater than zero. No wait performed for a value of 0.

Features to enable for the instance. Features are specific configurations or capabilities that can be enabled for the instance.

The mount point for the volume in the instance.

The UUID of an existing volume.

If this is the only specified field, then it will look up an existing volume by this UUID.

The name of the volume.

If this is the only specified field, then it will look up an existing volume by this name. If the volume does not exist, the request will fail. If a new volume is intended to be created, then this field must be specified along with the size in MiB and the mount point in the instance.

The size of the volume when creating a new volume.

When creating a new volume as part of the instance create request, specify the size of the volume in MiB.

Whether the volume is read-only.

If this field is set to true, the volume will be mounted as read-only in the instance. This field is optional and defaults to false and is only applicable when using an existing volume.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The instance that was created in this request.

Name of the service group. This is a human-readable name that can be used to identify the service group. The name must be unique within the context of your account. If no name is specified, a random name is generated for you. The name can also be used to identify the service group in API calls.

Description of exposed services.

Description of domains associated with the service group.

The soft limit is used by the Unikraft Cloud load balancer to decide when to wake up another standby instance.

For example, if the soft limit is set to 5 and the service consists of 2 standby instances, one of the instances receives up to 5 concurrent requests. The 6th parallel requests wakes up the second instance. If there are no more standby instances to wake up, the number of requests assigned to each instance will exceed the soft limit. The load balancer makes sure that when the number of in-flight requests goes down again, instances are put into standby as fast as possible.

The hard limit defines the maximum number of concurrent requests that an instance assigned to the this service can handle.

The load balancer will never assign more requests to a single instance. In case there are no other instances available, excess requests fail (i.e., they are blocked and not queued).

Publicly accessible domain name. If this name ends in a period . it must be a valid Full Qualified Domain Name (FQDN), otherwise it will become a subdomain of the target metro.

Use an existing certificate for the domain. If this field is specified, the domain must be associated with a valid certificate.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The service group which was created by this request.

Note: only one service group can be specified in the request, so this will always contain a single entry.

The volume(s) which were created by the request.

The status of the response.

UUID of the newly created volume.

The name of the newly created volume.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The policies which were deleted by the request.

The status of the response.

The name of the service of the deleted policy.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The configuration(s) which were deleted by the request.

The status of the response.

The UUID of the service where the configuration was deleted.

The name of the service where the configuration was deleted.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The certificate(s) which were deleted by the request.

Indicates whether the delete operation was successful or not for this certificate.

The UUID of the certificate which was deleted.

The name of the certificate which was deleted.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The instance(s) which were deleted by the request.

Indicates whether the start operation was successful or not for this instance.

The UUID of the instance which was deleted.

The name of the instance which was deleted.

The previous state of the instance before it was deleted.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The Name of the policy to delete.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The service group(s) which were deleted by the request.

Indicates whether the delete operation was successful or not for this service group.

The UUID of the service group which was deleted.

The name of the service group which was deleted.

An optional message providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

An optional error code providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

The volume(s) which were deleted by the request.

The status of the response.

The UUID of the volume that was deleted.

The name of the volume that was deleted.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

UUID or name of the instance to detach the volume from.

The UUID of the volume to detach. Mutually exclusive with name. Exactly one of uuid or name must be provided.

The name of the volume to detach. Mutually exclusive with UUID. Exactly one of uuid or name must be provided.

UUID or name of the instance to detach the volume from.

The volume(s) which were detached by the request.

The status of the response.

The UUID of the volume that was detached.

The name of the volume that was detached.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The Name of the policy to get.

The policy which was retrieved by the request.

The status of the response.

The policy which was retrieved by the request.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The configuration(s) which were retrieved by the request.

The status of the response.

The UUID of the service where the configuration was created.

The name of the service where the configuration was created.

If the autoscale configuration is enabled.

The minimum number of instances to keep running. Only if enabled is true.

The maximum number of instances to keep running. Only if enabled is true.

The warmup time in seconds for new instances. Only if enabled is true.

The cooldown time in seconds for the autoscale configuration. Only if enabled is true.

The instance template used for the autoscale configuration. Only if enabled is true.

The policies applied to the autoscale configuration.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The certificate(s) which were retrieved by the request.

The status of the response.

An optional message providing additional information about the response.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The instance that was created in this request.

The byte offset of the log output to receive. A negative sign makes the offset relative to the end of the log.

The amount of bytes to return at most.

The UUID of the instance to retrieve logs for. Mutually exclusive with name.

The name of the instance to retrieve logs for. Mutually exclusive with UUID.

The byte offset of the log output to receive. A negative sign makes the offset relative to the end of the log.

The amount of bytes to return at most.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The first byte offset that can be retrieved.

The last byte offset that can be retrieved.

The instance which this requested waited on.

Note: only one instance can be specified in the request, so this will always contain a single entry.

The UUID of the instance.

The name of the instance.

Base64 encoded log output of the instance.

Description of the log availability.

Description of the range that was returned. Useful for requests with offset relative to end.

State of the instance when the logs were retrieved.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The first retrieved byte.

The last retrieved byte.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The instance which this requested metrics for. Note: only one instance can be specified in the request, so this will always contain a single entry.

Resident set size of the VMM in bytes.

The resident set size (RSS) specifies the amount of physical memory that has been touched by the instance and is currently reserved for the instance on the Unikraft Cloud server. The RSS grows until the instance has touched all memory assigned to it via the memory_mb setting and may also exceed this value as supporting services running outside the instance acquire memory. The RSS is different from the current amount of memory allocated by the application, which is likely to fluctuate over the lifetime of the application. The RSS is not a cumulative metric. When the instance is stopped rss goes down to 0.

Consumed CPU time in milliseconds.

The boot time of the instance in microseconds. We take a pragmatic approach is to define the boot time. We calculate this as the difference in time between the moment the virtualization toolstack is invoked to respond to a VM boot request and the moment the OS starts executing user code (i.e., the end of the guest OS boot process). This is essentially the time that a user would experience in a deployment, minus the application initialization time, which we leave out since it is independent from the OS.

This is the time it took for the user-level application to start listening on a non-localhost port measured in microseconds. This is the time from when the instance started until it reasonably ready to start responding to network requests. This is useful for measuring the time it takes for the instance to become operationally ready.

Total amount of bytes received from network.

Total count of packets received from network.

Total amount of bytes transmitted over network.

Total count of packets transmitted over network.

Number of currently established inbound connections (non-HTTP).

Number of in-flight HTTP requests.

Number of queued inbound connections and HTTP requests.

Total number of inbound connections and HTTP requests handled.

An optional message providing additional information about the status. This field is useful when the status is not success.

An optional error code providing additional information about the status. This field is useful when the status is not success.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The instance(s) that were retrieved by the request.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The service group(s) which were retrieved by the request.

The volume(s) which were retrieved by the request.

The status of the response.

An optional message providing additional information about the response.

A list of errors which may have occurred during the request.

The response data for this request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The canonical name of the image is known as the "tag".

The digest of the image is a unique identifier of the image manifest which is a string representation including the hashing algorithm and the hash value separated by a colon.

A description of the image.

When the image was created.

The architecture of the image.

The entrypoint of the image is the command that is run when the image is started.

The command to run when the image is started.

The environment variables to set when the image is started.

Documented port mappings for the image.

Documented volumes for the image.

Labels are key-value pairs.

The working directory for the image is the directory that is set as the current working directory when the image is started.

The kernel object is a reference to the kernel that is used by the image.

List of auxiliary ROMs that are used by the image.

The UUID of the instance.

This is a unique identifier for the instance that is generated when the instance is created. The UUID is used to reference the instance in API calls and can be used to identify the instance in all API calls that require an instance identifier.

The name of the instance.

This is a human-readable name that can be used to identify the instance. The name must be unique within the context of your account. The name can also be used to identify the instance in API calls.

The time the instance was created.

The state of the instance. This indicates the current state of the instance, such as whether it is running, stopped, or in an error state.

The internal hostname of the instance. This address can be used privately within the Unikraft Cloud network to access the instance. It is not accessible from the public Internet.

The image used to create the instance. This is a reference to the Unikraft image that was used to create the instance.

The amount of memory in megabytes allocated for the instance. This is the total amount of memory that is available to the instance for its operations.

The number of vCPUs allocated for the instance. This is the total number of virtual CPUs that are available to the instance for its operations.

The arguments passed to the instance when it was started. This is a list of command-line arguments that were provided to the instance at startup. These arguments can be used to configure the behavior of the instance and its applications.

Environment variables set for the instance.

The total number of times the instance has been started. This is a counter that increments each time the instance is started, regardless of whether it was manually stopped or restarted. This can be useful for tracking the usage of the instance over time and/or for debugging purposes.

The total number of times the instance has been restarted. This is a counter that increments each time the instance has been restarted. This can be useful for tracking the usage of the instance over time and/or for debugging purposes.

The time the instance was started. This is the timestamp when the instance was last started.

The time the instance was stopped. This is the timestamp when the instance was last stopped. If the instance is currently running, this field will be empty.

The total amount of time the instance has been running in milliseconds.

(Developer-only). The time taken between the main controller and the beginning of execution of the VMM (Virtual Machine Monitor) measured in microseconds. This field is primarily used for debugging and performance analysis purposes.

(Developer-only). The time it took the VMM (Virtual Machine Monitor) to load the instance's kernel and initramfs into VM memory measured in microseconds. This field is primarily used for debugging and performance analysis purposes.

(Developer-only). The time taken for the VMM (Virtual Machine Monitor) to become ready to execute the instance measured in microseconds. This is the time from when the VMM started until it was ready to execute the instance's code. This field is primarily used for debugging and performance analysis purposes.

The boot time of the instance in microseconds. We take a pragmatic approach is to define the boot time. We calculate this as the difference in time between the moment the virtualization toolstack is invoked to respond to a VM boot request and the moment the OS starts executing user code (i.e., the end of the guest OS boot process). This is essentially the time that a user would experience in a deployment, minus the application initialization time, which we leave out since it is independent from the OS.

This is the time it took for the user-level application to start listening on a non-localhost port measured in microseconds. This is the time from when the instance started until it reasonably ready to start responding to network requests. This is useful for measuring the time it takes for the instance to become operationally ready.

The instance stop reason.

Provides reason as to why an instance is stopped or in the process of shutting down. The stop reason is a bitmask that tells you the origin of the shutdown:

• Forced: This was a force stop. A forced stop does not give the instance a chance to perform a clean shutdown. Bits 0 (Kernel) and 1 (App) can thus never be set for forced shutdowns. Consequently, there won't be an exit_code or stop_code.
• User: Stop initiated by user, e.g. via an API call.
• Platform: Stop initiated by platform, e.g. an autoscale policy.
• App: The Application exited. The exit_code field will be set.
• Kernel: The kernel exited. The stop_code field will be set.

For example, the stop reason will contain the following values in the given scenarios:

The application exit code.

This is the code which the application returns upon leaving its main entry point. The encoding of the exit code is application specific. See the documentation of the application for more details. Usually, an exit code of 0 indicates success / no failure.

The kernel stop code.

This value encodes multiple details about the stop irrespective of the application.

Code
 
MSB                                                     LSB
┌──────────────┬──────────┬──────────┬───────────┬────────┐
│ 31 ────── 24 │ 23 ── 16 │    15    │ 14 ──── 8 │ 7 ── 0 │
├──────────────┼──────────┼──────────┼───────────┼────────┤
│ reserved[^1] │ errno    │ shutdown │ initlevel │ reason │
└──────────────┴──────────┴──────────┴───────────┴────────┘

• errno: The application errno, using Linux's errno.h values. (Optional, can be 0.)
• shutdown: Whether the shutdown originated from the inittable (0) or from the termtable (1).
• initlevel: The initlevel at the time of the stop.
• reason: The reason for the stop. See StopCodeReason.

The restart configuration for the instance.

When an instance stops either because the application exits or the instance crashes, Unikraft Cloud can auto-restart your instance. Auto-restarts are performed according to the restart policy configured for a particular instance.

The policy can have the following values:

When an instance stops, the stop reason and the configured restart policy are evaluated to decide if a restart should be performed. Unikraft Cloud uses an exponential back-off delay (immediate, 5s, 10s, 20s, 40s, ..., 5m) to slow down restarts in tight crash loops. If an instance runs without problems for 10s the back-off delay is reset and the restart sequence ends.

The restart.attempt attribute reported in counts the number of restarts performed in the current sequence. The restart.next_at field indicates when the next restart will take place if a back-off delay is in effect.

A manual start or stop of the instance aborts the restart sequence and resets the back-off delay.

The scale-to-zero configuration for the instance.

With conventional cloud platforms you need to keep at least one instance running at all times to be able to respond to incoming requests. Performing a just-in-time cold boot is simply too time-consuming and would create a response latency of multiple seconds. This is not the case with Unikraft Cloud. Instances on Unikraft Cloud are able to cold boot within milliseconds, which allows us to perform low-latency scale-to-zero.

To enable scale-to-zero for an instance it is sufficient to add a scale_to_zero configuration block. Unikraft Cloud will then put the instance into standby if there is no traffic to your service within the window of a cooldown period. When there is new traffic coming in, it is automatically started again.

If you have a heavyweight application that takes long to cold boot or has bad first request latency (e.g., with JIT compilation) consider to enable stateful scale-to-zero.

The list of volumes attached to the instance.

The service group configuration for the instance.

The network interfaces of the instance.

The tags associated with the instance.

An optional field representing the status of the request. This field is only set when this message object is used as a response message.

An optional message providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

An optional error code providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

The image of the ROM to use for the autoscale configuration.

The name of the ROM to use for the autoscale configuration.

The UUID of the service group.

This is a unique identifier for the service group that is generated when the service is created. The UUID is used to reference the service group in API calls and can be used to identify the service in all API calls that require an service identifier.

The name of the service group.

This is a human-readable name that can be used to identify the service group. The name is unique within the context of your account. The name can also be used to identify the service group in API calls.

The domain configuration for the service group.

The UUID of the volume.

This is a unique identifier for the volume that is generated when the volume is created. The UUID is used to reference the volume in API calls and can be used to identify the volume in all API calls that require a volume identifier.

The name of the volume.

This is a human-readable name that can be used to identify the volume. The name must be unique within the context of your account. The name can also be used to identify the volume in API calls.

The mount point of the volume in the instance. This is the directory in the instance where the volume will be mounted.

Whether the volume is read-only or not.

The UUID of the network interface. This is a unique identifier for the network interface that is generated when the instance is created.

The private IP address of the network interface. This is the internal IP address that is used for communication between instances within the same network.

The MAC address of the network interface.

Amount of bytes received from interface.

Count of packets received from interface

Amount of bytes sent to interface.

Count of packets sent to interface

Indicates whether scale-to-zero is enabled for the instance.

The specific policy to use for scaling the instance to zero.

Whether the instance should be stateful when scaled to zero. If set to true, the instance will retain its state (e.g., RAM contents) when scaled to zero. This is useful for instances that need to maintain their state across scale-to-zero operations. If set to false, the instance will lose its state when scaled to zero, and it will be restarted from scratch when scaled back up.

The cooldown time in milliseconds before the instance can be scaled to zero again. This is useful to prevent rapid scaling to zero and back up, which can lead to performance issues or resource exhaustion.

The digest is a string representation including the hashing algorithm and the hash value separated by a colon.

The media type of the layer is a string that identifies the type of content that the layer contains.

The size of the layer in bytes.

The UUID of the quota.

Used quota

Configured quota limits

Additional limits

An optional field representing the status of the request. This field is only set when this message object is used as a response message.

An optional message providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

An optional error code providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

Minimum amount of memory assigned to live instances in megabytes

Maximum amount of memory assigned to live instances in megabytes

Minimum size of a volume in megabytes

Maximum size of a volume in megabytes

Minimum size of an autoscale group

Maximum size of an autoscale group

Minimum number of vCPUs

Maximum number of vCPUs

The quota(s) which were retrieved by the request.

Number of instances

Number of instances that are not in the stopped state

Number of vCPUs

Amount of memory assigned to instances that are not in the stopped state in megabytes

Number of services

Number of published network ports over all existing services

Number of volumes

Total size of all volumes in megabytes

The HTTP status code of the error.

This is the public-facing port that the service will be accessible from on the Internet.

The port number that the instance is listening on. This is the internal port which Unikraft Cloud will forward traffic to.

Connection handlers to use for the service. Handlers define how the service will handle incoming connections and forward traffic from the Internet to your application. For example, a service can be configured to terminate TLS connections, redirect HTTP traffic, or enable HTTP mode for load balancing. You configure the handlers for every published service port individually.

The UUID of the service group.

This is a unique identifier for the service group that is generated when the service group is created. The UUID is used to reference the service in API calls and can be used to identify the service group in all API calls that require an identifier.

The name of the service group.

This is a human-readable name that can be used to identify the service group. The name must be unique within the context of your account. The name can also be used to identify the service in API calls.

The time the service was created.

Indicates if the service will stay remain even after the last instance detached. If this is set to false, the service will be deleted when the last instance detached from it. If this is set to true, the service will remain and can be reused by other instances. This is useful if you want to keep the service configuration, e.g., the published ports, handlers, and domains, even if there are no instances assigned to it.

Indicates if the service has autoscale enabled. See the associated autoscale documentation for more information about how to set this up. Autoscale policies can be set up after the service has been created.

The soft limit is used by the Unikraft Cloud load balancer to decide when to wake up another standby instance. For example, if the soft limit is set to 5 and the service consists of 2 standby instances, one of the instances receives up to 5 concurrent requests. The 6th parallel requests wakes up the second instance. If there are no more standby instances to wake up, the number of requests assigned to each instance will exceed the soft limit. The load balancer makes sure that when the number of in-flight requests goes down again, instances are put into standby as fast as possible.

The hard limit defines the maximum number of concurrent requests that an instance assigned to the this service can handle. The load balancer will never assign more requests to a single instance. In case there are no other instances available, excess requests fail (i.e., they are blocked and not queued).

List of published network ports for this service and the destination port to which Unikraft Cloud will forward traffic to. Additional handlers can be defined for each published port in order to define how the service will handle incoming connections and forward traffic from the Internet to your application. For example, a service can be configured to terminate TLS connections, redirect HTTP traffic, or enable HTTP mode for load balancing.

List of domains associated with the service. Domains are used to access the service over the Internet.

List of instances assigned to the service.

An optional field representing the status of the request. This field is only set when this message object is used as a response message.

An optional message providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

An optional error code providing additional information about the status. This field is only set when this message object is used as a response message, and is useful when the status is not success.

The UUID of the instance. This is a unique identifier for the instance that is generated when the instance is created. The UUID is used to reference the instance in API calls and can be used to identify the instance in all API calls that require an instance identifier.

The name of the instance. This is a human-readable name that can be used to identify the instance. The name must be unique within the context of your account. If no name is specified, a random name is generated for you. The name can also be used to identify the instance in API calls.

The name of the template used for the autoscale configuration.

The UUID of the template used for the autoscale configuration.

The status of the response.

An optional message providing additional information about the status. This field is useful when the status is not success.

The response data for this request.

A list of errors which may have occurred during the request.

The operation time in microseconds. This is the time it took to process the request and generate the response.

The instance(s) which were started by the request.