RabbitMQ

Create RabbitMQ instance

post

This method allows to create a RabbitMQ instance.

You will have to know at the minimum :

  • the area or availability zone of the region where you want to host your broker (area & az attributes). Areas can be available in List Regions method.
  • the product code (productCode attribute).
  • name of RabbitMQ broker (name attribute).
  • prefix od the RabbitMQ Broker (vmPrefix attribute).
  • number of brokers to create in RabbitMQ cluster (brokerCount attribute). The possible values are at least 1 or 3 and maximum 5.
  • storage needed on each data node of the RabbitMQ cluster (diskSize attribute). The possible values are at least 10 and maximum 2048 (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.
  • On which service the RabbitMQ instance belongs to (serviceId attribute).
  • network ID of the cluster (networkId attribute).

Optional parameters that might be helpful:

  • prefix of the virtual machine names for RabbitMQ Broker (vmPrefix attribute).
  • availability zone of the broker (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
{
   "productCode": "rabbitmq313",
  "area": "EB-QA",
  "name": "Test123",
  "nodeSizing": "2cpu4gb",
  "brokerCount": 3,
  "diskSize": 40,
  "networkId": 1234511,
  "serviceId": 46922,
  "admPassword": "Test123@2022",
  "vmPrefix" : "AAAAAA"
}
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Body
admPasswordstringRequired

The admin 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.

brokerCountinteger · int32 · min: 1 · max: 5Required

Number of brokers to create in RabbitMQ Broker

cloudIdinteger · int64Optional
dbBackupPolicyIdstringOptional

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

diskSizeinteger · int32 · min: 10 · max: 2048Required

The storage needed on each data node of the RabbitMQ Broker

namestringRequired

Name of RabbitMQ Broker

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

productCodestringRequired

code of product.

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:
tlsEnabledbooleanOptional
vmPrefixstringRequired

Prefix of the virtual machine names for RabbitMQ Broker (Clusters)

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:
post
/message-brokers/rabbitmq

Delete RabbitMQ instance

delete

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

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

id, example: 123

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
/message-brokers/rabbitmq/{id}

Get RabbitMQ instance

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Path parameters
idinteger · int64Required

id, example: 123

Responses
chevron-right
200

OK

application/vnd.cegedim-it.v1+json

RabbitMQBroker

allowMonitoringDisplaybooleanOptional
backupStatusbooleanOptional
brokerCountinteger · int32Optional
brokerSizestringOptional
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

managementUrlstringOptional
metrologyUrlstringOptional
monitoringRequestedbooleanOptional
namestringOptional
pathstringOptional
prettyLabelstringOptional
productCodestringOptional
productNamestringOptional
productVersionstringOptional
raminteger · int64Optional
releasedAtstring · date-timeOptional
replicationStatusbooleanOptional
resourceTypestringOptional
serviceIdinteger · int64Optional
serviceKeystringOptional
serviceNamestringOptional
statusstringOptional
supportLevelstring · enumOptionalPossible values:
supportPhasestringOptional
technologystringOptional
tlsEnabledbooleanOptional
typestringOptional
urlstringOptional
versionstringOptional
get
/message-brokers/rabbitmq/{id}

Update RabbitMQ instance

patch

This method allows to update a RabbitMQ 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 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 Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the broker.

  • 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 /message-brokers/rabbitmq/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}
  • Exclude from patch party body:
PATCH /message-brokers/rabbitmq/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

id, example: 123

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
/message-brokers/rabbitmq/{id}

Get a RabbitMQ network information

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
/message-brokers/rabbitmq/{id}/networks

Get node information

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
erlangVersionstringOptional
extendedSupportAtstring · date-timeOptional
familystringOptional
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
nodesNumberstringOptional
osImagestringOptional
osNamestringOptional

OS name of this instance

osTypestringOptional

OS type of this instance

parentResourceTypestringOptional
pathstringOptional
prettyLabelstringOptional
productstringOptional
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
get
/message-brokers/rabbitmq/{id}/nodes

Last updated