OpenSearch
Last updated
Français
Last updated
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
id, example: 123
This method allows to create an OpenSearch instance.
You will have to know at the minimum :
area attribute). Areas can be available in List Regions method.name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.nodeSizing attribute). Ex: 2cpu4gbdiskSize attribute). The possible values are at least 40 and maximum 1024 (representing GB).admPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.clusterVersion attribute). Example: 1.2.3serviceId attribute).networkId attribute).instanceCount attribute). Must be odd and at least be 3, recommended is 5, Maximum is 51nodePrefix attribute). 4 to 60 uppercase charactersThis 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"
}
The admin password
^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#&()–{}:;',?/*~$^+=<>]).{12,20}$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.
Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.
BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.
The storage needed on each data node of the ELS cluster
Number of instances to create in ELS cluster
[13579]$Indicates if alerting should be activated. If absent, set to false.
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.
Name of els cluster
[a-z0-9_\-]{4,60}$The network Id of the ELS cluster
Indicates why a production resource is not under backup.
Indicates why a production resource is not under monitoring.
Indicates why a production resource is not replicated.
Prefix of the node names for els cluster
[A-Z0-9-.]{4,60}$Node sizing for cluster
Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.
Product platform of the cluster
Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.
Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.
Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment
BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.
id of service to put instance in.
This method allows to update an OpenSearch instance.
Structure of payload is generic and describes :
operation you want to be performedoptions 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.
excluded option to turn on/off patch party.patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.exclusionReason option to explain the reason of excluding the resource from patch part.This method is synchronous (status code 202).
PATCH /opensearch/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": false,
"patchGroup": "3"
}
}
}
PATCH /opensearch/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": true,
"exclusionReason": "I want to handle this by myself"
}
}
}
id, example: 123