Apache ZooKeeper Configuration API
Server configuration information
OpenAPI Specification
openapi: 3.1.0
info:
title: Apache ZooKeeper Admin Server Cluster Configuration API
description: The ZooKeeper Admin Server provides an HTTP interface for monitoring and management commands. It exposes four-letter-word equivalent commands as REST endpoints for cluster monitoring, configuration, and diagnostics.
version: 3.9.0
contact:
name: Apache ZooKeeper
url: https://zookeeper.apache.org/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080/commands
description: Local ZooKeeper Admin Server
- url: http://{zk_host}:{port}/commands
description: Custom ZooKeeper Admin Server
variables:
zk_host:
default: localhost
port:
default: '8080'
tags:
- name: Configuration
description: Server configuration information
paths:
/conf:
get:
operationId: getConfiguration
summary: Apache ZooKeeper Get Server Configuration
description: Returns details of the current server configuration. Equivalent to the 'conf' four-letter-word command.
tags:
- Configuration
responses:
'200':
description: Server configuration
content:
application/json:
schema:
type: object
properties:
client_port:
type: integer
description: Port for client connections
data_dir:
type: string
description: Snapshot directory
data_log_dir:
type: string
description: Transaction log directory
tick_time:
type: integer
description: Basic time unit in milliseconds
max_client_cnxns:
type: integer
description: Maximum client connections per IP
min_session_timeout:
type: integer
max_session_timeout:
type: integer
server_id:
type: integer
init_limit:
type: integer
sync_limit:
type: integer
election_alg:
type: integer
election_port:
type: integer
quorum_port:
type: integer
command:
type: string
error:
type: string
nullable: true
examples:
GetConfiguration200Example:
summary: Default getConfiguration 200 response
x-microcks-default: true
value: {}
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/environment:
get:
operationId: getEnvironment
summary: Apache ZooKeeper Get Server Environment
description: Returns details of the serving environment. Equivalent to the 'envi' four-letter-word command.
tags:
- Configuration
responses:
'200':
description: Server environment details
content:
application/json:
schema:
type: object
properties:
zookeeper.version:
type: string
host.name:
type: string
java.version:
type: string
java.vendor:
type: string
java.home:
type: string
java.class.path:
type: string
java.library.path:
type: string
java.io.tmpdir:
type: string
java.compiler:
type: string
os.name:
type: string
os.arch:
type: string
os.version:
type: string
user.name:
type: string
user.home:
type: string
user.dir:
type: string
command:
type: string
error:
type: string
nullable: true
examples:
GetEnvironment200Example:
summary: Default getEnvironment 200 response
x-microcks-default: true
value: {}
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/dirs:
get:
operationId: getDirectorySize
summary: Apache ZooKeeper Get Data Directory Sizes
description: Shows the total size of snapshot and log files in bytes.
tags:
- Configuration
responses:
'200':
description: Directory sizes
content:
application/json:
schema:
type: object
properties:
datadir_size:
type: integer
logdir_size:
type: integer
command:
type: string
error:
type: string
nullable: true
examples:
GetDirectorySize200Example:
summary: Default getDirectorySize 200 response
x-microcks-default: true
value: {}
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/initial_configuration:
get:
operationId: getInitialConfiguration
summary: Apache ZooKeeper Get Initial Configuration
description: Returns the initial configuration text used to start the ensemble.
tags:
- Configuration
responses:
'200':
description: Initial configuration
content:
application/json:
schema:
type: object
properties:
initial_configuration:
type: string
command:
type: string
error:
type: string
nullable: true
examples:
GetInitialConfiguration200Example:
summary: Default getInitialConfiguration 200 response
x-microcks-default: true
value: {}
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/system_properties:
get:
operationId: getSystemProperties
summary: Apache ZooKeeper Get JVM System Properties
description: Returns the JVM system properties.
tags:
- Configuration
responses:
'200':
description: System properties
content:
application/json:
schema:
type: object
additionalProperties:
type: string
examples:
GetSystemProperties200Example:
summary: Default getSystemProperties 200 response
x-microcks-default: true
value: {}
x-microcks-operation:
delay: 0
dispatcher: FALLBACK