Glusterfs

List GlusterFS

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
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

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

azstring[]Optional

Availability Zone, example: EB-A, EB-B, EB-C, etc...

ipstring[]Optional

IPs, example: 10.59.13.29

vlanstring[]Optional

VLAN, example: EB_1125_DMZ8

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
chevron-right
200

OK

application/vnd.cegedim-it.v1+json
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberinteger · int32Optional
numberOfElementsinteger · int32Optional
sizeinteger · int32Optional
totalElementsinteger · int64Optional
totalPagesinteger · int32Optional
get
/storage/glusterfs

Create GlusterFS

post

This method allows to create a GlusterFS cluster.

You will have to know at the minimum :

  • the area or availability zone of the region where you want to host your GlusterFS (area & az attributes). Areas can be available in List Regions method.
  • the product code or platform of the Product (productCode & platform attributes).
  • 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
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Body
admPasswordstringRequired

The user password

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

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.

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

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

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.

supportLevelstring · enumOptional

Indicates monitoring and support level, if absent then we use boolean variables to describe which level

Possible values:
user_namestringRequiredPattern: [a-z0-9_\-]{1,32}$
Responses
post
/storage/glusterfs

Delete GlusterFS

delete
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

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

familystringOptional
idinteger · int32Optional
internalIdinteger · int64Optional
lastUpdatedAtstring · date-timeOptional
messagestringOptional

Human readable message of status

processstringOptional

Code of action performed

resourceNamestringOptional
resourceTypestringOptional
statusstring · enumOptional

Status label of action

Possible values:
delete
/storage/glusterfs/{id}

Get a GlusterFS

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

Gluster File System

allowMonitoringDisplaybooleanOptional
backupStatusbooleanOptional
categorystringOptional
cloudIdinteger · int64Optional
cloudNamestringOptional
commentstringOptional
cpuinteger · int64Optional
creationTimestringOptional
creationUserstringOptional
endOfSalesAtstring · date-timeOptional
endOfSupportAtstring · date-timeOptional
environmentstringOptional
extendedSupportAtstring · date-timeOptional
familystringOptional
idinteger · int64Optional
internalResourceIdinteger · int64Optional
internalTypestringOptional
ipAddressstringOptional
labelstringOptional
labelAreastringOptional

Area pretty name

labelAvailabilityZonestringOptional

Availability Zone pretty name

labelDataCenterstringOptional

DataCenter pretty name

labelRegionstringOptional

Region pretty name

metrologyUrlstringOptional
monitoringRequestedbooleanOptional
namestringOptional
nodeCountstringOptional
pathstringOptional
prettyLabelstringOptional
productCodestringOptional
productNamestringOptional
productVersionstringOptional
raminteger · int64Optional
releasedAtstring · date-timeOptional
replicationStatusbooleanOptional
resourceTypestringOptional
serviceIdinteger · int64Optional
serviceKeystringOptional
serviceNamestringOptional
sizingstringOptional
statusstringOptional
supportLevelstring · enumOptionalPossible values:
supportPhasestringOptional
technologystringOptional
topologystringOptional
typestringOptional
urlstringOptional
versionstringOptional
virtualIpstringOptional
get
/storage/glusterfs/{id}

Update 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 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
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required
Body
operationstringOptional
Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

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

familystringOptional
idinteger · int32Optional
internalIdinteger · int64Optional
lastUpdatedAtstring · date-timeOptional
messagestringOptional

Human readable message of status

processstringOptional

Code of action performed

resourceNamestringOptional
resourceTypestringOptional
statusstring · enumOptional

Status label of action

Possible values:
patch
/storage/glusterfs/{id}

Get GlusterFS network informations

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json
areastringOptional
cidrstringOptional
cloudstringOptional
defaultNetworkbooleanOptional
descriptionstringOptional
environmentstringOptional
gatewaystringOptional
idinteger · int64Optional
ipAddressstringOptional
ipFreeNumberinteger · int32Optional
isIpRangePublicbooleanOptional
maskstringOptional
networkShortDescriptionstringOptional
regionstringOptional
scopestringOptional
shortDescriptionstringOptional
technicalIdstringOptional
usedPercentinteger · int32Optional
get
/storage/glusterfs/{id}/networks

Get a GlusterFS node informations

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json
authenticationDomainstringOptional
backupStatusbooleanOptional
categorystringOptional
cloudIdinteger · int64Optional
cloudNamestringOptional
commentstringOptional
cpuinteger · int64Optional

CPU of the resource

creationTimestringOptional
creationUserstringOptional
endOfSalesAtstring · date-timeOptional
endOfSupportAtstring · date-timeOptional
environmentstringOptional
extendedSupportAtstring · date-timeOptional
familystringOptional
glfsTypestringOptional
idinteger · int64Optional
imageCodestringOptional

Internal Image linked to this instance

internalResourceIdinteger · int64Optional
internalTypestringOptional
ipAddressstringOptional
isExternalIngressNodebooleanOptional

This instance is ingress external node

isInternalIngressNodebooleanOptional

This instance is ingress internal node

isMemberOFLoadBalancerbooleanOptional

Instance is member of load balancer

labelstringOptional
labelAreastringOptional

Area pretty name

labelAvailabilityZonestringOptional

Availability Zone pretty name

labelDataCenterstringOptional

DataCenter pretty name

labelRegionstringOptional

Region pretty name

metrologyUrlstringOptional
monitoringRequestedbooleanOptional
namestringOptional
osNamestringOptional

OS name of this instance

osTypestringOptional

OS type of this instance

parentResourceTypestringOptional
pathstringOptional
prettyLabelstringOptional
productCodestringOptional
productNamestringOptional
productVersionstringOptional
raminteger · int64Optional

RAM of the resource

releasedAtstring · date-timeOptional
replicationStatusbooleanOptional
resourceTypestringOptional
serviceIdinteger · int64Optional
serviceKeystringOptional
serviceNamestringOptional
statusstringOptional
storagenumberOptional

Storage after disks format in GB of the resource

storageMoveInProgressbooleanOptional

Information about storage replication in Progress

supportLevelstring · enumOptionalPossible values:
supportPhasestringOptional
technologystringOptional
totalSizeDisksstringOptionalDeprecated

Total Disk size of the resource

typestringOptional
versionstringOptional
get
/storage/glusterfs/{id}/nodes

Get GlusterFS volumes

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json
freenumberOptional

Free Size in GB of FS

mountingPointstringOptional

Mounting point of FS

sizeOfnumberOptional

Total Size in GB of FS

typestringOptional

Type of FS

get
/storage/glusterfs/{id}/volumes

Last updated