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"
}

POSThttps://api.cegedim.cloud/itcare/databases/opensearch

Body

application/vnd.cegedim-it.v1+json

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

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

nodePrefix*string

Prefix of the node names for els cluster

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

instanceCount*string

Number of instances to create in ELS cluster

Pattern: [13579]$

diskSize*integer (int32)

The storage needed on each data node of the ELS cluster

admPassword*string

The admin password

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

clusterVersion*string

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

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

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/databases/opensearch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify({
      "admPassword": "text",
      "area": "text",
      "clusterVersion": "text",
      "diskSize": 0,
      "instanceCount": "text",
      "name": "text",
      "networkId": 0,
      "nodePrefix": "text",
      "nodeSizing": "text",
      "platform": "text",
      "region": "text",
      "serviceId": 0
    }),
});
const data = await response.json();

Response

200

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 0,
  "internalId": 0,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-01-02T14:58:09.552Z"
}

Get a OpenSearch Cluster Instance available in the cloud

GEThttps://api.cegedim.cloud/itcare/databases/opensearch/{id}

Path parameters

id*integer (int64)

id, example: 500060248

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

name*string

Name of els cluster

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

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

managementUrlsarray of string

Management Urls host of the ELS Cluster

versionstring

elsTypestring

allowMonitoringDisplayboolean

cpuinteger (int64)

raminteger (int64)

nodeCountinteger (int64)

farmTopologystring

dedicatedIngestboolean

Request

JavaScriptCurlPython

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

Response

200

{
  "id": 0,
  "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": 0,
  "cloudName": "text",
  "serviceId": 0,
  "serviceName": "text",
  "serviceKey": "text",
  "environment": "text",
  "endOfSupportAt": "2025-01-02T14:58:09.552Z",
  "supportPhase": "text",
  "creationUser": "text",
  "creationTime": "text",
  "releasedAt": "2025-01-02T14:58:09.552Z",
  "endOfSalesAt": "2025-01-02T14:58:09.552Z",
  "extendedSupportAt": "2025-01-02T14:58:09.552Z",
  "monitoringEnabled": false,
  "monitoringAlerting": false,
  "monitoringOnCallEnabled": false,
  "monitoringRequested": false,
  "replicationStatus": false,
  "backupStatus": false,
  "patchParty": {
    "excluded": false,
    "exclusionReason": "text",
    "patchGroup": "text",
    "patchDate": "2025-01-02T14:58:09.552Z",
    "patchTag": "text",
    "name": "text",
    "id": 0,
    "excludedBy": "text",
    "exclusionDate": "2025-01-02T14:58:09.552Z"
  },
  "metrologyUrl": "text",
  "path": "text",
  "resourceType": "text",
  "internalResourceId": 0,
  "backupPolicyDetails": {
    "backups": [
      {
        "id": 0,
        "type": "text",
        "backupSize": 0,
        "backupLastDate": "2025-01-02T14:58:09.552Z"
      }
    ],
    "policies": [
      {
        "name": "text",
        "label": "text",
        "scope": "text",
        "type": "text",
        "replication": false,
        "durationInHours": 0,
        "startTime": "text",
        "timezone": "text",
        "policyId": "text",
        "backupLastDate": "2025-01-02T14:58:09.552Z",
        "backupSize": 0
      }
    ]
  },
  "managementUrls": [
    "text"
  ],
  "version": "text",
  "elsType": "text",
  "allowMonitoringDisplay": false,
  "cpu": 0,
  "ram": 0,
  "nodeCount": 0,
  "farmTopology": "text",
  "dedicatedIngest": false
}

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

DELETEhttps://api.cegedim.cloud/itcare/databases/opensearch/{id}

Path parameters

id*integer (int64)

id, example: 123

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

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

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/databases/opensearch/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 0,
  "internalId": 0,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-01-02T14:58:09.552Z"
}

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"
    }
 }
}

PATCHhttps://api.cegedim.cloud/itcare/databases/opensearch/{id}

Path parameters

id*integer (int64)

id, example: 123

Body

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

operationstring

optionsobject

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

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

JavaScriptCurlPython

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

Response

200

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 0,
  "internalId": 0,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-01-02T14:58:09.552Z"
}

Get an OpenSearch node information

GEThttps://api.cegedim.cloud/itcare/databases/opensearch/{id}/nodes

Path parameters

id*integer (int64)

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

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

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

ipAddressstring

networkNetworkV1 (object)

storageInformationStorageInformationV1 (object)

Information about a Storage of an Instance

availabilityZoneAvailabilityZoneV1 (object)

areaAreaV1 (object)

regionRegionV1 (object)

backupBackupV1 (object)

Backup information on an instance

replicationReplicationV1 (object)

Replication information on an instance

snapshotSnapshotV1 (object)

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 LoadbalancerInfoV1 (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

versionstring

elsTypestring

elsKibanaboolean

dashboardsboolean

rolesarray of string

mastersarray of string

serviceEnableboolean

configOverwriteboolean

autoRestartboolean

caHostNamestring

specificConfNodeTempstring

specificConfNodeTestboolean

clusterIdinteger (int64)

nodeAttributesobject

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": 0,
    "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": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-02T14:58:09.552Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-02T14:58:09.552Z",
    "endOfSalesAt": "2025-01-02T14:58:09.552Z",
    "extendedSupportAt": "2025-01-02T14:58:09.552Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-02T14:58:09.552Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-02T14:58:09.552Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-02T14:58:09.552Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-02T14:58:09.552Z",
          "backupSize": 0
        }
      ]
    },
    "ipAddress": "text",
    "network": {
      "id": 0,
      "technicalId": "text",
      "cidr": "text",
      "description": "text",
      "scope": "text",
      "defaultNetwork": false,
      "usedPercent": 0,
      "ipFreeNumber": 0,
      "ipAddress": "text",
      "dns": [
        {
          "alias": "text",
          "domain": "text"
        }
      ],
      "mask": "text",
      "networkShortDescription": "text",
      "isIpRangePublic": false,
      "cloud": "text",
      "environment": "text",
      "shortDescription": "text",
      "gateway": "text",
      "region": "text",
      "area": "text"
    },
    "storageInformation": {
      "totalSizeDisks": 0,
      "fileSystems": [
        {
          "mountingPoint": "text",
          "type": "text",
          "sizeOf": 0,
          "free": 0
        }
      ],
      "totalSizeFileSystems": 0
    },
    "availabilityZone": {
      "id": "text",
      "location": "text",
      "routable": false,
      "defaultZone": false,
      "datacenterId": "text",
      "availabilityZoneGroup": "text"
    },
    "area": {
      "id": "text",
      "location": "text",
      "regulation": "text",
      "defaultArea": false,
      "availabilityZones": [
        {
          "id": "text",
          "location": "text",
          "routable": false,
          "defaultZone": false,
          "datacenterId": "text",
          "availabilityZoneGroup": "text"
        }
      ]
    },
    "region": {
      "id": "text",
      "location": "text",
      "areas": [
        {
          "id": "text",
          "location": "text",
          "regulation": "text",
          "defaultArea": false,
          "availabilityZones": [
            {
              "id": "text",
              "location": "text",
              "routable": false,
              "defaultZone": false,
              "datacenterId": "text",
              "availabilityZoneGroup": "text"
            }
          ]
        }
      ],
      "dataCenter": "text"
    },
    "backup": {
      "backupSystem": "text",
      "size": 0,
      "type": "text",
      "filesNb": 0,
      "lastDate": "2025-01-02T14:58:09.552Z"
    },
    "replication": {
      "storageClass": "text",
      "storageReplicationClass": "text",
      "storageClassOverride": "text",
      "storageMoveInProgress": false,
      "storageMoveTicket": "text",
      "noStoRplExplanation": "text"
    },
    "snapshot": {
      "id": "text",
      "label": "text",
      "createdBy": "text",
      "createdAt": "2025-01-02T14:58:09.552Z",
      "recoveredAt": "2025-01-02T14:58:09.552Z",
      "expiresAt": "2025-01-02T14:58:09.552Z",
      "description": "text",
      "changeReference": "text",
      "snapshotSize": 0
    },
    "labelRegion": "text",
    "labelDataCenter": "text",
    "labelArea": "text",
    "labelAvailabilityZone": "text",
    "totalSizeDisks": "text",
    "cpu": 0,
    "ram": 0,
    "storage": 0,
    "isMemberOFLoadBalancer": false,
    "loadbalancers": [
      {
        "id": 0,
        "name": "text",
        "status": "text",
        "monitoringEnabled": false,
        "memberCount": 0,
        "serviceId": 0
      }
    ],
    "imageCode": "text",
    "osName": "text",
    "osType": "text",
    "isExternalIngressNode": false,
    "isInternalIngressNode": false,
    "storageMoveInProgress": false,
    "authenticationDomain": "text",
    "parentResourceType": "text",
    "version": "text",
    "elsType": "text",
    "elsKibana": false,
    "dashboards": false,
    "roles": [
      "text"
    ],
    "masters": [
      "text"
    ],
    "serviceEnable": false,
    "configOverwrite": false,
    "autoRestart": false,
    "caHostName": "text",
    "specificConfNodeTemp": "text",
    "specificConfNodeTest": false,
    "clusterId": 0
  }
]

Get an OpenSearch network information

GEThttps://api.cegedim.cloud/itcare/databases/opensearch/{id}/networks

Path parameters

id*integer (int64)

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

technicalIdstring

cidrstring

descriptionstring

scopestring

defaultNetworkboolean

usedPercentinteger (int32)

ipFreeNumberinteger (int32)

ipAddressstring

dnsarray of DNSV1 (object)

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

Request

JavaScriptCurlPython

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

Response

200

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