Clusters REST API

Use this REST API to manage clusters.

Get all clusters

Table 1. Get all clusters
REST API information Value Description
URI /admin/resources/clusters  
Method GET  
Returns 200 Returns a list of all clusters
404 The cluster list was not found
500 Platform System Manager encountered an internal error while processing the request.

Returns a list of clusters.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Response body

[
   {
      "vendor_informations": [
         "/admin/resources/vendor_informations/effc8b16-422d-4b42-9fc3-c1fac456b1e3"
      ],
      "racks": [
         "/admin/resources/racks/2611d67c-0ca4-4771-a14e-87d575cddfba"
      ],
      "created_time_raw": 1463766672196,
      "events": [
      ],
      "isas_rn": 1,
      "state": "available",
      "rebalance_enabled": "true",
      "label_text": "Cluster",
      "updated_time": "Fri 03 Jun 2016 13:35:28.242 UTC",
      "label_key": "pure0580",
      "version": "2.2.2.0",
      "id": "/admin/resources/clusters/194f342b-29a6-44f1-b705-570a8b3fc4d3",
      "ha_interval": 300000,
      "label_user": "Cluster",
      "updated_time_raw": 1464960928242,
      "locations": [
         "/admin/resources/locations/76553f68-b04b-4619-b4f8-f8a4ab7a08b1"
      ],
      "name": "Cluster 1",
      "created_time": "Fri 20 May 2016 17:51:12.196 UTC"
   }
]
created_time
The time at which the object is created.
id
The unique ID of the object in the system.
label_key
Key for retrieving label for the cluster.
label_text
Default translated message text.
label_user
User modified message text.
name
The name of the cluster.
rebalance_enabled
Indicates whether automatic rebalancing of instances is enabled. When rebalance is enabled, instances are optimally distributed across compute nodes within a cloud group.
state
The general availability of the object. If "pending" the object has been created but not activated. If "available" the object is active in the system.
updated_time
The time at which the object was last updated.

Children:

racks, vendor_informations, locations, events

Get a specific cluster

Table 2. Get a specific cluster
REST API information Value Description
URI /admin/resources/clusters/{id}  
Method GET  
Returns 200 The cluster was returned.
404 The cluster was not found
500 Platform System Manager encountered an internal error while processing the request.

Returns a single cluster that is identified by {id}.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Enable and disable rebalancing of instances

Table 3. Enable and disable rebalancing of instances
REST API information Value Description
URI /admin/resources/clusters/{id}  
Method PUT  
Returns 200 The cluster was updated.
404 The cluster was not found.
500 Platform System Manager encountered an internal error while processing the request.

You can update the cluster object to enable or disable automatic rebalancing of instances.

To disable rebalancing, use the following JSON body in your PUT method:
{ "rebalance_enabled" : "false" }
To enable rebalancing, use the following JSON body in your PUT method:
{ "rebalance_enabled" : "true" }
Note: Even when rebalancing is disabled, in the event of compute node failure, the system attempts to recover instances to other compute nodes.