Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Nodes

GET /vdc/nodes

Gets the data nodes that are currently configured in the cluster.


Query Parameters

lockdown{locked|unlocked|all} if set will also return the nodes status
scopecan be "geo" which returns nodes for all vdcs.
skipGeoFailures{true|false} skip vdcs that fail the geo call. Only relevant if scope is "geo". Defaults to false.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR

  • NAMESPACE_ADMIN

  • SECURITY_ADMIN


Response Body

List of data nodes in the cluster.

Field Description Type Notes
nodes
node     0-* Elements
nodename Node name String
ip Public Node IP address String
mgmt_ip Management IP address String
geo_ip Geo IP address String
data_ip Public IP address String
data2_ip String
private_ip Private IP address String
nodeid Node Id String
rackId Node rack Id String
version Node version String
isLocal Node is local Boolean
status Node locked/unlocked status. Optional the status is only returned if the query parameter lockdown with an action of {locked|unlocked|all} is provided String

Examples

Request
GET https://192.168.0.0:4443/vdc/nodes HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK 
Content-Type: application/xml 
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<nodes>
    <node>
        <ip>10.249.249.151</ip>
        <isLocal>true</isLocal>
        <nodeid>10.249.249.151</nodeid>
        <nodename>provo-scarlet.sea.lab.emc.com</nodename>
        <rackId>scarlet</rackId>
        <status>unlocked</status>
        <version>2.2.1.0.76497.b81b36d</version>
    </node>
    <node>
        <ip>10.249.249.152</ip>
        <isLocal>false</isLocal>
        <nodeid>10.249.249.152</nodeid>
        <nodename>sandy-scarlet.sea.lab.emc.com</nodename>
        <rackId>scarlet</rackId>
        <status>unlocked</status>
        <version>2.2.1.0.76497.b81b36d</version>
    </node>
    <node>
        <ip>10.249.249.153</ip>
        <isLocal>false</isLocal>
        <nodeid>10.249.249.153</nodeid>
        <nodename>orem-scarlet.sea.lab.emc.com</nodename>
        <rackId>scarlet</rackId>
        <status>locked</status>
        <version>2.2.1.0.76497.b81b36d</version>
    </node>
    <node>
        <ip>10.249.249.154</ip>
        <isLocal>false</isLocal>
        <nodeid>10.249.249.154</nodeid>
        <nodename>ogden-scarlet.sea.lab.emc.com</nodename>
        <rackId>scarlet</rackId>
        <status>unlocked</status>
        <version>2.2.1.0.76497.b81b36d</version>
    </node>
    <node>
        <ip>10.249.249.155</ip>
        <isLocal>false</isLocal>
        <nodeid>10.249.249.155</nodeid>
        <nodename>layton-scarlet.sea.lab.emc.com</nodename>
        <rackId>scarlet</rackId>
        <status>unlocked</status>
        <version>2.2.1.0.76497.b81b36d</version>
    </node>
    <node>
        <ip>10.249.249.156</ip>
        <isLocal>false</isLocal>
        <nodeid>10.249.249.156</nodeid>
        <nodename>logan-scarlet.sea.lab.emc.com</nodename>
        <rackId>scarlet</rackId>
        <status>unlocked</status>
        <version>2.2.1.0.76497.b81b36d</version>
    </node>
    <node>
        <ip>10.249.249.157</ip>
        <isLocal>false</isLocal>
        <nodeid>10.249.249.157</nodeid>
        <nodename>lehi-scarlet.sea.lab.emc.com</nodename>
        <rackId>scarlet</rackId>
        <status>unlocked</status>
        <version>2.2.1.0.76497.b81b36d</version>
    </node>
    <node>
        <ip>10.249.249.158</ip>
        <isLocal>false</isLocal>
        <nodeid>10.249.249.158</nodeid>
        <nodename>murray-scarlet.sea.lab.emc.com</nodename>
        <rackId>scarlet</rackId>
        <status>unlocked</status>
        <version>2.2.1.0.76497.b81b36d</version>
    </node>
</nodes>