EMC ViPR REST API

Search (SHIFT+S)

API Reference


List File Virtual Pool

GET /file/vpools

List VirtualPool for File Store


Query Parameters

tenant-id
vdc-id

Required Roles

This call has no restrictions.


Response Body

Returns the VirtualPool user is authorized to see

Field Description Type Notes
<vpool_list>
<virtualpool>     0-* Elements
<vpool_type> The virtual pool type. Valid values: block = Volume file = File System object = Object Store String
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</virtualpool>      
</vpool_list>

Examples

Request
GET https://192.168.0.0:4443/file/vpools 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"?>
<vpool_list>
  <virtualpool>
    <id>urn:storageos:VirtualPool:bb133037-1f22-4cc5-84bc-7b90049c9ad0:</id>
    <link href="/file/vpools/urn:storageos:VirtualPool:bb133037-1f22-4cc5-84bc-7b90049c9ad0:" rel="self"/>
    <name>cosisi</name>
    <vpool_type>file</vpool_type>
  </virtualpool>
</vpool_list>