RabbitMQ

Create a RabbitMQ broker instance

This method allows to create a RabbitMQ instance.

You will have to know at the minimum :

• the area of the region where you want to host your broker (area attribute). Areas can be available in List Regions method.
• 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.
• version of the RabbitMQ cluster (rabbitMqVersion attribute). Example: 3.8.9
• 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
{
  "rabbitMqVersion": "3.8.9",
  "area": "EB-QA",
  "name": "Test123",
  "nodeSizing": "2cpu4gb",
  "brokerCount": 3,
  "diskSize": 40,
  "networkId": 1234511,
  "serviceId": 46922,
  "admPassword": "Test123@2022",
  "vmPrefix" : "AAAAAA"
}

POSThttps://api.cegedim.cloud/itcare/message-brokers/rabbitmq

Authorization

oauth2

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 RabbitMQ Broker

vmPrefix*string

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

diskSize*integer (int32)

The storage needed on each data node of the RabbitMQ Broker

admPassword*string

The admin password

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

brokerCount*integer (int32)

Number of brokers to create in RabbitMQ Broker

azstring

Availability zone of the RabbitMQ Broker

rabbitMqVersion*string

tlsEnabledboolean

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

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.cegedim.cloud/itcare/message-brokers/rabbitmq', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify({
      "serviceId": 1,
      "region": "text",
      "area": "text",
      "nodeSizing": "text",
      "networkId": 1,
      "platform": "text",
      "name": "text",
      "vmPrefix": "text",
      "diskSize": 1,
      "admPassword": "text",
      "brokerCount": 1,
      "rabbitMqVersion": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T03:49:57.945Z"
}

Get a RabbitMQ broker Instance available in the cloud

GEThttps://api.cegedim.cloud/itcare/message-brokers/rabbitmq/{id}

Authorization

oauth2

Path parameters

id*integer (int64)

id, example: 123

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

patchPartyobject

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsobject

managementUrlstring

versionstring

brokerSizestring

brokerCountinteger (int32)

tlsEnabledboolean

allowMonitoringDisplayboolean

cpuinteger (int64)

raminteger (int64)

Request

JavaScriptCurlPythonHTTP

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

Response

200400

{
  "id": 1,
  "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": 1,
  "cloudName": "text",
  "serviceId": 1,
  "serviceName": "text",
  "serviceKey": "text",
  "environment": "text",
  "endOfSupportAt": "2025-02-05T03:49:57.945Z",
  "supportPhase": "text",
  "creationUser": "text",
  "creationTime": "text",
  "releasedAt": "2025-02-05T03:49:57.945Z",
  "endOfSalesAt": "2025-02-05T03:49:57.945Z",
  "extendedSupportAt": "2025-02-05T03:49:57.945Z",
  "monitoringEnabled": true,
  "monitoringAlerting": true,
  "monitoringOnCallEnabled": true,
  "monitoringRequested": true,
  "replicationStatus": true,
  "backupStatus": true,
  "patchParty": {
    "excluded": true,
    "exclusionReason": "text",
    "patchGroup": "text",
    "patchDate": "2025-02-05T03:49:57.945Z",
    "patchTag": "text",
    "name": "text",
    "id": 1,
    "excludedBy": "text",
    "exclusionDate": "2025-02-05T03:49:57.945Z"
  },
  "metrologyUrl": "text",
  "path": "text",
  "resourceType": "text",
  "internalResourceId": 1,
  "backupPolicyDetails": {
    "backups": [
      {
        "id": 1,
        "type": "text",
        "backupSize": 1,
        "backupLastDate": "2025-02-05T03:49:57.945Z"
      }
    ],
    "policies": [
      {
        "name": "text",
        "label": "text",
        "scope": "text",
        "type": "text",
        "replication": true,
        "frequencies": {},
        "durationInHours": 1,
        "startTime": "text",
        "timezone": "text",
        "policyId": "text",
        "backupLastDate": "2025-02-05T03:49:57.945Z",
        "backupSize": 1
      }
    ]
  },
  "managementUrl": "text",
  "version": "text",
  "brokerSize": "text",
  "brokerCount": 1,
  "tlsEnabled": true,
  "allowMonitoringDisplay": true,
  "cpu": 1,
  "ram": 1
}

Delete an existing RabbitMQ broker instance

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

DELETEhttps://api.cegedim.cloud/itcare/message-brokers/rabbitmq/{id}

Authorization

oauth2

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

JavaScriptCurlPythonHTTP

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

Response

200400

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T03:49:57.945Z"
}

Performs update state actions to an existing RabbitMQ broker instance

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

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

PATCHhttps://api.cegedim.cloud/itcare/message-brokers/rabbitmq/{id}

Authorization

oauth2

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

JavaScriptCurlPythonHTTP

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

Response

200400

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T03:49:57.945Z"
}

Get a RabbitMQ node informations

GEThttps://api.cegedim.cloud/itcare/message-brokers/rabbitmq/{id}/nodes

Authorization

oauth2

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

patchPartyobject

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsobject

ipAddressstring

networkobject

storageInformationobject

Information about a Storage of an Instance

availabilityZoneobject

areaobject

regionobject

backupobject

Backup information on an instance

replicationobject

Replication information on an instance

snapshotobject

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

productstring

osImagestring

erlangVersionstring

nodesNumberstring

Request

JavaScriptCurlPythonHTTP

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

Response

200400

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

Get a RabbitMQ network informations

GEThttps://api.cegedim.cloud/itcare/message-brokers/rabbitmq/{id}/networks

Authorization

oauth2

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 object

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

Request

JavaScriptCurlPythonHTTP

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

Response

200400

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