RabbitMQ
Last updated
Français
Last updated
This method allows to delete a RabbitMQ broker 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 /message-brokers/rabbitmq/123
id, example: 123
This method allows to create a RabbitMQ instance.
You will have to know at the minimum :
area attribute). Areas can be available in List Regions method.name attribute).vmPrefix attribute).brokerCount attribute). The possible values are at least 1 or 3 and maximum 5.diskSize attribute). The possible values are at least 10 and maximum 2048 (representing GB).admPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.rabbitMqVersion attribute). Example: 3.8.9serviceId attribute).networkId attribute).Optional parameters that might be helpful:
vmPrefix attribute).az 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 /message-brokers/rabbitmq
{
"rabbitMqVersion": "3.8.9",
"area": "EB-QA",
"name": "Test123",
"nodeSizing": "2cpu4gb",
"brokerCount": 3,
"diskSize": 40,
"networkId": 1234511,
"serviceId": 46922,
"admPassword": "Test123@2022",
"vmPrefix" : "AAAAAA"
}
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.
Availability zone of the RabbitMQ Broker
Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.
Number of brokers to create in RabbitMQ Broker
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 RabbitMQ Broker
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 RabbitMQ Broker
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.
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.
Prefix of the virtual machine names for RabbitMQ Broker (Clusters)
This method allows to update a RabbitMQ 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 RabbitMQ instance
Use the start operation to start a RabbitMQ instance.
Starts RabbitMQ instance.
This method is synchronous (status code 202).
Example :
PATCH /message-brokers/rabbitmq/1234
{
"operation": "start"
}
Stop RabbitMQ instance
Use the stop operation to stop the nodes of the RabbitMQ instance and the instance itself.
This operation cannot be undone afterwards.
This method is synchronous (status code 202).
PATCH /message-brokers/rabbitmq/1234
{
"operation":"stop"
}
Resize RabbitMQ instance
Use the resize operation to resize the sizing of the RabbitMQ.
This operation cannot be undone afterwards.
This method is synchronous (status code 202).
PATCH /message-brokers/rabbitmq/1234
{
"operation":"resize",
"options" : {
"sizing" : "2cpu4gb"
}
}
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 /message-brokers/rabbitmq/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 broker.
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 /message-brokers/rabbitmq/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": false,
"patchGroup": "3"
}
}
}
PATCH /message-brokers/rabbitmq/1234
{
"operation": "update_patch_party",
"options": {
"patchParty": {
"excluded": true,
"exclusionReason": "I want to handle this by myself"
}
}
}
id, example: 123