Capacity:Get Cluster Capacity

Search (SHIFT+S)




Get Cluster Capacity

GET /object/capacity/{vArrayId}

Gets the cluster capacity of the specified storage pool. The details includes the provisioned capacity in GB and available capacity in GB.

vArrayIdStorage pool identifier for which to retrieve capacity

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR


Response Body

Capacity of the given storage pool.

Field Description Type Notes
<cluster_capacity>
<totalProvisioned_gb> Total provisioned capacity. Long
<totalFree_gb> Total free capacity. Long
</cluster_capacity>

Examples

Request
GET https://192.168.0.0:4443/object/capacity/urn:storageos:VirtualArray:c7fc54dc-6616-4b7e-a86c-0210ef9a8804 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_capacity>
    <totalFree_gb>739</totalFree_gb>
    <totalProvisioned_gb>750</totalProvisioned_gb>
</cluster_capacity>
Notes: