Cluster requests

Cluster settings requests

Get cluster info

GET /v1/cluster

Get cluster info.

Required permissions

Request

Example HTTP request

GET /v1/cluster 

Request headers

Response

Returns a cluster object.

Example JSON body

{
 "name": "my-rlec-cluster",
 "alert_settings": { "..." },
 "created_time": "2015年04月29日T09:09:25Z",
 "email_alerts": false,
 "email_from": "",
 "rack_aware": false,
 "smtp_host": "",
 "smtp_password": "",
 "smtp_port": 25,
 "smtp_tls_mode": "none",
 "smtp_username": ""
}

Status codes

Update cluster settings

PUT /v1/cluster

Update cluster settings.

If called with the dry_run URL query string, the function will validate the cluster object, but will not apply the requested changes.

Required permissions

Request

Example HTTP request

PUT /v1/cluster 

Example JSON body

{
 "email_alerts": true,
 "alert_settings": {
 "node_failed": true,
 "node_memory": {
 "enabled": true,
 "threshold": "80"
 }
 }
}

The above request will enable email alerts and alert reporting for node failures and node removals.

Request headers

URL parameters

Request body

Include a cluster object with updated fields in the request body.

Response

Example JSON body

{
 "name": "mycluster.mydomain.com",
 "email_alerts": true,
 "alert_settings": {
 "node_failed": true,
 "node_memory": {
 "enabled": true,
 "threshold": "80"
 }
 },
 "// additional fields..."
}

Error codes

When errors are reported, the server may return a JSON object with error_code and message field that provide additional information. The following are possible error_code values:

Status codes