Apache Curator · JSON Structure

Apache Curator Service Instance Structure

A service instance registered in ZooKeeper via Apache Curator service discovery.

Type: object Properties: 9 Required: 3

ApacheDistributed CoordinationDistributed SystemsJavaMavenOpen SourceService DiscoveryZooKeeper

ServiceInstance is a JSON Structure definition published by Apache Curator, describing 9 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name address port sslPort registrationTimeUTC serviceType enabled payload

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-curator/refs/heads/main/json-structure/apache-curator-service-instance-structure.json",
  "name": "ServiceInstance",
  "description": "A service instance registered in ZooKeeper via Apache Curator service discovery.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for this service instance.",
      "example": "abc123-def456"
    },
    "name": {
      "type": "string",
      "description": "Service name used to group instances.",
      "example": "payment-service"
    },
    "address": {
      "type": "string",
      "description": "Host address where this service is running.",
      "example": "10.1.2.3"
    },
    "port": {
      "type": "int32",
      "description": "Port number this service is listening on.",
      "example": 8080
    },
    "sslPort": {
      "type": "int32",
      "description": "SSL port if the service supports HTTPS.",
      "example": 8443
    },
    "registrationTimeUTC": {
      "type": "int32",
      "description": "UTC timestamp (milliseconds) when this instance was registered.",
      "example": 1718153645993
    },
    "serviceType": {
      "type": "string",
      "description": "Service lifecycle type.",
      "enum": [
        "DYNAMIC",
        "STATIC",
        "PERMANENT"
      ],
      "example": "DYNAMIC"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether this service instance is currently enabled for discovery.",
      "example": true
    },
    "payload": {
      "type": "object",
      "description": "Optional user-defined payload data attached to this service instance."
    }
  },
  "required": [
    "id",
    "name",
    "serviceType"
  ]
}