Data Store:Get Bulk Resources

Search (SHIFT+S)




Get Bulk Resources

POST /vdc/data-stores/bulk

Retrieves list of resource (data store) representations based on input Ids.


Required Roles

  • SYSTEM_ADMIN


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<ids>
<id> Data store identifier URI 0-* Elements
</ids>

Response Body

List of representations.

Field Description Type Notes
<bulk_data_stores>
<data_store>     0-* Elements
<device_state>

State of the data store

  • uninitialized - has not been initialized, unavailable for use
  • initializing - being initialized
  • initialized - initialized, ready for use
  • deleting - being deleted, can not be used
  • deleted - deleted, no longer exists
  • String Valid Values:
    •  uninitialized, initializing, initialized, deleting, deleted
    <device_info> Device additional information String
    <data_services_varray> Storage pool which is used for this data store String
    <usable_gb> Total capacity for this data store Long
    <free_gb> Estimated available capacity for this data store Long
    <description> Description for this data store String
    <name> Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
    <id> Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
    •  urn:storageos:resource-type:UUID:
    <link> Hyperlink to the details for this resource
    <creation_time> Timestamp that shows when this resource was created in ECS DateTime Valid Values:
    •  YYYY-MM-DDTHH:mm:ssZ
    <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> Indicates whether the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ECS database. Boolean Valid Values:
    •  true
    •  false
    <global> Indicates whether the resource is global. Boolean Valid Values:
    •  true
    •  false
    <remote> Indicates whether the resource is remote. Boolean Valid Values:
    •  true
    •  false
    <vdc>    
    <id> ECS Id of the related object URI
    <link> Hyperlink to the related object
    </vdc>      
    <internal> Indicated whether the resource is an internal resource Boolean Valid Values:
    •  true
    •  false
    </data_store>      
    </bulk_data_stores>

    Examples

    Request
    POST https://192.168.0.0:4443/vdc/data-stores/bulk HTTP/1.1
    
    Content-Type: application/xml
    X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
    
    <ids>
       <id>urn:storageos:HostingDeviceInfo:7da9b904-ffcb-42f3-b00c-a5fddb93bbfc:vdc1</id>
       <id>urn:storageos:HostingDeviceInfo:e85ec76b-3ab4-4dcc-b2f6-b7ac0ab24536:vdc1</id>
    </ids>
    Response
    HTTP/1.1 200 OK
    Content-Type: application/xml
    
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <bulk_data_stores>
        <data_store>
            <id>urn:storageos:HostingDeviceInfo:7da9b904-ffcb-42f3-b00c-a5fddb93bbfc:vdc1</id>
            <name>Data Store</name>
            <tags/>
            <free_gb>0</free_gb>
            <data_services_varray>urn:storageos:VirtualArray:22b0d65d-a682-4f70-b70c-8a1ac5f45401:vdc1</data_services_varray>
            <description></description>
            <device_state>initialized</device_state>
            <usable_gb>0</usable_gb>
            <used_gb>0</used_gb>
        </data_store>
        <data_store>
            <id>urn:storageos:HostingDeviceInfo:e85ec76b-3ab4-4dcc-b2f6-b7ac0ab24536:vdc1</id>
            <name>Data Store 2</name>
            <tags/>
            <free_gb>0</free_gb>
            <data_services_varray>urn:storageos:VirtualArray:22b0d65d-a682-4f70-b70c-8a1ac5f45401:vdc1</data_services_varray>
            <description></description>
            <device_state>initialized</device_state>
            <usable_gb>0</usable_gb>
            <used_gb>0</used_gb>
        </data_store>
    </bulk_data_stores>
    Notes: