Get KaaS

GET 
/projects/:projectId/providers/Aruba.Container/kaas/:id

Get KaaS

Request

Path Parameters

projectId stringrequired

unique identifier of the project CMP

id stringrequired

unique identifier of the cluster kubernetes

Query Parameters

ignoreDeletedStatus boolean

if the resource exists in status "Deleted", returns NotFound according to the value of this flag

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

Responses

200

Success

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

404

Not Found

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