Apache Kafka

Create Apache Kafka

post

This method allows to create an Apache Kafka platform.

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 the Apache Kafka platform (name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.
prefix of the node names for Apache Kafka platform (nodePrefix attribute). The prefix should be from 5 to 12 characters and can contain any uppercase character.
number of brokers to create in Apache Kafka platform (brokerCount attribute). The possible values are at least 3 and maximum 5.
storage needed on each data node of the Apache Kafka platform (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.
On which service the Apache Kafka platform belongs to (serviceId attribute).
network ID of the cluster (networkId 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/apache-kafka
{
  "productCode": "kafka_3_9_0",
  "area": "EB-QA",
  "name": "testkafka",
  "nodePrefix": "DM123",
  "nodeSizing": "2cpu4gb",
  "brokerCount": 3,
  "diskSize": 40,
  "networkId": 1234511,
  "serviceId": 46922,
  "admPassword": "Test123@2022"
}

Authorizations

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Body

admPasswordstringRequired

The admin password

Pattern: ^(?=.*\d)(?=.*[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: 3 · max: 5Required

Number of brokers to create in Kafka cluster

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: 40 · max: 1024Required

The storage needed on each data node of the ELS cluster

namestringRequired

Name of Kafka cluster

Pattern: (?!cluster$)([a-z0-9_]{5,60})$

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.

nodePrefixstring · min: 5 · max: 12Required

Prefix of the node names for Kafka cluster

Pattern: [A-Z0-9]{5,12}$

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:

Responses

200

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:

400

Bad Request

*/*

post

/message-brokers/apache-kafka

POST /itcare/message-brokers/apache-kafka HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/vnd.cegedim-it.v1+json
Accept: */*
Content-Length: 1975

{
  "admPassword": "text",
  "area": "text",
  "az": "text",
  "backupEnabled": true,
  "brokerCount": 1,
  "cloudId": 1,
  "dbBackupPolicyId": "text",
  "diskSize": 1,
  "name": "text",
  "networkId": 1,
  "noBackupProdReason": "text",
  "noMonitoringProdReason": "text",
  "noReplicationProdReason": "text",
  "nodePrefix": "text",
  "nodeSizing": "text",
  "product": {
    "BACKUP_POLICY_TYPE": "text",
    "CATEGORY_WEIGHT": 1,
    "CODE": "text",
    "COMMENT": "text",
    "DOCUMENTATION": "text",
    "EDITION": "text",
    "END_OF_SALES_AT": "2026-03-01T20:10:57.942Z",
    "END_OF_SUPPORT_AT": "2026-03-01T20:10:57.942Z",
    "ENFORCED_AUTH_DOMAIN": true,
    "EXTENDED_SUPPORT_AT": "2026-03-01T20:10:57.942Z",
    "FAMILY_WEIGHT": 1,
    "ID": "text",
    "IMG": "text",
    "LABEL": "text",
    "NAME": "text",
    "PLATFORM": "text",
    "PRODUCT_CATEGORY": "text",
    "PRODUCT_DISPLAYABLE": true,
    "PRODUCT_IS_DISABLED": true,
    "PRODUCT_IS_IN_BETA_MODE": true,
    "PRODUCT_MAGIC_FORMS": "text",
    "PRODUCT_SKIP_TECHNOLOGY": true,
    "PRODUCT_TECHNOLOGY": "text",
    "PRODUCT_VERSION": "text",
    "RELEASED_AT": "2026-03-01T20:10:57.942Z",
    "STATUS": "text",
    "SUPPORT_FORM_AVAILABLE": true,
    "SUPPORT_FORM_ID": "text",
    "SUPPORT_PHASE": "text",
    "TECH_FORMONLY": true,
    "TECH_WEIGHT": 1,
    "TYPE": "text",
    "VERSION": "text",
    "configuration": {
      "topologies": [
        {
          "alwaysOn": "text",
          "cluster": "text",
          "galera": "text",
          "ha": "text",
          "replica": "text",
          "sentinel": "text",
          "single": "text",
          "standalone": "text"
        }
      ]
    },
    "properties": [
      {
        "defaultValue": "text",
        "description": "text",
        "displayed": true,
        "editable": true,
        "key": "text",
        "mandatory": true,
        "value": "text"
      }
    ],
    "resources": [
      {
        "available": true,
        "id": "text",
        "optionDescrEn": "text",
        "optionDescrFr": "text",
        "optionName": "text",
        "optionOrder": "text",
        "ram": 1,
        "vcpus": 1
      }
    ],
    "storage": {
      "maxVolumes": 1,
      "minVolumeSize": 1,
      "totalSizeAuthorized": 1,
      "totalVolumesSize": 1,
      "volumes": [
        {
          "description": "text",
          "editable": 1,
          "exclFromSnap": 1,
          "id": "data",
          "mandatory": true,
          "max": 1,
          "min": 1,
          "order": 1,
          "sizeGb": 1,
          "system": true
        }
      ]
    }
  },
  "productCode": "text",
  "region": "text",
  "regulation": "text",
  "replicationEnabled": true,
  "serverBackupPolicyId": "text",
  "serviceId": 1,
  "supportLevel": "NO_MONITORING_NO_SUPPORT"
}

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2026-03-01T20:10:57.942Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Delete Apache Kafka

delete

This method allows to delete an Apache Kafka platform.

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/apache-kafka/123

Authorizations

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Path parameters

idinteger · int64Required

id, example: 123

Responses

200

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:

400

Bad Request

*/*

delete

/message-brokers/apache-kafka/{id}

DELETE /itcare/message-brokers/apache-kafka/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2026-03-01T20:10:57.942Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Get Apache Kafka instance

get

Authorizations

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Path parameters

idinteger · int64Required

id, example: 123

Responses

200

application/vnd.cegedim-it.v1+json

Kafka Messaging broker cluster

allowMonitoringDisplaybooleanOptional

areastringOptional

backupStatusbooleanOptional

bootstrapServerstringOptional

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

metrologyUrlstringOptional

monitoringRequestedbooleanOptional

namestringRequired

Name of Kafka cluster

nodeCountinteger · int64Optional

nodeSizingstringRequired

Node sizing for Kafka cluster

overloadedParamsstringOptional

pathstringOptional

platformIdstringOptional

prettyLabelstringOptional

productCodestringOptional

productNamestringOptional

productVersionstringOptional

raminteger · int64Optional

regionstringOptional

releasedAtstring · date-timeOptional

replicationStatusbooleanOptional

resourceTypestringOptional

restEndpointstringOptional

serviceIdinteger · int64Optional

serviceKeystringOptional

serviceNamestringOptional

statusstringOptional

supportLevelstring · enumOptionalPossible values:

supportPhasestringOptional

technologystringOptional

typestringOptional

urlstringOptional

versionstringOptional

zooKeeperstringOptional

400

Bad Request

*/*

get

/message-brokers/apache-kafka/{id}

GET /itcare/message-brokers/apache-kafka/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "allowMonitoringDisplay": true,
  "area": "text",
  "backupPolicyDetails": {
    "backups": [
      {
        "backupLastDate": "2026-03-01T20:10:57.942Z",
        "backupSize": 1,
        "id": 1,
        "type": "text"
      }
    ],
    "policies": [
      {
        "backupLastDate": "2026-03-01T20:10:57.942Z",
        "backupSize": 1,
        "durationInHours": 1,
        "frequencies": {},
        "label": "text",
        "name": "text",
        "policyId": "text",
        "replication": true,
        "scope": "text",
        "startTime": "text",
        "timezone": "text",
        "type": "text"
      }
    ]
  },
  "backupStatus": true,
  "bootstrapServer": "text",
  "category": "text",
  "cloudId": 1,
  "cloudName": "text",
  "comment": "text",
  "cpu": 1,
  "creationTime": "text",
  "creationUser": "text",
  "endOfSalesAt": "2026-03-01T20:10:57.942Z",
  "endOfSupportAt": "2026-03-01T20:10:57.942Z",
  "environment": "text",
  "extendedSupportAt": "2026-03-01T20:10:57.942Z",
  "family": "text",
  "id": 1,
  "internalResourceId": 1,
  "internalType": "text",
  "ipAddress": "text",
  "label": "text",
  "labelArea": "text",
  "labelAvailabilityZone": "text",
  "labelDataCenter": "text",
  "labelRegion": "text",
  "metrologyUrl": "text",
  "monitoringRequested": true,
  "name": "text",
  "network": {
    "area": "text",
    "cidr": "text",
    "cloud": "text",
    "defaultNetwork": true,
    "description": "text",
    "dns": [
      {
        "alias": "text",
        "domain": "text"
      }
    ],
    "environment": "text",
    "gateway": "text",
    "id": 1,
    "ipAddress": "text",
    "ipFreeNumber": 1,
    "isIpRangePublic": true,
    "mask": "text",
    "networkShortDescription": "text",
    "region": "text",
    "scope": "text",
    "shortDescription": "text",
    "technicalId": "text",
    "usedPercent": 1
  },
  "nodeCount": 1,
  "nodeSizing": "text",
  "overloadedParams": "text",
  "patchParty": {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2026-03-01T20:10:57.942Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2026-03-01T20:10:57.942Z",
    "patchGroup": "text",
    "patchTag": "text"
  },
  "path": "text",
  "platformId": "text",
  "prettyLabel": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "ram": 1,
  "region": "text",
  "releasedAt": "2026-03-01T20:10:57.942Z",
  "replicationStatus": true,
  "resourceType": "text",
  "restEndpoint": "text",
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "status": "text",
  "supportLevel": "NO_MONITORING_NO_SUPPORT",
  "supportPhase": "text",
  "technology": "text",
  "type": "text",
  "url": "text",
  "version": "text",
  "zooKeeper": "text"
}

Update Apache Kafka

patch

This method allows to update an Apache Kafka platform.

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 Apache Kafka instance

Use the start operation to start an Apache Kafka instance.

Starts Apache Kafka instance.

This method is synchronous (status code 202).

Example :

PATCH /message-brokers/apache-kafka/1234
{
    "operation": "start"
}

Stop Apache Kafka instance

Use the stop operation to stop the nodes of the Apache Kafka instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /message-brokers/apache-kafka/1234
{
	"operation":"stop"
}

Resize Apache Kafka instance

Use the resize operation to resize the sizing of the Apache Kafka instance.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /message-brokers/apache-kafka/1234
{
	"operation":"resize",
	"options" : {
	  "sizing" : "2cpu4gb"
	}
}

Reconfigure Apache Kafka instance

Use the reconfigure operation to update the Apache Kafka instance params.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /message-brokers/apache-kafka/1234
{
	"operation":"reconfigure",
	"options" : {
	  "param" : "param"
	}
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the Apache Kafka 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 /message-brokers/apache-kafka/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

Exclude from patch party body:

PATCH /message-brokers/apache-kafka/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

Add Apache Kafka node

Use the add-node operation to add broker node to the Apache Kafka instance.

storage needed on the new data node of the Apache Kafka platform (diskSize attribute). The possible values are at least 40 and maximum 1024 (representing GB).
need to add the Availability Zone for the new node (availabilityZone attribute).

This method is synchronous (status code 202).

PATCH /message-brokers/apache-kafka/1234
{
	"operation":"add-node",
	"options" : {
	  "diskSize" : 40,
	  "availabilityZone": "ET-A"
	}
}

Authorizations

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Path parameters

idinteger · int64Required

id, example: 123

Body

operationstringOptional

Responses

200

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:

400

Bad Request

*/*

patch

/message-brokers/apache-kafka/{id}

PATCH /itcare/message-brokers/apache-kafka/{id} HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "operation": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2026-03-01T20:10:57.942Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Get network informations

get

Authorizations

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Path parameters

idinteger · int64Required

Responses

200

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

400

Bad Request

*/*

get

/message-brokers/apache-kafka/{id}/networks

GET /itcare/message-brokers/apache-kafka/{id}/networks HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get node information

get

Authorizations

OAuth2implicitRequired

OAuth2 flow

Authorization URL:

Path parameters

idinteger · int64Required

Responses

200

application/vnd.cegedim-it.v1+json

authenticationDomainstringOptional

backupStatusbooleanOptional

brokerNodesstring[]Optional

categorystringOptional

cloudIdinteger · int64Optional

cloudNamestringOptional

commentstringOptional

controllerNodesstring[]Optional

cpuinteger · int64Optional

CPU of the resource

creationTimestringOptional

creationUserstringOptional

endOfSalesAtstring · date-timeOptional

endOfSupportAtstring · date-timeOptional

environmentstringOptional

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

osNamestringOptional

OS name of this instance

osTypestringOptional

OS type of this instance

parentResourceTypestringOptional

pathstringOptional

prettyLabelstringOptional

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

400

Bad Request

*/*

get

/message-brokers/apache-kafka/{id}/nodes

GET /itcare/message-brokers/apache-kafka/{id}/nodes HTTP/1.1
Host: api.cegedim.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "area": {
      "availabilityZones": [
        {
          "availabilityZoneGroup": "text",
          "datacenterId": "text",
          "defaultZone": true,
          "id": "text",
          "location": "text",
          "routable": true
        }
      ],
      "defaultArea": true,
      "id": "text",
      "location": "text",
      "regulation": "text"
    },
    "authenticationDomain": "text",
    "availabilityZone": {
      "availabilityZoneGroup": "text",
      "datacenterId": "text",
      "defaultZone": true,
      "id": "text",
      "location": "text",
      "routable": true
    },
    "backup": {
      "backupSystem": "text",
      "filesNb": 1,
      "lastDate": "2026-03-01T20:10:57.942Z",
      "size": 1,
      "type": "text"
    },
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2026-03-01T20:10:57.942Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2026-03-01T20:10:57.942Z",
          "backupSize": 1,
          "durationInHours": 1,
          "frequencies": {},
          "label": "text",
          "name": "text",
          "policyId": "text",
          "replication": true,
          "scope": "text",
          "startTime": "text",
          "timezone": "text",
          "type": "text"
        }
      ]
    },
    "backupStatus": true,
    "brokerNodes": [
      "text"
    ],
    "category": "text",
    "cloudId": 1,
    "cloudName": "text",
    "comment": "text",
    "controllerNodes": [
      "text"
    ],
    "cpu": 1,
    "creationTime": "text",
    "creationUser": "text",
    "endOfSalesAt": "2026-03-01T20:10:57.942Z",
    "endOfSupportAt": "2026-03-01T20:10:57.942Z",
    "environment": "text",
    "extendedSupportAt": "2026-03-01T20:10:57.942Z",
    "family": "text",
    "id": 1,
    "imageCode": "text",
    "internalResourceId": 1,
    "internalType": "text",
    "ipAddress": "text",
    "isExternalIngressNode": true,
    "isInternalIngressNode": true,
    "isMemberOFLoadBalancer": true,
    "label": "text",
    "labelArea": "text",
    "labelAvailabilityZone": "text",
    "labelDataCenter": "text",
    "labelRegion": "text",
    "loadbalancers": [
      {
        "id": 1,
        "memberCount": 1,
        "name": "text",
        "serviceId": 1,
        "status": "text"
      }
    ],
    "metrologyUrl": "text",
    "monitoringRequested": true,
    "name": "text",
    "network": {
      "area": "text",
      "cidr": "text",
      "cloud": "text",
      "defaultNetwork": true,
      "description": "text",
      "dns": [
        {
          "alias": "text",
          "domain": "text"
        }
      ],
      "environment": "text",
      "gateway": "text",
      "id": 1,
      "ipAddress": "text",
      "ipFreeNumber": 1,
      "isIpRangePublic": true,
      "mask": "text",
      "networkShortDescription": "text",
      "region": "text",
      "scope": "text",
      "shortDescription": "text",
      "technicalId": "text",
      "usedPercent": 1
    },
    "osName": "text",
    "osType": "text",
    "parentResourceType": "text",
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2026-03-01T20:10:57.942Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2026-03-01T20:10:57.942Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "ram": 1,
    "region": {
      "areas": [
        {
          "availabilityZones": [
            {
              "availabilityZoneGroup": "text",
              "datacenterId": "text",
              "defaultZone": true,
              "id": "text",
              "location": "text",
              "routable": true
            }
          ],
          "defaultArea": true,
          "id": "text",
          "location": "text",
          "regulation": "text"
        }
      ],
      "dataCenter": "text",
      "id": "text",
      "location": "text"
    },
    "releasedAt": "2026-03-01T20:10:57.942Z",
    "replication": {
      "noStoRplExplanation": "text",
      "storageClass": "text",
      "storageClassOverride": "text",
      "storageMoveInProgress": true,
      "storageMoveTicket": "text",
      "storageReplicationClass": "text"
    },
    "replicationStatus": true,
    "resourceType": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "snapshot": {
      "changeReference": "text",
      "createdAt": "2026-03-01T20:10:57.942Z",
      "createdBy": "text",
      "description": "text",
      "expiresAt": "2026-03-01T20:10:57.942Z",
      "id": "text",
      "label": "text",
      "recoveredAt": "2026-03-01T20:10:57.942Z",
      "snapshotSize": 1
    },
    "status": "text",
    "storage": 1,
    "storageInformation": {
      "fileSystems": [
        {
          "free": 1,
          "mountingPoint": "text",
          "sizeOf": 1,
          "type": "text"
        }
      ],
      "totalSizeDisks": 1,
      "totalSizeFileSystems": 1
    },
    "storageMoveInProgress": true,
    "supportLevel": "NO_MONITORING_NO_SUPPORT",
    "supportPhase": "text",
    "technology": "text",
    "type": "text"
  }
]

PreviousMessaging NextMessage Brokers

Last updated 6 months ago

hashtagCreate Apache Kafka

hashtagDelete Apache Kafka

hashtagGet Apache Kafka instance

hashtagUpdate Apache Kafka

hashtagGet network informations

hashtagGet node information

Create Apache Kafka

Delete Apache Kafka

Get Apache Kafka instance

Update Apache Kafka

Get network informations

Get node information