Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Commodity Data Store Associated With Storage Pool

GET /vdc/data-stores/commodity/{id}

Gets the details for a commodity data store

idIdentifier of the data store

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR


Response Body

Commodity data store hosting device information

Field Description Type Notes
commodity_data_store
id Id of this commodity node URI
varray Storage pool associated with this commodity data store URI
ip IP address of this node String
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
    •  Unix timestamp
    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
    internal Indicated whether the resource is an internal resource Boolean Valid Values:
    •  true
    •  false

    Examples

    Request
    GET https://192.168.0.0:4443/vdc/data-stores/commodity/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"?>
    <commodity_data_store>
        <creation_time>1424837036000</creation_time>
        <link rel="self" href="/vdc/object-pools/1"/>
        <name>1</name>
        <tags/>
        <free_gb>247</free_gb>
        <description>Commodity Sanity Node</description>
        <device_info></device_info>
        <device_state>readytouse</device_state>
        <usable_gb>250</usable_gb>
        <used_gb>3</used_gb>
        <id>1</id>
        <varray>urn:storageos:VirtualArray:c7fc54dc-6616-4b7e-a86c-0210ef9a8804</varray>
    </commodity_data_store>