Glusterfs

PreviousStorage NextOverdrive

Last updated 3 months ago

Get a GlusterFS

get

Authorizations

Path parameters

idinteger · int64Required

Responses

application/vnd.cegedim-it.v1+json

objectOptional

Gluster File System

*/*

get

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

{
  "allowMonitoringDisplay": true,
  "backupPolicyDetails": {
    "backups": [
      {
        "backupLastDate": "2025-04-21T12:04:54.880Z",
        "backupSize": 1,
        "id": 1,
        "type": "text"
      }
    ],
    "policies": [
      {
        "backupLastDate": "2025-04-21T12:04:54.880Z",
        "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-04-21T12:04:54.880Z",
  "endOfSupportAt": "2025-04-21T12:04:54.880Z",
  "environment": "text",
  "extendedSupportAt": "2025-04-21T12:04:54.880Z",
  "family": "text",
  "id": 1,
  "internalResourceId": 1,
  "internalType": "text",
  "label": "text",
  "metrologyUrl": "text",
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "monitoringOnCallEnabled": true,
  "monitoringRequested": true,
  "name": "text",
  "nodeCount": "text",
  "patchParty": {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2025-04-21T12:04:54.880Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2025-04-21T12:04:54.880Z",
    "patchGroup": "text",
    "patchTag": "text"
  },
  "path": "text",
  "prettyLabel": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "ram": 1,
  "releasedAt": "2025-04-21T12:04:54.880Z",
  "replicationStatus": true,
  "resourceType": "text",
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "sizing": "text",
  "status": "text",
  "supportPhase": "text",
  "technology": "text",
  "topology": "text",
  "type": "text",
  "url": "text",
  "version": "text",
  "virtualIp": "text"
}

Delete a GlusterFS by id

delete

Authorizations

Path parameters

idinteger · int64Required

Responses

application/vnd.cegedim-it.v1+json

objectOptional

An action gives status about processing of a task previously launched by an API call and asynchronously processed.

*/*

delete

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

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-04-21T12:04:54.880Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Get GlusterFS volumes

get

Authorizations

Path parameters

idinteger · int64Required

Responses

application/vnd.cegedim-it.v1+json

object[]Optional

*/*

get

GET /itcare/storage/glusterfs/{id}/volumes HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

[
  {
    "free": 1,
    "mountingPoint": "text",
    "sizeOf": 1,
    "type": "text"
  }
]

Get a GlusterFS node informations

get

Authorizations

Path parameters

idinteger · int64Required

Responses

application/vnd.cegedim-it.v1+json

object[]Optional

*/*

get

GET /itcare/storage/glusterfs/{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-04-21T12:04:54.880Z",
      "size": 1,
      "type": "text"
    },
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-04-21T12:04:54.880Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-04-21T12:04:54.880Z",
          "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-04-21T12:04:54.880Z",
    "endOfSupportAt": "2025-04-21T12:04:54.880Z",
    "environment": "text",
    "extendedSupportAt": "2025-04-21T12:04:54.880Z",
    "family": "text",
    "glfsType": "text",
    "id": 1,
    "imageCode": "text",
    "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-04-21T12:04:54.880Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-04-21T12:04:54.880Z",
      "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-04-21T12:04:54.880Z",
    "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-04-21T12:04:54.880Z",
      "createdBy": "text",
      "description": "text",
      "expiresAt": "2025-04-21T12:04:54.880Z",
      "id": "text",
      "label": "text",
      "recoveredAt": "2025-04-21T12:04:54.880Z",
      "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 GlusterFS network informations

get

Authorizations

Path parameters

idinteger · int64Required

Responses

application/vnd.cegedim-it.v1+json

object[]Optional

*/*

get

GET /itcare/storage/glusterfs/{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
  }
]

List GlusterFS

get

Authorizations

Query parameters

servicesinteger · int64[]Optional

namesstring[]Optional

Names, example: resource01,!resource02,resource42

environmentsstring[]Optional

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]Optional

Status, example: ACTIVE,INACTIVE

tagsstring[]Optional

Tags, example: mytagkey:mytagvalue,application:itcare

monitoringStatusbooleanOptional

Filter list by monitoring status

monitoringOnCallStatusbooleanOptional

Filter list by monitoring on call status

backupStatusbooleanOptional

Filter list by backup status

recoveryStatusbooleanOptional

Filter list by DRP status

includedInPatchPartybooleanOptional

Filter list by patch party status

topologiesstring[]Optional

Topology, example: Cluster

versionsstring[]Optional

Version, example: v1.26.15, v1.28.13, etc...

virtualIpsstring[]Optional

VirtualIp, example: 127.0.0.1, 127.0, 127, 10.%.62

cloudsintegerOptional

pagestringOptional

Results page you want to retrieve (0..N)

sizestringOptional

Number of records per page.

sortanyOptional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.

Responses

application/vnd.cegedim-it.v1+json

objectOptional

*/*

get

GET /itcare/storage/glusterfs HTTP/1.1
Host: api.cegedim.cloud
Accept: */*

{
  "content": [
    {
      "allowMonitoringDisplay": true,
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2025-04-21T12:04:54.880Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-04-21T12:04:54.880Z",
            "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-04-21T12:04:54.880Z",
      "endOfSupportAt": "2025-04-21T12:04:54.880Z",
      "environment": "text",
      "extendedSupportAt": "2025-04-21T12:04:54.880Z",
      "family": "text",
      "id": 1,
      "internalResourceId": 1,
      "internalType": "text",
      "label": "text",
      "metrologyUrl": "text",
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "name": "text",
      "nodeCount": "text",
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-04-21T12:04:54.880Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-04-21T12:04:54.880Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "ram": 1,
      "releasedAt": "2025-04-21T12:04:54.880Z",
      "replicationStatus": true,
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "sizing": "text",
      "status": "text",
      "supportPhase": "text",
      "technology": "text",
      "topology": "text",
      "type": "text",
      "url": "text",
      "version": "text",
      "virtualIp": "text"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 1,
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "sort": [
      {
        "ascending": true,
        "direction": "text",
        "ignoreCase": true,
        "nullHandling": "text",
        "property": "text"
      }
    ],
    "unpaged": true
  },
  "size": 1,
  "sort": [
    {
      "ascending": true,
      "direction": "text",
      "ignoreCase": true,
      "nullHandling": "text",
      "property": "text"
    }
  ],
  "totalElements": 1,
  "totalPages": 1
}

Create GlusterFS

post

This method allows to create a GlusterFS cluster.

You will have to know at the minimum :

the area of the region where you want to host your GlusterFS (area attribute). Areas can be available in List Regions method.
name of GlusterFS cluster (name attribute). The name can contain any lowercase characters, dashes and underscores.
storage needed (diskSize attribute). The possible values are at least 10 and maximum 1024 (representing GB).
how to connect to the cluster (admPassword attribute). The password must be between 12 and 20 characters with at least one lowercase character, one uppercase character, one digit and one special character
userName of the volume (userName attribute). Maximum size is 32 characters, lowercase characters, underscore and dashe are allowed
On which service the GlusterFS cluster belongs to (serviceId attribute).
network ID of the cluster (networkId 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 /storage/glusterfs
{
  "name": "mygluster01",
  "diskSize": "15",
  "admPassword": "mySuperPassword123!!",
  "userName": "dda",
  "networkId": 123,
  "area":"EB-A",
  "serviceId": 46922
}

Authorizations

Body

admPasswordstringRequired

The user 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.

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 volume configured within the configuration process of the GlusterFs cluster

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 GlusterFs cluster

Pattern: [a-z0-9_\-]{5,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.

user_namestringRequiredPattern: [a-z0-9_\-]{1,32}$

Responses

application/vnd.cegedim-it.v1+json

objectOptional

An action gives status about processing of a task previously launched by an API call and asynchronously processed.

*/*

post

POST /itcare/storage/glusterfs HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 468

{
  "admPassword": "text",
  "area": "text",
  "backupEnabled": true,
  "cloudId": 1,
  "dbBackupPolicyId": "text",
  "diskSize": 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,
  "user_name": "text"
}

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-04-21T12:04:54.880Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Update a GlusterFS

patch

This method allows to update a GlusterFS 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.

Start

Use the start operation to start a GlusterFS 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 /storage/glusterfs/1234
{
	"operation": "start",
	"options": {
	   "changeReference": "RFC_123"
	}
}

Stop

Use the stop operation to stop a GlusterFS cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /storage/glusterfs/1234
{
	"operation": "start",
	"options": {
	   "changeReference": "RFC_123"
	}
}

Resize GlusterFS instance

Use the resize operation to resize the nodes of the GlusterFS instance and the instance itself.

This operation cannot be undone afterwards.

This method is asynchronous (status code 202).

PATCH /storage/glusterfs/1234
{
	"operation":"resize",
	"options": {
        "sizing": "2cpu4gb"
    }
}

Add Volume

Use the add_volume operation to add a Volume to a GlusterFS cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /storage/glusterfs/1234
{
	"operation": "add_volume",
	"options": {
	   "diskSize": "42",
	   "userName": "dda",
	   "userPass":"mySuperPassw0rd42"
	}
}

Resize Volume

Use the resize_volume operation to resize a Volume to a GlusterFS cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /storage/glusterfs/1234
{
	"operation": "resize_volume",
	"options": {
	   "name":"dda",
	   "diskSize": "42",
	   "userName": "dda"
	}
}

Resize Volume

Use the delete_volume operation to delete a Volume from a GlusterFS cluster.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /storage/glusterfs/1234
{
	"operation": "delete_volume",
	"options": {
	   "name":"dda"
	}
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the GlusterFS 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 /storage/glusterfs/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 GlusterFS 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 /storage/glusterfs/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

Exclude from patch party body:

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

Authorizations

Path parameters

idinteger · int64Required

Body

operationstringOptional

optionsobjectOptional

Responses

application/vnd.cegedim-it.v1+json

objectOptional

An action gives status about processing of a task previously launched by an API call and asynchronously processed.

*/*

patch

PATCH /itcare/storage/glusterfs/{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-04-21T12:04:54.880Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}