Create KaaS

POST 
/projects/:projectId/providers/Aruba.Container/kaas

Create KaaS

Request

Path Parameters

projectId stringrequired

unique identifier of the project CMP

Query Parameters

api-version string
The requested API version
Default value: 1.0

application/json

Body

the cluster kubernetes to create

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

Uri of the resource to link

]

presetboolean

Set this flag to true if you want the vpc and the subnet related to the kaas will be created automatically. Preset is available for all the kaas unless a vpc has been already created in the same project and location.

vpc

object

uristring

Uri of the resource

subnet

object

uristring

Uri of the resource

nodeCidr

object

addressstring

Address in CIDR notation The IP range must be between 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16

namestring

Name of the nodecidr

securityGroup

object

namestring

Name of the security group

kubernetesVersion

object

valuestring

Value of the version.

See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

nodePools

object[]

list of the nodepools of the kaas

Array [

namestring

Nodepool name

nodesint32

Number of nodes

instancestring

Configuration name of the nodes.

See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

dataCenterstring

Datacenter in which the nodes of the pool will be located. ///

See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

]

haboolean

If true, the the cluster will be replicated across 3 zones within the region selected. Please note that the Control Panel in HA cannot be disabled once the cluster has been created.

storage

object

maxCumulativeVolumeSizeint32nullable

Storage limit for this Kubernetes cluster. The sum of the size of all the volumes used by the cluster must be less than this value, if specified. Default value is null and no limitation will be applied.

billingPlan

object

billingPeriodstringnullable

text/json

Body

the cluster kubernetes to create

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

Uri of the resource to link

]

presetboolean

Set this flag to true if you want the vpc and the subnet related to the kaas will be created automatically. Preset is available for all the kaas unless a vpc has been already created in the same project and location.

vpc

object

uristring

Uri of the resource

subnet

object

uristring

Uri of the resource

nodeCidr

object

addressstring

Address in CIDR notation The IP range must be between 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16

namestring

Name of the nodecidr

securityGroup

object

namestring

Name of the security group

kubernetesVersion

object

valuestring

Value of the version.

See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

nodePools

object[]

list of the nodepools of the kaas

Array [

namestring

Nodepool name

nodesint32

Number of nodes

instancestring

Configuration name of the nodes.

See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

dataCenterstring

Datacenter in which the nodes of the pool will be located. ///

See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

]

haboolean

If true, the the cluster will be replicated across 3 zones within the region selected. Please note that the Control Panel in HA cannot be disabled once the cluster has been created.

storage

object

maxCumulativeVolumeSizeint32nullable

Storage limit for this Kubernetes cluster. The sum of the size of all the volumes used by the cluster must be less than this value, if specified. Default value is null and no limitation will be applied.

billingPlan

object

billingPeriodstringnullable

application/*+json

Body

the cluster kubernetes to create

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

Uri of the resource to link

]

presetboolean

Set this flag to true if you want the vpc and the subnet related to the kaas will be created automatically. Preset is available for all the kaas unless a vpc has been already created in the same project and location.

vpc

object

uristring

Uri of the resource

subnet

object

uristring

Uri of the resource

nodeCidr

object

addressstring

Address in CIDR notation The IP range must be between 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16

namestring

Name of the nodecidr

securityGroup

object

namestring

Name of the security group

kubernetesVersion

object

valuestring

Value of the version.

See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

nodePools

object[]

list of the nodepools of the kaas

Array [

namestring

Nodepool name

nodesint32

Number of nodes

instancestring

Configuration name of the nodes.

See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

dataCenterstring

Datacenter in which the nodes of the pool will be located. ///

See metadata section of the API documentation for an updated list of admissable values.

For more information, check the documentation.

]

haboolean

If true, the the cluster will be replicated across 3 zones within the region selected. Please note that the Control Panel in HA cannot be disabled once the cluster has been created.

storage

object

maxCumulativeVolumeSizeint32nullable

Storage limit for this Kubernetes cluster. The sum of the size of all the volumes used by the cluster must be less than this value, if specified. Default value is null and no limitation will be applied.

billingPlan

object

billingPeriodstringnullable

Responses

201

Created

text/plain

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

presetboolean

vpc

object

uristringnullable

subnet

object

uristringnullable

kubernetesVersion

object

valuestringnullable

endOfSupportDatedate-timenullable

sellStartDatedate-timenullable

sellEndDatedate-timenullable

recommendedboolean

upgradeTo

object

valuestringnullable

scheduledAtdate-timenullable

nodesPool

object[]

nullable

Array [

namestringnullable

nodesint32nullable

autoscalingboolean

creationDatedate-timenullable

instance

object

ramstringnullable

pricedoublenullable

cpustringnullable

namestringnullable

diskSizeGbstringnullable

dataCenter

object

For more information, check the documentation.

namestringnullable

]

podcidr

object

addressstringnullable

nodecidr

object

addressstringnullable

namestringnullable

uristringnullable

securityGroup

object

namestringnullable

uristringnullable

haboolean

storage

object

maxCumulativeVolumeSizeint32nullable

billingPlan

object

billingPeriodstringnullable

managementIpstringnullable

openstackProject

object

OpenstackProject

idstringnullable

data

object

private

object

isKamajiboolean

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "preset": true,
    "vpc": {
      "uri": "string"
    },
    "subnet": {
      "uri": "string"
    },
    "kubernetesVersion": {
      "value": "string",
      "endOfSupportDate": "2024-07-29T15:51:28.071Z",
      "sellStartDate": "2024-07-29T15:51:28.071Z",
      "sellEndDate": "2024-07-29T15:51:28.071Z",
      "recommended": true,
      "upgradeTo": {
        "value": "string",
        "scheduledAt": "2024-07-29T15:51:28.071Z"
      }
    },
    "nodesPool": [
      {
        "name": "string",
        "nodes": 0,
        "autoscaling": true,
        "creationDate": "2024-07-29T15:51:28.071Z",
        "instance": {
          "ram": "string",
          "price": 0,
          "cpu": "string",
          "name": "string",
          "diskSizeGb": "string"
        },
        "dataCenter": {
          "name": "string"
        }
      }
    ],
    "podcidr": {
      "address": "string"
    },
    "nodecidr": {
      "address": "string",
      "name": "string",
      "uri": "string"
    },
    "securityGroup": {
      "name": "string",
      "uri": "string"
    },
    "ha": true,
    "storage": {
      "maxCumulativeVolumeSize": 0
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "managementIp": "string",
    "openstackProject": {
      "id": "string"
    }
  },
  "data": {
    "private": {
      "isKamaji": true
    }
  }
}

application/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

presetboolean

vpc

object

uristringnullable

subnet

object

uristringnullable

kubernetesVersion

object

valuestringnullable

endOfSupportDatedate-timenullable

sellStartDatedate-timenullable

sellEndDatedate-timenullable

recommendedboolean

upgradeTo

object

valuestringnullable

scheduledAtdate-timenullable

nodesPool

object[]

nullable

Array [

namestringnullable

nodesint32nullable

autoscalingboolean

creationDatedate-timenullable

instance

object

ramstringnullable

pricedoublenullable

cpustringnullable

namestringnullable

diskSizeGbstringnullable

dataCenter

object

For more information, check the documentation.

namestringnullable

]

podcidr

object

addressstringnullable

nodecidr

object

addressstringnullable

namestringnullable

uristringnullable

securityGroup

object

namestringnullable

uristringnullable

haboolean

storage

object

maxCumulativeVolumeSizeint32nullable

billingPlan

object

billingPeriodstringnullable

managementIpstringnullable

openstackProject

object

OpenstackProject

idstringnullable

data

object

private

object

isKamajiboolean

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "preset": true,
    "vpc": {
      "uri": "string"
    },
    "subnet": {
      "uri": "string"
    },
    "kubernetesVersion": {
      "value": "string",
      "endOfSupportDate": "2024-07-29T15:51:28.071Z",
      "sellStartDate": "2024-07-29T15:51:28.071Z",
      "sellEndDate": "2024-07-29T15:51:28.071Z",
      "recommended": true,
      "upgradeTo": {
        "value": "string",
        "scheduledAt": "2024-07-29T15:51:28.071Z"
      }
    },
    "nodesPool": [
      {
        "name": "string",
        "nodes": 0,
        "autoscaling": true,
        "creationDate": "2024-07-29T15:51:28.071Z",
        "instance": {
          "ram": "string",
          "price": 0,
          "cpu": "string",
          "name": "string",
          "diskSizeGb": "string"
        },
        "dataCenter": {
          "name": "string"
        }
      }
    ],
    "podcidr": {
      "address": "string"
    },
    "nodecidr": {
      "address": "string",
      "name": "string",
      "uri": "string"
    },
    "securityGroup": {
      "name": "string",
      "uri": "string"
    },
    "ha": true,
    "storage": {
      "maxCumulativeVolumeSize": 0
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "managementIp": "string",
    "openstackProject": {
      "id": "string"
    }
  },
  "data": {
    "private": {
      "isKamaji": true
    }
  }
}

text/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

presetboolean

vpc

object

uristringnullable

subnet

object

uristringnullable

kubernetesVersion

object

valuestringnullable

endOfSupportDatedate-timenullable

sellStartDatedate-timenullable

sellEndDatedate-timenullable

recommendedboolean

upgradeTo

object

valuestringnullable

scheduledAtdate-timenullable

nodesPool

object[]

nullable

Array [

namestringnullable

nodesint32nullable

autoscalingboolean

creationDatedate-timenullable

instance

object

ramstringnullable

pricedoublenullable

cpustringnullable

namestringnullable

diskSizeGbstringnullable

dataCenter

object

For more information, check the documentation.

namestringnullable

]

podcidr

object

addressstringnullable

nodecidr

object

addressstringnullable

namestringnullable

uristringnullable

securityGroup

object

namestringnullable

uristringnullable

haboolean

storage

object

maxCumulativeVolumeSizeint32nullable

billingPlan

object

billingPeriodstringnullable

managementIpstringnullable

openstackProject

object

OpenstackProject

idstringnullable

data

object

private

object

isKamajiboolean

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "preset": true,
    "vpc": {
      "uri": "string"
    },
    "subnet": {
      "uri": "string"
    },
    "kubernetesVersion": {
      "value": "string",
      "endOfSupportDate": "2024-07-29T15:51:28.071Z",
      "sellStartDate": "2024-07-29T15:51:28.071Z",
      "sellEndDate": "2024-07-29T15:51:28.071Z",
      "recommended": true,
      "upgradeTo": {
        "value": "string",
        "scheduledAt": "2024-07-29T15:51:28.071Z"
      }
    },
    "nodesPool": [
      {
        "name": "string",
        "nodes": 0,
        "autoscaling": true,
        "creationDate": "2024-07-29T15:51:28.071Z",
        "instance": {
          "ram": "string",
          "price": 0,
          "cpu": "string",
          "name": "string",
          "diskSizeGb": "string"
        },
        "dataCenter": {
          "name": "string"
        }
      }
    ],
    "podcidr": {
      "address": "string"
    },
    "nodecidr": {
      "address": "string",
      "name": "string",
      "uri": "string"
    },
    "securityGroup": {
      "name": "string",
      "uri": "string"
    },
    "ha": true,
    "storage": {
      "maxCumulativeVolumeSize": 0
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "managementIp": "string",
    "openstackProject": {
      "id": "string"
    }
  },
  "data": {
    "private": {
      "isKamaji": true
    }
  }
}

400

Bad Request

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Server Error