Containers

PreviousBackup Policies NextEnvironments

Last updated 1 month ago

List K8S Container

GEThttps://api.cegedim.cloud/itcare/compute/containers/kubernetes

Authorization

Query parameters

Response

Body

totalElementsinteger (int64)

totalPagesinteger (int32)

firstboolean

sizeinteger (int32)

contentarray of object

numberinteger (int32)

sortarray of object

pageableobject

numberOfElementsinteger (int32)

lastboolean

emptyboolean

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "size": 1,
  "content": [
    {
      "id": 1,
      "name": "text",
      "type": "text",
      "internalType": "text",
      "status": "text",
      "category": "text",
      "technology": "text",
      "family": "text",
      "label": "text",
      "comment": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "cloudId": 1,
      "cloudName": "text",
      "serviceId": 1,
      "serviceName": "text",
      "serviceKey": "text",
      "environment": "text",
      "endOfSupportAt": "2025-02-05T04:00:01.422Z",
      "supportPhase": "text",
      "creationUser": "text",
      "creationTime": "text",
      "releasedAt": "2025-02-05T04:00:01.422Z",
      "endOfSalesAt": "2025-02-05T04:00:01.422Z",
      "extendedSupportAt": "2025-02-05T04:00:01.422Z",
      "monitoringEnabled": true,
      "monitoringAlerting": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "replicationStatus": true,
      "backupStatus": true,
      "patchParty": {
        "excluded": true,
        "exclusionReason": "text",
        "patchGroup": "text",
        "patchDate": "2025-02-05T04:00:01.422Z",
        "patchTag": "text",
        "name": "text",
        "id": 1,
        "excludedBy": "text",
        "exclusionDate": "2025-02-05T04:00:01.422Z"
      },
      "metrologyUrl": "text",
      "path": "text",
      "resourceType": "text",
      "internalResourceId": 1,
      "backupPolicyDetails": {
        "backups": [
          {
            "id": 1,
            "type": "text",
            "backupSize": 1,
            "backupLastDate": "2025-02-05T04:00:01.422Z"
          }
        ],
        "policies": [
          {
            "name": "text",
            "label": "text",
            "scope": "text",
            "type": "text",
            "replication": true,
            "frequencies": {},
            "durationInHours": 1,
            "startTime": "text",
            "timezone": "text",
            "policyId": "text",
            "backupLastDate": "2025-02-05T04:00:01.422Z",
            "backupSize": 1
          }
        ]
      },
      "nodeCount": 1,
      "topology": "text",
      "version": "text",
      "versionDetailed": "text",
      "managementUrl": "text",
      "technicalId": "text",
      "labelAreaList": [
        "text"
      ],
      "labelRegion": "text",
      "availableAZs": [
        "text"
      ],
      "availableDCs": [
        "text"
      ],
      "supportsHAMode": true,
      "allowMonitoringDisplay": true,
      "ingressProvider": "NGINX"
    }
  ],
  "number": 1,
  "sort": [
    {
      "direction": "text",
      "nullHandling": "text",
      "ascending": true,
      "property": "text",
      "ignoreCase": true
    }
  ],
  "pageable": {
    "offset": 1,
    "sort": [
      {
        "direction": "text",
        "nullHandling": "text",
        "ascending": true,
        "property": "text",
        "ignoreCase": true
      }
    ],
    "pageSize": 1,
    "pageNumber": 1,
    "paged": true,
    "unpaged": true
  },
  "numberOfElements": 1,
  "last": true,
  "empty": true
}

Create K8s Cluster

This method allows to create a cluster.

You will have to know at the minimum :

where you want to host your cluster (area attribute)
which network is used (networkId attribute)
name of cluster (name attribute)
sizing of cluster (nodeSizing attribute)
number of nodes instances of your cluster (instanceCount attribute)
service in which you want to put your cluster (serviceId attribute)

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /clusters
{
	"name": "PCLUSTER01",
	"area": "EB",
	"networkId": "ED145",
	"serviceId": 123,
	"nodeSizing":, "1cpu2gb"
	"instanceCount": 2
}

POSThttps://api.cegedim.cloud/itcare/compute/containers/kubernetes

Authorization

Body

serviceId*integer (int64)

id of service to put instance in.

regulationstring

Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.

region*string

Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

cloudIdinteger (int64)

monitoringEnabledboolean

Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.

noMonitoringProdReasonstring

Indicates why a production resource is not under monitoring.

onCallSupervisionboolean

Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.

monitoringAlertingboolean

Indicates if alerting should be activated. If absent, set to false.

backupEnabledboolean

Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.

noBackupProdReasonstring

Indicates why a production resource is not under backup.

replicationEnabledboolean

Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment

noReplicationProdReasonstring

Indicates why a production resource is not replicated.

serverBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.

dbBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

area*string

Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

nodeSizing*string

Node sizing for cluster

networkId*integer (int64)

The network Id of the ELS cluster

platform*string

Product platform of the cluster

name*string

Name of k8s cluster

Pattern: [a-z0-9\-]+

instanceCount*integer (int32)

Number of instances to create in k8s cluster

ingressProvider*enum

Kubernetes Container Ingress Providers

NGINXISTIOTRAEFIKNGINX,ISTIO,TRAEFIK

Response

Body

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify({
      "serviceId": 1,
      "region": "text",
      "area": "text",
      "nodeSizing": "text",
      "networkId": 1,
      "platform": "text",
      "name": "text",
      "instanceCount": 1,
      "ingressProvider": "NGINX"
    }),
});
const data = await response.json();

Response

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T04:00:01.422Z"
}

Get K8s Container loadbalancer list.

GEThttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/loadbalancers

Authorization

Path parameters

id*integer (int64)

K8sCluster Id, example: 123

Response

Body

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyobject

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsobject

ipAddressstring

nodeCountinteger (int64)

networkobject

urlsarray of object

urls of the load balancer

membersarray of object

Instances that are load balanced by this loadbalancer

protocolsarray of object

Protocols on which this loadbalancer expose a virtual service

irulesarray of object

iRules configured for this loadbalancer

healthChecksarray of object

Healthchecks configured for this loadbalancer

certificateobject

defaultPersistencestring

Advanced property such as default persistence

fallbackPersistencestring

Advanced property such as fallback persistence

loadBalancingModestring

Advanced property such as load balancing mode

botDefenseEnabledboolean

Bot Defense state

botDefenseUpdatingboolean

Bot Defense is updating

securityProfileobject

snatAutomapboolean

Source addresse translation automap enabled

parentResourceobject

Holds common properties to all Resources managed in ITCare available on a Service

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/loadbalancers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": 1,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 1,
    "cloudName": "text",
    "serviceId": 1,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-02-05T04:00:01.422Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-02-05T04:00:01.422Z",
    "endOfSalesAt": "2025-02-05T04:00:01.422Z",
    "extendedSupportAt": "2025-02-05T04:00:01.422Z",
    "monitoringEnabled": true,
    "monitoringAlerting": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "replicationStatus": true,
    "backupStatus": true,
    "patchParty": {
      "excluded": true,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-02-05T04:00:01.422Z",
      "patchTag": "text",
      "name": "text",
      "id": 1,
      "excludedBy": "text",
      "exclusionDate": "2025-02-05T04:00:01.422Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 1,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 1,
          "type": "text",
          "backupSize": 1,
          "backupLastDate": "2025-02-05T04:00:01.422Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": true,
          "frequencies": {},
          "durationInHours": 1,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-02-05T04:00:01.422Z",
          "backupSize": 1
        }
      ]
    },
    "ipAddress": "text",
    "nodeCount": 1,
    "network": {
      "id": 1,
      "technicalId": "text",
      "cidr": "text",
      "description": "text",
      "scope": "text",
      "defaultNetwork": true,
      "usedPercent": 1,
      "ipFreeNumber": 1,
      "ipAddress": "text",
      "dns": [
        {
          "alias": "text",
          "domain": "text"
        }
      ],
      "mask": "text",
      "networkShortDescription": "text",
      "isIpRangePublic": true,
      "cloud": "text",
      "environment": "text",
      "shortDescription": "text",
      "gateway": "text",
      "region": "text",
      "area": "text"
    },
    "urls": [
      {
        "id": 1,
        "name": "text",
        "type": "text",
        "serviceId": 1,
        "serviceName": "text",
        "serviceKey": "text",
        "environment": "text",
        "creationUser": "text",
        "creationTime": "text",
        "description": "text",
        "comment": "text",
        "releasedAt": "2025-02-05T04:00:01.422Z",
        "endOfSalesAt": "2025-02-05T04:00:01.422Z",
        "extendedSupportAt": "2025-02-05T04:00:01.422Z",
        "endOfSupportAt": "2025-02-05T04:00:01.422Z",
        "supportPhase": "text",
        "tags": [
          {
            "tagKey": "text",
            "tagValue": "text"
          }
        ],
        "status": "text",
        "monitoringEnabled": true,
        "monitoringAlerting": true,
        "monitoringOnCallEnabled": true,
        "monitoringMode": "text",
        "specificChecks": [
          {
            "name": "text",
            "parameter": {
              "path": "text",
              "prefix": "text",
              "authentification": {
                "user": "text",
                "password": "text"
              },
              "protocol": "text",
              "port": 1,
              "method": "text",
              "criticalStatus": "text",
              "warningContent": "text",
              "criticalContent": "text",
              "expectedContent": "text",
              "parameters": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "headers": [
                {
                  "key": "text",
                  "value": "text"
                }
              ]
            }
          }
        ]
      }
    ],
    "members": [
      {
        "id": 1,
        "name": "text",
        "type": "text",
        "internalType": "text",
        "status": "text",
        "category": "text",
        "technology": "text",
        "family": "text",
        "label": "text",
        "comment": "text",
        "productCode": "text",
        "productName": "text",
        "productVersion": "text",
        "cloudId": 1,
        "cloudName": "text",
        "serviceId": 1,
        "serviceName": "text",
        "serviceKey": "text",
        "environment": "text",
        "endOfSupportAt": "2025-02-05T04:00:01.422Z",
        "supportPhase": "text",
        "creationUser": "text",
        "creationTime": "text",
        "releasedAt": "2025-02-05T04:00:01.422Z",
        "endOfSalesAt": "2025-02-05T04:00:01.422Z",
        "extendedSupportAt": "2025-02-05T04:00:01.422Z",
        "monitoringEnabled": true,
        "monitoringAlerting": true,
        "monitoringOnCallEnabled": true,
        "monitoringRequested": true,
        "replicationStatus": true,
        "backupStatus": true,
        "patchParty": {
          "excluded": true,
          "exclusionReason": "text",
          "patchGroup": "text",
          "patchDate": "2025-02-05T04:00:01.422Z",
          "patchTag": "text",
          "name": "text",
          "id": 1,
          "excludedBy": "text",
          "exclusionDate": "2025-02-05T04:00:01.422Z"
        },
        "metrologyUrl": "text",
        "path": "text",
        "resourceType": "text",
        "internalResourceId": 1,
        "backupPolicyDetails": {
          "backups": [
            {
              "id": 1,
              "type": "text",
              "backupSize": 1,
              "backupLastDate": "2025-02-05T04:00:01.422Z"
            }
          ],
          "policies": [
            {
              "name": "text",
              "label": "text",
              "scope": "text",
              "type": "text",
              "replication": true,
              "frequencies": {},
              "durationInHours": 1,
              "startTime": "text",
              "timezone": "text",
              "policyId": "text",
              "backupLastDate": "2025-02-05T04:00:01.422Z",
              "backupSize": 1
            }
          ]
        },
        "ipAddress": "text",
        "network": {
          "id": 1,
          "technicalId": "text",
          "cidr": "text",
          "description": "text",
          "scope": "text",
          "defaultNetwork": true,
          "usedPercent": 1,
          "ipFreeNumber": 1,
          "ipAddress": "text",
          "dns": [
            {
              "alias": "text",
              "domain": "text"
            }
          ],
          "mask": "text",
          "networkShortDescription": "text",
          "isIpRangePublic": true,
          "cloud": "text",
          "environment": "text",
          "shortDescription": "text",
          "gateway": "text",
          "region": "text",
          "area": "text"
        },
        "storageInformation": {
          "totalSizeDisks": 1,
          "fileSystems": [
            {
              "mountingPoint": "text",
              "type": "text",
              "sizeOf": 1,
              "free": 1
            }
          ],
          "totalSizeFileSystems": 1
        },
        "availabilityZone": {
          "id": "text",
          "location": "text",
          "routable": true,
          "defaultZone": true,
          "datacenterId": "text",
          "availabilityZoneGroup": "text"
        },
        "area": {
          "id": "text",
          "location": "text",
          "regulation": "text",
          "defaultArea": true,
          "availabilityZones": [
            {
              "id": "text",
              "location": "text",
              "routable": true,
              "defaultZone": true,
              "datacenterId": "text",
              "availabilityZoneGroup": "text"
            }
          ]
        },
        "region": {
          "id": "text",
          "location": "text",
          "areas": [
            {
              "id": "text",
              "location": "text",
              "regulation": "text",
              "defaultArea": true,
              "availabilityZones": [
                {
                  "id": "text",
                  "location": "text",
                  "routable": true,
                  "defaultZone": true,
                  "datacenterId": "text",
                  "availabilityZoneGroup": "text"
                }
              ]
            }
          ],
          "dataCenter": "text"
        },
        "backup": {
          "backupSystem": "text",
          "size": 1,
          "type": "text",
          "filesNb": 1,
          "lastDate": "2025-02-05T04:00:01.422Z"
        },
        "replication": {
          "storageClass": "text",
          "storageReplicationClass": "text",
          "storageClassOverride": "text",
          "storageMoveInProgress": true,
          "storageMoveTicket": "text",
          "noStoRplExplanation": "text"
        },
        "snapshot": {
          "id": "text",
          "label": "text",
          "createdBy": "text",
          "createdAt": "2025-02-05T04:00:01.422Z",
          "recoveredAt": "2025-02-05T04:00:01.422Z",
          "expiresAt": "2025-02-05T04:00:01.422Z",
          "description": "text",
          "changeReference": "text",
          "snapshotSize": 1
        },
        "labelRegion": "text",
        "labelDataCenter": "text",
        "labelArea": "text",
        "labelAvailabilityZone": "text",
        "totalSizeDisks": "text",
        "cpu": 1,
        "ram": 1,
        "storage": 1,
        "isMemberOFLoadBalancer": true,
        "loadbalancers": [
          {
            "id": 1,
            "name": "text",
            "status": "text",
            "monitoringEnabled": true,
            "memberCount": 1,
            "serviceId": 1
          }
        ],
        "imageCode": "text",
        "osName": "text",
        "osType": "text",
        "isExternalIngressNode": true,
        "isInternalIngressNode": true,
        "storageMoveInProgress": true,
        "authenticationDomain": "text",
        "parentResourceType": "text"
      }
    ],
    "protocols": [
      {
        "protocol": "text",
        "port": 1,
        "name": "text",
        "comment": "text",
        "isCertificateRequired": true,
        "persistence": true,
        "redirectToHttps": true,
        "profilePersistenceOnly": "text",
        "profileNoPersistenceOnly": "text",
        "profilePersistenceRedirect": "text",
        "profileNoPersistenceNoRedirect": "text",
        "profilePersistenceNoRedirect": "text",
        "profileNoPersistenceRedirect": "text",
        "order": 1
      }
    ],
    "irules": [
      {
        "name": "text",
        "description": "text"
      }
    ],
    "healthChecks": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "comment": "text"
      }
    ],
    "certificate": {
      "id": 1,
      "certificateName": "text",
      "commonName": "text",
      "description": "text",
      "expirationDate": "text"
    },
    "defaultPersistence": "text",
    "fallbackPersistence": "text",
    "loadBalancingMode": "text",
    "botDefenseEnabled": true,
    "botDefenseUpdating": true,
    "securityProfile": {
      "id": "text",
      "name": "text",
      "description": "text",
      "profile": "text",
      "enforcement": "text",
      "comment": "text",
      "whiteList": [
        {
          "ip": "text",
          "url": "text",
          "comment": "text"
        }
      ],
      "template": "text"
    },
    "snatAutomap": true,
    "parentResource": {
      "id": 1,
      "name": "text",
      "type": "text",
      "internalType": "text",
      "status": "text",
      "category": "text",
      "technology": "text",
      "family": "text",
      "label": "text",
      "comment": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "cloudId": 1,
      "cloudName": "text",
      "serviceId": 1,
      "serviceName": "text",
      "serviceKey": "text",
      "environment": "text",
      "endOfSupportAt": "2025-02-05T04:00:01.422Z",
      "supportPhase": "text",
      "creationUser": "text",
      "creationTime": "text",
      "releasedAt": "2025-02-05T04:00:01.422Z",
      "endOfSalesAt": "2025-02-05T04:00:01.422Z",
      "extendedSupportAt": "2025-02-05T04:00:01.422Z",
      "monitoringEnabled": true,
      "monitoringAlerting": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "replicationStatus": true,
      "backupStatus": true,
      "patchParty": {
        "excluded": true,
        "exclusionReason": "text",
        "patchGroup": "text",
        "patchDate": "2025-02-05T04:00:01.422Z",
        "patchTag": "text",
        "name": "text",
        "id": 1,
        "excludedBy": "text",
        "exclusionDate": "2025-02-05T04:00:01.422Z"
      },
      "metrologyUrl": "text",
      "path": "text",
      "resourceType": "text",
      "internalResourceId": 1,
      "backupPolicyDetails": {
        "backups": [
          {
            "id": 1,
            "type": "text",
            "backupSize": 1,
            "backupLastDate": "2025-02-05T04:00:01.422Z"
          }
        ],
        "policies": [
          {
            "name": "text",
            "label": "text",
            "scope": "text",
            "type": "text",
            "replication": true,
            "frequencies": {},
            "durationInHours": 1,
            "startTime": "text",
            "timezone": "text",
            "policyId": "text",
            "backupLastDate": "2025-02-05T04:00:01.422Z",
            "backupSize": 1
          }
        ]
      }
    }
  }
]

Create K8s Container custom loadbalancer

POSThttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/loadbalancers

Authorization

Path parameters

id*integer (int64)

K8sCluster Id, example: 123

Body

serviceId*integer (int64)

id of service to put instance in.

regulationstring

Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.

region*string

Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

cloudIdinteger (int64)

monitoringEnabledboolean

Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.

noMonitoringProdReasonstring

Indicates why a production resource is not under monitoring.

onCallSupervisionboolean

Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.

monitoringAlertingboolean

Indicates if alerting should be activated. If absent, set to false.

backupEnabledboolean

Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.

noBackupProdReasonstring

Indicates why a production resource is not under backup.

replicationEnabledboolean

Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment

noReplicationProdReasonstring

Indicates why a production resource is not replicated.

serverBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.

dbBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

areastring

Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

url*string

url of load balancer. Must be unique, and fit naming rules convention., example: url.cegedim.com

Pattern: ^(https?:\\/\\/)?(www\\.)?[a-zA-Z][a-zA-Z0-9.-]{2,63}+$

profileName*string

profile name of load balancer.

healthcheck*string

healtcheck of load balancer., example: http

portMembers*string

port member of load balancer., example: 80, 443, ...

networkIdinteger (int64)

Network id. Refer to networks available in List Networks method. If absent, a default network of AZ will be used.

certificateNamestring

certificate of the load balancer., example: wildcard_cegedim.com

sslProfilestring

ssl profile of the load balancer., example: profile_wildcard.cegedim.com_secure

vsPortinteger (int32)

port of load balancer in case of TCP VS Profile

setUpDNSEnabledboolean

Indicates if a DNS record is to be set. If absent, set to false.

persistenceboolean

redirectToHttpsboolean

Response

Body

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/loadbalancers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "serviceId": 1,
      "region": "text",
      "url": "text",
      "profileName": "text",
      "healthcheck": "text",
      "portMembers": "text"
    }),
});
const data = await response.json();

Response

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T04:00:01.422Z"
}

Get detailed information for an k8s container.

GEThttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}

Authorization

Path parameters

id*integer (int64)

Resource Id, example: 123

Response

Body

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

Storage Replication Enabled - The farm has replicated storage

backupStatusboolean

Indicates backup is active on the host

patchPartyobject

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsobject

nodeCountinteger (int64)

Number of Nodes of the K8s Cluster

topologystring

High availability mode status

versionstring

Version of the K8S Cluster

versionDetailedstring

Version of the K8S Cluster

managementUrlstring

Management host of the K8S Cluster

technicalIdstring

Technical ID of the K8S Cluster

labelAreaListarray of string

A list of Area name

labelRegionstring

Region pretty name

availableAZsarray of string

availableDCsarray of string

supportsHAModeboolean

allowMonitoringDisplayboolean

ingressProviderenum

Kubernetes Container Ingress Providers

NGINXISTIOTRAEFIKNGINX,ISTIO,TRAEFIK

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 1,
  "name": "text",
  "type": "text",
  "internalType": "text",
  "status": "text",
  "category": "text",
  "technology": "text",
  "family": "text",
  "label": "text",
  "comment": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "cloudId": 1,
  "cloudName": "text",
  "serviceId": 1,
  "serviceName": "text",
  "serviceKey": "text",
  "environment": "text",
  "endOfSupportAt": "2025-02-05T04:00:01.422Z",
  "supportPhase": "text",
  "creationUser": "text",
  "creationTime": "text",
  "releasedAt": "2025-02-05T04:00:01.422Z",
  "endOfSalesAt": "2025-02-05T04:00:01.422Z",
  "extendedSupportAt": "2025-02-05T04:00:01.422Z",
  "monitoringEnabled": true,
  "monitoringAlerting": true,
  "monitoringOnCallEnabled": true,
  "monitoringRequested": true,
  "replicationStatus": true,
  "backupStatus": true,
  "patchParty": {
    "excluded": true,
    "exclusionReason": "text",
    "patchGroup": "text",
    "patchDate": "2025-02-05T04:00:01.422Z",
    "patchTag": "text",
    "name": "text",
    "id": 1,
    "excludedBy": "text",
    "exclusionDate": "2025-02-05T04:00:01.422Z"
  },
  "metrologyUrl": "text",
  "path": "text",
  "resourceType": "text",
  "internalResourceId": 1,
  "backupPolicyDetails": {
    "backups": [
      {
        "id": 1,
        "type": "text",
        "backupSize": 1,
        "backupLastDate": "2025-02-05T04:00:01.422Z"
      }
    ],
    "policies": [
      {
        "name": "text",
        "label": "text",
        "scope": "text",
        "type": "text",
        "replication": true,
        "frequencies": {},
        "durationInHours": 1,
        "startTime": "text",
        "timezone": "text",
        "policyId": "text",
        "backupLastDate": "2025-02-05T04:00:01.422Z",
        "backupSize": 1
      }
    ]
  },
  "nodeCount": 1,
  "topology": "text",
  "version": "text",
  "versionDetailed": "text",
  "managementUrl": "text",
  "technicalId": "text",
  "labelAreaList": [
    "text"
  ],
  "labelRegion": "text",
  "availableAZs": [
    "text"
  ],
  "availableDCs": [
    "text"
  ],
  "supportsHAMode": true,
  "allowMonitoringDisplay": true,
  "ingressProvider": "NGINX"
}

Delete an existing k8s container

This method allows to delete a K8s Cluster Container.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /k8s-clusters/123

DELETE /k8s-clusters/123
{
    "changeReference": "rfc nunmber 456"
}

DELETEhttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}

Authorization

Path parameters

id*integer (int64)

id, example: 123

Body

changeReferencestring

Optional reference for change

Response

Body

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T04:00:01.422Z"
}

update K8s Cluster

This method allows to update a cluster.

Structure of payload is generic and describes :

operation you want to be performed
options data relative to the operation performed - see details.

Below are different operations currently implemented.

Create Nodes

Use the create_nodes operation to create the nodes of a cluster.

Create nodes operation will add the new nodes in the cluster by availability zone. You can specify the availability zone you need in the request.

This method is synchronous (status code 202).

Example :

PATCH /containers/kubernetes/1234
{
    "operation": "create_nodes",
    "options": {
        "nodes": [
            {
                "nodesNb": 1,
                "nodeSizing": "2cpu4gb",
                "az": "EB-A"
            },
            {
                "nodesNb": 2,
                "nodeSizing": "4cpu8gb",
                "az": "EB-B"
            }
        ]
    }
}

Delete Nodes

Use the delete_nodes operation to delete the nodes of a cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
	"operation":"delete_nodes",
	"options":{
	    "nodes": ["11112","11113","11114"]
	}
}

Enable High Availability - HA

Use the enable_ha operation to enable the HA of a cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
	"operation":"enable_ha"
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the cluster.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the cluster.

Use the excluded option to turn on/off patch party.
Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

Include from patch party body:

PATCH /containers/kubernetes/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

Exclude from patch party body:

PATCH /containers/kubernetes/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

Upgrade

Use the upgrade operation to upgrade the cluster.

Use the version option to set the target version to be installed.

The requirements are :

step by step upgrade only : Use the /compute/platform/products?type=KUBERNETES to list all versions available for the cluster.
no downgrade possibility

This method is synchronous (status code 202).

PATCH /containers/kubernetes/1234
{
  "operation": "upgrade",
  "options": {
    "version": "1.24"
 }
}

PATCHhttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}

Authorization

Path parameters

id*integer (int64)

K8s Cluster Id, example: 123

Body

operationstring

optionsobject

Response

Body

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "options": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }),
});
const data = await response.json();

Response

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T04:00:01.422Z"
}

Get a Kubernetes containter node informations

GEThttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/nodes

Authorization

Path parameters

id*integer (int64)

Response

Body

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyobject

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsobject

ipAddressstring

networkobject

storageInformationobject

Information about a Storage of an Instance

availabilityZoneobject

areaobject

regionobject

backupobject

Backup information on an instance

replicationobject

Replication information on an instance

snapshotobject

Snapshot of an instance

labelRegionstring

Region pretty name

labelDataCenterstring

DataCenter pretty name

labelAreastring

Area pretty name

labelAvailabilityZonestring

Availability Zone pretty name

totalSizeDisksstring

Total Disk size of the resource

cpuinteger (int64)

CPU of the resource

raminteger (int64)

RAM of the resource

storagenumber

Storage after disks format in GB of the resource

isMemberOFLoadBalancerboolean

Instance is member of load balancer

loadbalancersarray of object

imageCodestring

Internal Image linked to this instance

osNamestring

OS name of this instance

osTypestring

OS type of this instance

isExternalIngressNodeboolean

This instance is ingress external node

isInternalIngressNodeboolean

This instance is ingress internal node

storageMoveInProgressboolean

Information about storage replication in Progress

authenticationDomainstring

parentResourceTypestring

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/nodes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": 1,
    "name": "text",
    "type": "text",
    "internalType": "text",
    "status": "text",
    "category": "text",
    "technology": "text",
    "family": "text",
    "label": "text",
    "comment": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "cloudId": 1,
    "cloudName": "text",
    "serviceId": 1,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-02-05T04:00:01.422Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-02-05T04:00:01.422Z",
    "endOfSalesAt": "2025-02-05T04:00:01.422Z",
    "extendedSupportAt": "2025-02-05T04:00:01.422Z",
    "monitoringEnabled": true,
    "monitoringAlerting": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "replicationStatus": true,
    "backupStatus": true,
    "patchParty": {
      "excluded": true,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-02-05T04:00:01.422Z",
      "patchTag": "text",
      "name": "text",
      "id": 1,
      "excludedBy": "text",
      "exclusionDate": "2025-02-05T04:00:01.422Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 1,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 1,
          "type": "text",
          "backupSize": 1,
          "backupLastDate": "2025-02-05T04:00:01.422Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": true,
          "frequencies": {},
          "durationInHours": 1,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-02-05T04:00:01.422Z",
          "backupSize": 1
        }
      ]
    },
    "ipAddress": "text",
    "network": {
      "id": 1,
      "technicalId": "text",
      "cidr": "text",
      "description": "text",
      "scope": "text",
      "defaultNetwork": true,
      "usedPercent": 1,
      "ipFreeNumber": 1,
      "ipAddress": "text",
      "dns": [
        {
          "alias": "text",
          "domain": "text"
        }
      ],
      "mask": "text",
      "networkShortDescription": "text",
      "isIpRangePublic": true,
      "cloud": "text",
      "environment": "text",
      "shortDescription": "text",
      "gateway": "text",
      "region": "text",
      "area": "text"
    },
    "storageInformation": {
      "totalSizeDisks": 1,
      "fileSystems": [
        {
          "mountingPoint": "text",
          "type": "text",
          "sizeOf": 1,
          "free": 1
        }
      ],
      "totalSizeFileSystems": 1
    },
    "availabilityZone": {
      "id": "text",
      "location": "text",
      "routable": true,
      "defaultZone": true,
      "datacenterId": "text",
      "availabilityZoneGroup": "text"
    },
    "area": {
      "id": "text",
      "location": "text",
      "regulation": "text",
      "defaultArea": true,
      "availabilityZones": [
        {
          "id": "text",
          "location": "text",
          "routable": true,
          "defaultZone": true,
          "datacenterId": "text",
          "availabilityZoneGroup": "text"
        }
      ]
    },
    "region": {
      "id": "text",
      "location": "text",
      "areas": [
        {
          "id": "text",
          "location": "text",
          "regulation": "text",
          "defaultArea": true,
          "availabilityZones": [
            {
              "id": "text",
              "location": "text",
              "routable": true,
              "defaultZone": true,
              "datacenterId": "text",
              "availabilityZoneGroup": "text"
            }
          ]
        }
      ],
      "dataCenter": "text"
    },
    "backup": {
      "backupSystem": "text",
      "size": 1,
      "type": "text",
      "filesNb": 1,
      "lastDate": "2025-02-05T04:00:01.422Z"
    },
    "replication": {
      "storageClass": "text",
      "storageReplicationClass": "text",
      "storageClassOverride": "text",
      "storageMoveInProgress": true,
      "storageMoveTicket": "text",
      "noStoRplExplanation": "text"
    },
    "snapshot": {
      "id": "text",
      "label": "text",
      "createdBy": "text",
      "createdAt": "2025-02-05T04:00:01.422Z",
      "recoveredAt": "2025-02-05T04:00:01.422Z",
      "expiresAt": "2025-02-05T04:00:01.422Z",
      "description": "text",
      "changeReference": "text",
      "snapshotSize": 1
    },
    "labelRegion": "text",
    "labelDataCenter": "text",
    "labelArea": "text",
    "labelAvailabilityZone": "text",
    "totalSizeDisks": "text",
    "cpu": 1,
    "ram": 1,
    "storage": 1,
    "isMemberOFLoadBalancer": true,
    "loadbalancers": [
      {
        "id": 1,
        "name": "text",
        "status": "text",
        "monitoringEnabled": true,
        "memberCount": 1,
        "serviceId": 1
      }
    ],
    "imageCode": "text",
    "osName": "text",
    "osType": "text",
    "isExternalIngressNode": true,
    "isInternalIngressNode": true,
    "storageMoveInProgress": true,
    "authenticationDomain": "text",
    "parentResourceType": "text"
  }
]

Get a Kubernetes containter network informations

GEThttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/networks

Authorization

Path parameters

id*integer (int64)

Response

Body

idinteger (int64)

technicalIdstring

cidrstring

descriptionstring

scopestring

defaultNetworkboolean

usedPercentinteger (int32)

ipFreeNumberinteger (int32)

ipAddressstring

dnsarray of object

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/networks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": 1,
    "technicalId": "text",
    "cidr": "text",
    "description": "text",
    "scope": "text",
    "defaultNetwork": true,
    "usedPercent": 1,
    "ipFreeNumber": 1,
    "ipAddress": "text",
    "dns": [
      {
        "alias": "text",
        "domain": "text"
      }
    ],
    "mask": "text",
    "networkShortDescription": "text",
    "isIpRangePublic": true,
    "cloud": "text",
    "environment": "text",
    "shortDescription": "text",
    "gateway": "text",
    "region": "text",
    "area": "text"
  }
]

Get K8s Container stats distribution of Availability Zone and Datacenter of the nodes the cluster

GEThttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/metrics

Authorization

Path parameters

id*integer (int64)

K8sCluster Id, example: 123

Query parameters

Response

Body

Other propertiesobject

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/metrics?type=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "ANY_ADDITIONAL_PROPERTY": {
    "cpuCount": 1,
    "ramCount": 1,
    "nodeCount": 1
  }
}

List ingress providers

GEThttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/ingress-providers

Authorization

Response

Body

itemsstring

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/ingress-providers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  "text"
]

Delete a Kubernetes container node

This method allows to delete a Kubernetes cluster node.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

To delete a Kubernetes node, the id of the Kubernetes cluster and the id of the node to delete must be specified.

To list the nodes of the Kubernetes cluster, use the endpoint : GET /containers/kubernetes/{kuberneteId}/nodes/{nodeId}.

Use the following to delete a node of a Kubernetes cluster.

DELETE /containers/kubernetes/1234/nodes/4567

To keep consistency on the Kubernetes cluster, please note that :

All nodes cannot be deleted.
All ingress nodes cannot be deleted.

API users will have a BAD_REQUEST when trying to break one of the rule above.

DELETEhttps://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/nodes/{nodeId}

Authorization

Path parameters

id*integer (int64)

id, example: 123

nodeId*integer (int64)

id, example: 456

Response

Body

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

const response = await fetch('https://api.cegedim.cloud/itcare/compute/containers/kubernetes/{id}/nodes/{nodeId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T04:00:01.422Z"
}