Autoscale

Server

Services allow you to load balance traffic for an Internet-facing service like a webserver by creating multiple instances within the same service. While you can add or remove instances to a service to scale your service, doing this manually makes it hard to react to changes in service load. On the other hand, always keeping a large number of instances running to cope with bursts is not an option either. This is where autoscale comes into play. With autoscale enabled, Unikraft Cloud takes the heavy lifting of constantly monitoring the load of your service and automatically creates or deletes instances as needed.

List Autoscale Configurations

GET

https://api.sfo.unikraft.cloud

/v1/services/autoscale

List autoscale configurations for the specified service groups.

List Autoscale Configurations › query Parameters

uuid

string[]

The UUID of the resource.

name

string[]

The name of the resource.

List Autoscale Configurations › Request Body

Common.NameOrUUID[]

An identifier for a resource — either a name or a UUID, but not both.

Common.NameOrUUID

uuid

string · uuid

The UUID of the resource.

name

string

The name of the resource.

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: uuid
	type = object · requires: name

Properties for Variant 1:

uuid

string · uuid · required

The UUID of the resource.

name

string

The name of the resource.

List Autoscale Configurations › Responses

200

The request has succeeded.

The response message for a GetAutoscaleConfigurationsRequest.

Autoscale.GetAutoscaleConfigurationsResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

unconfigured

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

GET/v1/services/autoscale

curl https://api.sfo.unikraft.cloud/v1/services/autoscale \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "name"
  }
]'

Example Request Body

[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "name"
  }
]

json

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "service_groups": [
      {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "enabled": true,
        "min_size": 0,
        "max_size": 0,
        "warmup_time_ms": 0,
        "cooldown_time_ms": 0,
        "template": {
          "uuid": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "node": "node"
        },
        "policies": [
          {
            "name": "name",
            "enabled": true,
            "metric": "cpu",
            "adjustment_type": "change",
            "steps": [
              {
                "adjustment": 0,
                "lower_bound": 0,
                "upper_bound": 0
              }
            ]
          }
        ],
        "message": "message",
        "error": 0,
        "status": "success"
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Create Autoscale Configurations

POST

https://api.sfo.unikraft.cloud

/v1/services/autoscale

Create one or more autoscale configurations for the specified service groups.

Create Autoscale Configurations › Request Body

Autoscale.CreateAutoscaleConfigurationsRequestConfiguration[]

Autoscale.CreateAutoscaleConfigurationsRequestConfiguration

object · required

The arguments to use when creating instances.

uuid

string · uuid

The UUID of the resource.

name

string

The name of the resource.

min_size

integer · int64

The minimum number of instances to keep running.

max_size

integer · int64

The maximum number of instances to keep running.

warmup_time_ms

integer · int64

The warmup time in milliseconds for new instances.

cooldown_time_ms

integer · int64

The cooldown time in milliseconds for the autoscale configuration.

Autoscale.AutoscalePolicy[]

The policies to apply to the autoscale configuration.

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: uuid
	type = object · requires: name

Properties for Variant 1:

uuid

string · uuid · required

The UUID of the resource.

name

string

The name of the resource.

min_size

integer · int64

The minimum number of instances to keep running.

max_size

integer · int64

The maximum number of instances to keep running.

warmup_time_ms

integer · int64

The warmup time in milliseconds for new instances.

cooldown_time_ms

integer · int64

The cooldown time in milliseconds for the autoscale configuration.

object

The arguments to use when creating instances.

Autoscale.AutoscalePolicy[]

The policies to apply to the autoscale configuration.

Create Autoscale Configurations › Responses

200

The request has succeeded.

The response to a CreateAutoscaleConfigurationRequest.

Autoscale.CreateAutoscaleConfigurationsResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

POST/v1/services/autoscale

curl https://api.sfo.unikraft.cloud/v1/services/autoscale \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "min_size": 0,
    "max_size": 0,
    "warmup_time_ms": 0,
    "cooldown_time_ms": 0,
    "create_args": {
      "roms": {
        "name": "name",
        "image": "nginx:latest",
        "files": [
          {
            "path": "path",
            "encoding": "text",
            "data": "data"
          }
        ]
      },
      "template": {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name"
      }
    },
    "policies": [
      {
        "name": "name",
        "enabled": true,
        "metric": "cpu",
        "adjustment_type": "change",
        "steps": [
          {
            "adjustment": 0,
            "lower_bound": 0,
            "upper_bound": 0
          }
        ]
      }
    ]
  }
]'

Example Request Body

[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "min_size": 0,
    "max_size": 0,
    "warmup_time_ms": 0,
    "cooldown_time_ms": 0,
    "create_args": {
      "roms": {
        "name": "name",
        "image": "nginx:latest",
        "files": [
          {
            "path": "path",
            "encoding": "text",
            "data": "data"
          }
        ]
      },
      "template": {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name"
      }
    },
    "policies": [
      {
        "name": "name",
        "enabled": true,
        "metric": "cpu",
        "adjustment_type": "change",
        "steps": [
          {
            "adjustment": 0,
            "lower_bound": 0,
            "upper_bound": 0
          }
        ]
      }
    ]
  }
]

json

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "service_groups": [
      {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "status": "success",
        "message": "message",
        "error": 0
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Delete Autoscale Configurations

DELETE

https://api.sfo.unikraft.cloud

/v1/services/autoscale

Delete autoscale configurations for the specified service groups.

Delete Autoscale Configurations › Request Body

Common.NameOrUUID[]

An identifier for a resource — either a name or a UUID, but not both.

Common.NameOrUUID

uuid

string · uuid

The UUID of the resource.

name

string

The name of the resource.

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: uuid
	type = object · requires: name

Properties for Variant 1:

uuid

string · uuid · required

The UUID of the resource.

name

string

The name of the resource.

Delete Autoscale Configurations › Responses

200

The request has succeeded.

Autoscale.DeleteAutoscaleConfigurationsResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

DELETE/v1/services/autoscale

curl https://api.sfo.unikraft.cloud/v1/services/autoscale \
  --request DELETE \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "name"
  }
]'

Example Request Body

[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "name"
  }
]

json

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "service_groups": [
      {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "status": "success",
        "message": "message",
        "error": 0
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Get Autoscale Configurations by Service Group UUID

GET

https://api.sfo.unikraft.cloud

/v1/services/{uuid}/autoscale

Get autoscale configurations for a service group by UUID.

Get Autoscale Configurations by Service Group UUID › path Parameters

uuid

string · uuid · required

Get Autoscale Configurations by Service Group UUID › Responses

200

The request has succeeded.

The response message for a GetAutoscaleConfigurationsRequest.

Autoscale.GetAutoscaleConfigurationsResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

unconfigured

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

GET/v1/services/{uuid}/autoscale

curl https://api.sfo.unikraft.cloud/v1/services/:uuid/autoscale \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "service_groups": [
      {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "enabled": true,
        "min_size": 0,
        "max_size": 0,
        "warmup_time_ms": 0,
        "cooldown_time_ms": 0,
        "template": {
          "uuid": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "node": "node"
        },
        "policies": [
          {
            "name": "name",
            "enabled": true,
            "metric": "cpu",
            "adjustment_type": "change",
            "steps": [
              {
                "adjustment": 0,
                "lower_bound": 0,
                "upper_bound": 0
              }
            ]
          }
        ],
        "message": "message",
        "error": 0,
        "status": "success"
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Create Autoscale Configuration by Service Group UUID

POST

https://api.sfo.unikraft.cloud

/v1/services/{uuid}/autoscale

Create an autoscale configuration for a service group by UUID.

Create Autoscale Configuration by Service Group UUID › path Parameters

uuid

string · uuid · required

Create Autoscale Configuration by Service Group UUID › Request Body

The request message to create an autoscale configuration for a service group based on its UUID.

Autoscale.CreateAutoscaleConfigurationByServiceGroupUUIDRequest

uuid

string · uuid · required

The UUID of the service to create a configuration for.

object · required

The arguments to use when creating instances.

min_size

integer · int64

The minimum number of instances to keep running.

max_size

integer · int64

The maximum number of instances to keep running.

warmup_time_ms

integer · int64

The warmup time in milliseconds for new instances.

cooldown_time_ms

integer · int64

The cooldown time in milliseconds for the autoscale configuration.

Autoscale.AutoscalePolicy[]

The policies to apply to the autoscale configuration.

Create Autoscale Configuration by Service Group UUID › Responses

200

The request has succeeded.

The response to a CreateAutoscaleConfigurationRequest.

Autoscale.CreateAutoscaleConfigurationsResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

POST/v1/services/{uuid}/autoscale

curl https://api.sfo.unikraft.cloud/v1/services/:uuid/autoscale \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "min_size": 0,
  "max_size": 0,
  "warmup_time_ms": 0,
  "cooldown_time_ms": 0,
  "create_args": {
    "roms": {
      "name": "name",
      "image": "nginx:latest",
      "files": [
        {
          "path": "path",
          "encoding": "text",
          "data": "data"
        }
      ]
    },
    "template": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "name"
    }
  },
  "policies": [
    {
      "name": "name",
      "enabled": true,
      "metric": "cpu",
      "adjustment_type": "change",
      "steps": [
        {
          "adjustment": 0,
          "lower_bound": 0,
          "upper_bound": 0
        }
      ]
    }
  ]
}'

Example Request Body

{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "min_size": 0,
  "max_size": 0,
  "warmup_time_ms": 0,
  "cooldown_time_ms": 0,
  "create_args": {
    "roms": {
      "name": "name",
      "image": "nginx:latest",
      "files": [
        {
          "path": "path",
          "encoding": "text",
          "data": "data"
        }
      ]
    },
    "template": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "name"
    }
  },
  "policies": [
    {
      "name": "name",
      "enabled": true,
      "metric": "cpu",
      "adjustment_type": "change",
      "steps": [
        {
          "adjustment": 0,
          "lower_bound": 0,
          "upper_bound": 0
        }
      ]
    }
  ]
}

json

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "service_groups": [
      {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "status": "success",
        "message": "message",
        "error": 0
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Delete Autoscale Configurations by Service Group UUID

DELETE

https://api.sfo.unikraft.cloud

/v1/services/{uuid}/autoscale

Delete the autoscale configuration for a service group by UUID.

Delete Autoscale Configurations by Service Group UUID › path Parameters

uuid

string · uuid · required

Delete Autoscale Configurations by Service Group UUID › Responses

200

The request has succeeded.

Autoscale.DeleteAutoscaleConfigurationsResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

List Autoscale Configuration Policies

GET

https://api.sfo.unikraft.cloud

/v1/services/{uuid}/autoscale/policies

List autoscale policies for a service group by UUID.

List Autoscale Configuration Policies › path Parameters

uuid

string · uuid · required

List Autoscale Configuration Policies › Request Body optional

The request message to get an autoscale configuration policy by name.

Autoscale.GetAutoscaleConfigurationPolicyRequest

name

string · required

The Name of the policy to get.

Example: funky-policy

List Autoscale Configuration Policies › Responses

200

The request has succeeded.

Autoscale.GetAutoscaleConfigurationPolicyResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

GET/v1/services/{uuid}/autoscale/policies

curl https://api.sfo.unikraft.cloud/v1/services/:uuid/autoscale/policies \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "funky-policy"
}'

Example Request Body

{
  "name": "funky-policy"
}

json

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "policies": [
      {
        "policy": {
          "name": "name",
          "enabled": true,
          "metric": "cpu",
          "adjustment_type": "change",
          "steps": [
            {
              "adjustment": 0,
              "lower_bound": 0,
              "upper_bound": 0
            }
          ]
        },
        "status": "success",
        "message": "message",
        "error": 0
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Create Autoscale Configuration Policy

POST

https://api.sfo.unikraft.cloud

/v1/services/{uuid}/autoscale/policies

Add a new autoscale policy to a service group by UUID.

Create Autoscale Configuration Policy › path Parameters

uuid

string · uuid · required

Create Autoscale Configuration Policy › Request Body

The request message to create an autoscale configuration policy for a service.

Autoscale.CreateAutoscaleConfigurationPolicyRequest

name

string · required

The name of the policy.

object · required

The policy type to add to the autoscale configuration.

Create Autoscale Configuration Policy › Responses

200

The request has succeeded.

Autoscale.CreateAutoscaleConfigurationPolicyResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

POST/v1/services/{uuid}/autoscale/policies

curl https://api.sfo.unikraft.cloud/v1/services/:uuid/autoscale/policies \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "type": {
    "name": "name",
    "enabled": true,
    "metric": "cpu",
    "adjustment_type": "change",
    "steps": [
      {
        "adjustment": 0,
        "lower_bound": 0,
        "upper_bound": 0
      }
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "type": {
    "name": "name",
    "enabled": true,
    "metric": "cpu",
    "adjustment_type": "change",
    "steps": [
      {
        "adjustment": 0,
        "lower_bound": 0,
        "upper_bound": 0
      }
    ]
  }
}

json

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "policies": [
      {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "status": "success",
        "message": "message",
        "error": 0
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Delete Autoscale Configuration Policies

DELETE

https://api.sfo.unikraft.cloud

/v1/services/{uuid}/autoscale/policies

Delete autoscale policies for a service group by UUID.

Delete Autoscale Configuration Policies › path Parameters

uuid

string · uuid · required

Delete Autoscale Configuration Policies › Request Body

The request message to delete an autoscale configuration policy by name.

Autoscale.DeletePolicyRequest

name

string · required

The name of the policy to delete.

Delete Autoscale Configuration Policies › Responses

200

The request has succeeded.

Autoscale.DeleteAutoscaleConfigurationPolicyResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

Get Autoscale Configuration Policy by Name

GET

https://api.sfo.unikraft.cloud

/v1/services/{uuid}/autoscale/policies/{name}

Get an autoscale policy by name for a service group by UUID.

Get Autoscale Configuration Policy by Name › path Parameters

uuid

string · uuid · required

name

string · required

Get Autoscale Configuration Policy by Name › Responses

200

The request has succeeded.

Autoscale.GetAutoscaleConfigurationPolicyResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

GET/v1/services/{uuid}/autoscale/policies/{name}

curl https://api.sfo.unikraft.cloud/v1/services/:uuid/autoscale/policies/:name \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "policies": [
      {
        "policy": {
          "name": "name",
          "enabled": true,
          "metric": "cpu",
          "adjustment_type": "change",
          "steps": [
            {
              "adjustment": 0,
              "lower_bound": 0,
              "upper_bound": 0
            }
          ]
        },
        "status": "success",
        "message": "message",
        "error": 0
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Delete Autoscale Configuration Policy by Name

DELETE

https://api.sfo.unikraft.cloud

/v1/services/{uuid}/autoscale/policies/{name}

Delete an autoscale policy by name for a service group by UUID.

Delete Autoscale Configuration Policy by Name › path Parameters

uuid

string · uuid · required

name

string · required

Delete Autoscale Configuration Policy by Name › Responses

200

The request has succeeded.

Autoscale.DeleteAutoscaleConfigurationPolicyResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

object · required

The response data for this request.

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

Common.ResponseError[]

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

Certificates Volumes