CLUSTERAPI

ClusterApi

Method	HTTP request	Description
httpcludel	DELETE /v1/cluster/daemon/{daemon-id}	Remove a node from the cluster by daemon ID. Used for self-initiated node removal (e.g., when a node loses all mountpaths).
httpcluget	GET /v1/cluster	Query cluster states, statistics, and information. Supports various query types: node stats, system info, backends, remote AIS, mountpaths, etc.
httpclupost	POST /v1/cluster/{operation}	Handle cluster join operations and node keepalives.
httpcluput	PUT /v1/cluster	Administrative cluster operations: configuration changes, node management, log rotation, shutdown/decommission operations.

httpcludel

Object httpcludel()

Remove a node from the cluster by daemon ID. Used for self-initiated node removal (e.g., when a node loses all mountpaths).

Example: Delete cluster

curl -i -L -X DELETE \
  'AIS_ENDPOINT/v1/cluster/daemon/{daemon-id}'

Parameters

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

httpcluget

Object httpcluget(what)

Query cluster states, statistics, and information. Supports various query types: node stats, system info, backends, remote AIS, mountpaths, etc.

Example: Get cluster

curl -i -L -X GET \
  'AIS_ENDPOINT/v1/cluster?what=<value>'

Parameters

Name	Type	Description
what	String	\

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

httpclupost

Object httpclupost()

Handle cluster join operations and node keepalives.

Example: Post cluster

curl -i -L -X POST \
  'AIS_ENDPOINT/v1/cluster/{operation}'

Parameters

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

httpcluput

Object httpcluput(request, transient)

Administrative cluster operations: configuration changes, node management, log rotation, shutdown/decommission operations.

Supported actions: set-config, reset-config, rotate-logs, shutdown, decommission, start-maintenance, decommission-node, shutdown-node, rm-unsafe, stop-maintenance, reset-stats, clear-lcache, ActXactStart, ActXactStop, reload-creds, bump-metasync

Example: set-config

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "set-config", "value": {"timeout": {"send_file_time": "10m"}}}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: reset-config

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "reset-config"}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: rotate-logs

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "rotate-logs"}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: shutdown

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "shutdown"}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: decommission

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "decommission", "value": {"sid": "target_id", "skip_rebalance": false, "rm_user_data": true}}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: start-maintenance

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "start-maintenance", "value": {"sid": "target_id", "skip_rebalance": false}}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: decommission-node

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "decommission-node", "value": {"sid": "target_id", "skip_rebalance": false, "rm_user_data": true}}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: shutdown-node

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "shutdown-node", "value": {"sid": "target_id", "skip_rebalance": false}}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: rm-unsafe

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "remove-node-unsafe", "value": {"sid": "target_id", "skip_rebalance": false}}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: stop-maintenance

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "stop-maintenance", "value": {"sid": "target_id"}}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: reset-stats

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "reset-stats", "value": false}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: clear-lcache

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "clear-lcache"}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: ActXactStart

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "start-xaction", "name": "rebalance"}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: ActXactStop

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "stop-xaction", "name": "rebalance"}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: reload-creds

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "reload-backend-creds", "name": "aws"}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Example: bump-metasync

curl -i -L -X PUT \
  -H 'Content-Type: application/json' \
  -d '{"action": "bump-metasync"}' \
  'AIS_ENDPOINT/v1/cluster?transient=<value>'

Parameters

transient

Boolean

transient - in-memory only

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /