GRgravitee-io
Clusters

Get a cluster

Changed on

User must have the CLUSTER_DEFINITION[READ] permission.

get/clusters/{clusterId}

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/clusters/{clusterId}
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Response

Cluster found

idstring
crossIdstring

Portable identifier for cross-environment references. Immutable after creation.

type'KAFKA_CLUSTER_STANDALONE' | 'KAFKA_CLUSTER' | 'KAFKA_VIRTUAL_CLUSTER'
createdAtstring date-time
updatedAtstring date-time
namestring
descriptionstring
configurationobject
groupsstring[]
lifecycleState'UNDEPLOYED' | 'DEPLOYED' | 'PENDING'

Current lifecycle state of the cluster.

deployedAtstring date-time

Last deployment or undeployment timestamp.

versioninteger

Deployment version, incremented on each deploy.

Changes

  • ac9b3975b952Revision changes
    • warning

      added the new KAFKA_VIRTUAL_CLUSTER enum value to the response property for the response status

  • 86ed32989ff4Revision changes
    • warning

      added the new KAFKA_CLUSTER_STANDALONE enum value to the response property for the response status

    • info

      removed the KAFKA_CLUSTER_CONNECTION enum value from the response property for the response status