OpenSearch

Create an OpenSearch Cluster

This method allows to create an OpenSearch 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 OpenSearch 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 OpenSearch cluster (nodeSizing attribute). Ex: 2cpu4gb
• storage needed on each data node of the OpenSearch 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 OpenSearch cluster (clusterVersion attribute). Example: 1.2.3
• On which service the OpenSearch instance belongs to (serviceId attribute).
• network ID of the cluster (networkId attribute).
• Number of instances in the OpenSearch cluster (instanceCount attribute). Must be odd and at least be 3, recommended is 5, Maximum is 51
• Node prefix of the OpenSearch cluster (nodePrefix attribute). 4 to 60 uppercase characters

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

POST /opensearch
{
  "clusterVersion": "1.2.3",
  "region" : "EB",
  "area": "EB-QA",
  "az": "az",
  "name": "Test123",
  "nodeSizing": "2cpu4gb",
  "diskSize": 40,
  "networkId": 1234511,
  "serviceId": 46922,
  "admPassword": "Test123@2022",
  "instanceCount": "3",
  "nodePrefix" : "OPESTC"
}

post

/databases/opensearch

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.

backupEnabledboolean

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

cloudIdinteger · int64

clusterVersionstringrequired

dbBackupPolicyIdstring

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

instanceCountstringrequired

Number of instances to create in ELS cluster

Pattern: [13579]$

monitoringAlertingboolean

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

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.

namestringrequired

Name of els cluster

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

networkIdinteger · int64required

The network Id of the ELS cluster

noBackupProdReasonstring

Indicates why a production resource is not under backup.

noMonitoringProdReasonstring

Indicates why a production resource is not under monitoring.

noReplicationProdReasonstring

Indicates why a production resource is not replicated.

nodePrefixstringrequired

Prefix of the node names for els cluster

Pattern: [A-Z0-9-.]{4,60}$

nodeSizingstringrequired

Node sizing for cluster

onCallSupervisionboolean

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.

regulationstring

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

replicationEnabledboolean

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

serverBackupPolicyIdstring

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.

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.cegedim.cloud/itcare/databases/opensearch' \
  --header 'Content-Type: application/vnd.cegedim-it.v1+json' \
  --data '{
    "admPassword": "text",
    "area": "text",
    "backupEnabled": true,
    "cloudId": 1,
    "clusterVersion": "text",
    "dbBackupPolicyId": "text",
    "diskSize": 1,
    "instanceCount": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "name": "text",
    "networkId": 1,
    "noBackupProdReason": "text",
    "noMonitoringProdReason": "text",
    "noReplicationProdReason": "text",
    "nodePrefix": "text",
    "nodeSizing": "text",
    "onCallSupervision": true,
    "platform": "text",
    "region": "text",
    "regulation": "text",
    "replicationEnabled": true,
    "serverBackupPolicyId": "text",
    "serviceId": 1
  }'

200

400

200

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T12:57:41.202Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

OK

Delete an existing OpenSearch Cluster

This method allows to delete an OpenSearch 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 /opensearch/123

delete

/databases/opensearch/{id}

Authorizations

Path parameters

idinteger · int64required

id, example: 123

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.cegedim.cloud/itcare/databases/opensearch/{id}'

200

400

200

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T12:57:41.202Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

OK

Get a OpenSearch Cluster Instance available in the cloud

get

/databases/opensearch/{id}

Authorizations

Path parameters

idinteger · int64required

id, example: 500060248

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/databases/opensearch/{id}'

200

400

200

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

OK

Performs update state actions to an existing OpenSearch Cluster instance

This method allows to update an OpenSearch 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 OpenSearch instance

Use the start operation to start an OpenSearch instance.

Starts OpenSearch instance.

This method is synchronous (status code 202).

Example :

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

Stop OpenSearch instance

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

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /opensearch/1234
{
	"operation":"stop"
}

Add nodes the OpenSearch instance

Use the add_nodes operation to add nodes to the OpenSearch instance. nodesCount must be even

This method is synchronous (status code 202).

PATCH /opensearch/1234
{
	"operation":"add_nodes",
	"options" : {
	  "diskSize" : 10,
	  "nodeSize" : "2cpu4gb",
	  "nodesCount": 2
	}
}

Resize OpenSearch instance

Use the resize_nodes operation to resize the sizing of the OpenSearch nodes.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /opensearch/1234
{
	"operation":"resize_nodes",
	"options" : {
	  "nodeSize" : "2cpu4gb",
	  "nodes" : ["node1"]
	}
}

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

• Exclude from patch party body:

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

patch

/databases/opensearch/{id}

Authorizations

Path parameters

idinteger · int64required

id, example: 123

Body

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

operationstring

optionsobject

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.cegedim.cloud/itcare/databases/opensearch/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "operation": "text",
    "options": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }'

200

400

200

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-03-09T12:57:41.202Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

OK

Get an OpenSearch network information

get

/databases/opensearch/{id}/networks

Authorizations

Path parameters

idinteger · int64required

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/databases/opensearch/{id}/networks'

200

400

200

[
  {
    "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
  }
]

OK

Get an OpenSearch node information

get

/databases/opensearch/{id}/nodes

Authorizations

Path parameters

idinteger · int64required

Responses

application/vnd.cegedim-it.v1+json

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.cegedim.cloud/itcare/databases/opensearch/{id}/nodes'

200

400

200

[
  {
    "area": {
      "availabilityZones": [
        {
          "availabilityZoneGroup": "text",
          "datacenterId": "text",
          "defaultZone": true,
          "id": "text",
          "location": "text",
          "routable": true
        }
      ],
      "defaultArea": true,
      "id": "text",
      "location": "text",
      "regulation": "text"
    },
    "authenticationDomain": "text",
    "autoRestart": true,
    "availabilityZone": {
      "availabilityZoneGroup": "text",
      "datacenterId": "text",
      "defaultZone": true,
      "id": "text",
      "location": "text",
      "routable": true
    },
    "backup": {
      "backupSystem": "text",
      "filesNb": 1,
      "lastDate": "2025-03-09T12:57:41.202Z",
      "size": 1,
      "type": "text"
    },
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-03-09T12:57:41.202Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-03-09T12:57:41.202Z",
          "backupSize": 1,
          "durationInHours": 1,
          "frequencies": {},
          "label": "text",
          "name": "text",
          "policyId": "text",
          "replication": true,
          "scope": "text",
          "startTime": "text",
          "timezone": "text",
          "type": "text"
        }
      ]
    },
    "backupStatus": true,
    "caHostName": "text",
    "category": "text",
    "cloudId": 1,
    "cloudName": "text",
    "clusterId": 1,
    "comment": "text",
    "configOverwrite": true,
    "cpu": 1,
    "creationTime": "text",
    "creationUser": "text",
    "dashboards": true,
    "elsKibana": true,
    "elsType": "text",
    "endOfSalesAt": "2025-03-09T12:57:41.202Z",
    "endOfSupportAt": "2025-03-09T12:57:41.202Z",
    "environment": "text",
    "extendedSupportAt": "2025-03-09T12:57:41.202Z",
    "family": "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"
      }
    ],
    "masters": [
      "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
    },
    "nodeAttributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "osName": "text",
    "osType": "text",
    "parentResourceType": "text",
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-03-09T12:57:41.202Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-03-09T12:57:41.202Z",
      "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-03-09T12:57:41.202Z",
    "replication": {
      "noStoRplExplanation": "text",
      "storageClass": "text",
      "storageClassOverride": "text",
      "storageMoveInProgress": true,
      "storageMoveTicket": "text",
      "storageReplicationClass": "text"
    },
    "replicationStatus": true,
    "resourceType": "text",
    "roles": [
      "text"
    ],
    "serviceEnable": true,
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "snapshot": {
      "changeReference": "text",
      "createdAt": "2025-03-09T12:57:41.202Z",
      "createdBy": "text",
      "description": "text",
      "expiresAt": "2025-03-09T12:57:41.202Z",
      "id": "text",
      "label": "text",
      "recoveredAt": "2025-03-09T12:57:41.202Z",
      "snapshotSize": 1
    },
    "specificConfNodeTemp": "text",
    "specificConfNodeTest": true,
    "status": "text",
    "storage": 1,
    "storageInformation": {
      "fileSystems": [
        {
          "free": 1,
          "mountingPoint": "text",
          "sizeOf": 1,
          "type": "text"
        }
      ],
      "totalSizeDisks": 1,
      "totalSizeFileSystems": 1
    },
    "storageMoveInProgress": true,
    "supportPhase": "text",
    "technology": "text",
    "totalSizeDisks": "text",
    "type": "text",
    "version": "text"
  }
]

OK