MariaDB

Last updated 4 months ago

Delete an existing MariaDB instance

delete

This method allows to delete a Maria DB instance.

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

DELETE /mariadb/123

Authorizations

Path parameters

idinteger · int64Required

Id, example: 123

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

delete

DELETE /itcare/databases/mariadb/{id} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:40:48.395Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Get a MariaDB node informations

get

Authorizations

Path parameters

idinteger · int64Required

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/databases/mariadb/{id}/nodes HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

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

Get a MariaDB network information

get

Authorizations

Path parameters

idinteger · int64Required

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/databases/mariadb/{id}/networks HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

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

Get a MariaDB Instance available in the cloud

get

Authorizations

Path parameters

idinteger · int64Required

Id, example: 500062133

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

get

GET /itcare/databases/mariadb/{id} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

{
  "allowMonitoringDisplay": true,
  "backupPolicyDetails": {
    "backups": [
      {
        "backupLastDate": "2025-05-08T20:40:48.395Z",
        "backupSize": 1,
        "id": 1,
        "type": "text"
      }
    ],
    "policies": [
      {
        "backupLastDate": "2025-05-08T20:40:48.395Z",
        "backupSize": 1,
        "durationInHours": 1,
        "frequencies": {},
        "label": "text",
        "name": "text",
        "policyId": "text",
        "replication": true,
        "scope": "text",
        "startTime": "text",
        "timezone": "text",
        "type": "text"
      }
    ]
  },
  "backupStatus": true,
  "category": "text",
  "cloudId": 1,
  "cloudName": "text",
  "comment": "text",
  "cpu": 1,
  "creationTime": "text",
  "creationUser": "text",
  "endOfSalesAt": "2025-05-08T20:40:48.395Z",
  "endOfSupportAt": "2025-05-08T20:40:48.395Z",
  "environment": "text",
  "extendedSupportAt": "2025-05-08T20:40:48.395Z",
  "family": "text",
  "id": 1,
  "internalResourceId": 1,
  "internalType": "text",
  "label": "text",
  "metrologyUrl": "text",
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "monitoringOnCallEnabled": true,
  "monitoringRequested": true,
  "name": "text",
  "nodeCount": 1,
  "patchParty": {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2025-05-08T20:40:48.395Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2025-05-08T20:40:48.395Z",
    "patchGroup": "text",
    "patchTag": "text"
  },
  "path": "text",
  "prettyLabel": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "ram": 1,
  "releasedAt": "2025-05-08T20:40:48.395Z",
  "replicationStatus": true,
  "resourceType": "text",
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "status": "text",
  "supportPhase": "text",
  "technology": "text",
  "topology": "text",
  "type": "text",
  "url": "text",
  "version": "text"
}

Create a MariaDB instance

post

This method allows to create a Maria DB instance.

You will have to know at the minimum :

the area of the region where you want to host your cluster (area attribute). Areas can be available in List Regions method.
name of Maria DB cluster (name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.
Size of nodes in the maria DB cluster (nodeSizing attribute). Ex: 2cpu2gb
storage needed on each data node of the Maria DB cluster (diskSize attribute). The possible values are at least 40 and maximum 1024 (representing GB).
how to connect to the instance (admPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.
version of the Maria DB cluster (Maria DBVersion attribute). Example: 13
On which service the Maria DB instance belongs to (serviceId attribute).
network ID of the cluster (networkId attribute).
Number of instances in the Maria DB cluster (instanceCount attribute). Minimum 1 and maximum 3
topology of the Maria DB cluster (topology attribute). Either single or cluster

optional fields:

Availability zone of the Maria DB cluster (az attribute).
TLS enabled boolean for the redis cluster (tlsEnabled 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 /mariadb
{
  "version": "10.6",
  "region" : "EB",
  "area": "EB-QA",
  "az": "az",
  "name": "Test123",
  "nodeSizing": "2cpu2gb",
  "diskSize": 40,
  "networkId": 1234511,
  "serviceId": 46922,
  "admPassword": "Test123@2022",
  "instanceCount": 1,
  "topology" : "SINGLE"
}

Authorizations

Body

admPasswordstringRequired

The admin password

Pattern: ^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#&()–{}:;',?/*~$^+=<>]).{12,20}$

areastringRequired

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.

authenticationDomainstringOptional

azstringOptional

Availability zone of the maria DB

backupEnabledbooleanOptional

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

cloudIdinteger · int64Optional

dbBackupPolicyIdstringOptional

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

diskSizeinteger · int32Required

The storage needed on each data node of the maria DB

instanceCountinteger · int32Required

Number of instances to create for mariadb

monitoringAlertingbooleanOptional

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

monitoringEnabledbooleanOptional

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.

namestringRequired

Name of maria DB

Pattern: [a-z0-9\-]{4,60}$

networkIdinteger · int64Required

The network Id of the ELS cluster

noBackupProdReasonstringOptional

Indicates why a production resource is not under backup.

noMonitoringProdReasonstringOptional

Indicates why a production resource is not under monitoring.

noReplicationProdReasonstringOptional

Indicates why a production resource is not replicated.

nodeSizingstringRequired

Node sizing for cluster

onCallSupervisionbooleanOptional

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

platformstringRequired

Product platform of the cluster

regionstringRequired

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

regulationstringOptional

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

replicationEnabledbooleanOptional

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

serverBackupPolicyIdstringOptional

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

serviceIdinteger · int64Required

id of service to put instance in.

topologystring · enumRequiredPossible values:

versionstringOptional

Version of maria DB cluster

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

post

POST /itcare/databases/mariadb HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 546

{
  "admPassword": "text",
  "area": "text",
  "authenticationDomain": "text",
  "az": "text",
  "backupEnabled": true,
  "cloudId": 1,
  "dbBackupPolicyId": "text",
  "diskSize": 1,
  "instanceCount": 1,
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "name": "text",
  "networkId": 1,
  "noBackupProdReason": "text",
  "noMonitoringProdReason": "text",
  "noReplicationProdReason": "text",
  "nodeSizing": "text",
  "onCallSupervision": true,
  "platform": "text",
  "region": "text",
  "regulation": "text",
  "replicationEnabled": true,
  "serverBackupPolicyId": "text",
  "serviceId": 1,
  "topology": "SINGLE",
  "version": "text"
}

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:40:48.395Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Performs update state actions to an existing MariaDB instance

patch

This method allows to update a MariaDB instance.

Structure of payload is generic and describes :

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

Below are different operations currently implemented.

Start MariaDB instance

Use the start operation to start a MariaDB instance.

Starts kafka instance.

This method is synchronous (status code 202).

Example :

PATCH /mariadb/1234
{
    "operation": "start"
}

Stop MariaDB instance

Use the stop operation to stop the nodes of the MariaDB instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /compute/databases/mariadb/1234
{
	"operation":"stop"
}

Resize MariaDB instance

Use the resize operation to resize the sizing of the MariaDB instance.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /compute/databases/mariadb/1234
{
	"operation":"resize",
	"options" : {
	  "sizing" : "2cpu4gb"
	}
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the MariaDB instance.

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 /mariadb/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 for the MariaDB instance.

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 /mariadb/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

Exclude from patch party body:

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

Authorizations

Path parameters

idinteger · int64Required

Id, example: 123

Body

operationstringOptional

Responses

200

application/vnd.cegedim-it.v1+json

400

Bad Request

*/*

patch

PATCH /itcare/databases/mariadb/{id} HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "operation": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:40:48.395Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}