Cluster:Get Cluster

Search (SHIFT+S)

API Reference


Get Cluster

GET /compute/clusters/{id}

Shows the information for one cluster.

idthe URN of a ViPR cluster

Required Roles

This call has no restrictions.


Response Body

All the non-null attributes of the cluster.

Field Description Type Notes
<cluster>
<project>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</project>      
<vcenter_data_center>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vcenter_data_center>      
<auto_export_enabled> If discovery will auto export to this cluster. Boolean
<volume_groups>
<volume_group>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</volume_group>      
</volume_groups>
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</cluster>

Examples

Request
GET https://192.168.0.0:4443/compute/clusters/urn:storageos:Cluster:a176eb9c-0b64-4335-9955-89bf1f46f53f: 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"?>
  <cluster>
       <creation_time>1379549055846</creation_time>
       <id>urn:storageos:Cluster:a176eb9c-0b64-4335-9955-89bf1f46f53f:</id>
       <inactive>false</inactive>
       <link href="/compute/clusters/urn:storageos:Cluster:a176eb9c-0b64-4335-9955-89bf1f46f53f:" rel="self"/>
       <name>Prov_QE_Cluster</name>
       <tags/>
       <tenant>
            <id>urn:storageos:TenantOrg:dbeb4135-e297-40d9-a5d4-9b40c73bdb4b:</id>
            <link href="/tenants/urn:storageos:TenantOrg:dbeb4135-e297-40d9-a5d4-9b40c73bdb4b:" rel="self"/>
       </tenant>
       <vcenter_data_center>
       <id>urn:storageos:VcenterDataCenter:0b463155-9a9c-4b38-84f2-c72b591d473c:</id>
       <link href="/compute/vcenter-data-centers/urn:storageos:VcenterDataCenter:0b463155-9a9c-4b38-84f2-c72b591d473c:" rel="self"/>
       </vcenter_data_center>
  </cluster>
Notes: