Getting a list of volumes

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can obtain a list of volumes and volume-related information, such as volume names and status.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/Volumes?page={page}&pageSize={size}

Query parameters

The following table describes the values for the supported parameters of a query string:

Parameter	Description
page={page}	(Optional) Specify the paging information (page to be obtained). Filtering conditions: Checks whether the comparison target is equal to the value
pageSize={size}	(Optional) Specify the number of items that can be displayed on 1 page. Filtering conditions: Checks whether the comparison target is equal to the value

Parameter

Description

page={page}

(Optional) Specify the paging information (page to be obtained).

Filtering conditions:

Checks whether the comparison target is equal to the value

pageSize={size}

(Optional) Specify the number of items that can be displayed on 1 page.

Filtering conditions:

Checks whether the comparison target is equal to the value

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is as follows:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of Volume objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

Volume

{
        "instanceID":"...",
        "status":"...",
        "ldev":"...",
        "storageSubsystemID":"...",
        "storageSubsystem":"...",
        "storageSubsystemMonitorStatus":"...",
        "parityGroup":"...",
        "storageSubsystemModel":"...",
        "hostGroupIDs":["...", ...],
        "hostGroupNames":["...", ...],
        "vssbComputeNodeNames":["...", ...],
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "gradeNames":["...", ...],
        "gradeOrders":["...", ...],
        "profileResourceType":"...",
        "virtualMachineIDs":["...", ...],
        "virtualMachineNames":["...", ...],
        "hostIDs":["...", ...],
        "hostNames":["...", ...],
        "groupIDsOfRelatedResources":["...", ...],
        "groupNamesOfRelatedResources":["...", ...],
        "lunOwnerIDs":["...", ...],
        "lunOwnerNames":["...", ...],
        "volumeLocation":"...",
        "ioControlSupportType":"...",
        "ioControlTaskIDs":["...", ...],
        "ioControlTaskNames":["...", ...],
        "ioControlLimitvalIOPS":"...",
        "ioControlLimitvalTransferRate":"...",
        "mixed":"...",
        "automationDirectorTaskIDs":["...", ...],
        "assignmentSchedule":"...",
        "virtualLdev":"...",
        "virtualStorageSubsystem":"...",
        "virtualStorageSubsystemModel":"...",
        "virtualStorageSubsystemSerialNumber":"...",
        "copyType":"...",
        "nvmSubsystemNQN":"...",
        "nvmNamespaceID":"...",
        "nvmHostNQNs":["...", ...],
        "nvmHostNicknames":["...", ...]
}

Volume (Type: Volume)

Attribute	Type	Description
instanceID	string	ID of the volume.
status	enum	Status of the volume. (For details about the valid values, see the table NodeStatusType in List of enumerators.) Normal Warning Critical Unknown
ldev	string	Name of the LDEV.
storageSubsystemID	string	ID of the storage system that the volume belongs to.
storageSubsystem	string	Name of the storage system that the volume belongs to.
storageSubsystemMonitorStatus	enum	Monitoring status of the storage system that the volume belongs to. (For details about the valid values, see the table ManagementLevelType in List of enumerators.) Manage
parityGroup	string	Name of the parity group that the volume belongs to.
storageSubsystemModel	string	Model name of the storage system that the volume belongs to.
hostGroupIDs	string[]	ID of the host group that the volume belongs to.
hostGroupNames	string[]	Name of the host group that the volume belongs to.
vssbComputeNodeNames	string[]	The Compute Node of the VSP One SDS Block volume
thresholdProfileID	string	ID of the threshold profile assigned to the volume.
thresholdProfileName	string	Name of the threshold profile assigned to the volume.
groupIDs	string[]	ID of the consumer assigned to the volume.
groupNames	string[]	Name of the consumer assigned to the volume.
gradeNames	string[]	Name of the grade of the consumer assigned to the volume.
gradeOrders	integer[]	Priority of the grade of the consumer assigned to the volume
profileResourceType	enum	Resource type of the threshold profile. (For details about the valid values, see the table PerformanceResourceType in List of enumerators.)
virtualMachineIDs	string[]	ID of the virtual machine that uses the volume.
virtualMachineNames	string[]	Name of the virtual machine that uses the volume.
hostIDs	string[]	ID of the host that uses the volume.
hostNames	string[]	ID of the host that uses the volume.
groupIDsOfRelatedResources	string[]	ID of the consumer assigned to the resource associated with the volume.
groupNamesOfRelatedResources	string[]	Name of the consumer assigned to the resource associated with the volume.
lunOwnerIDs	string[]	ID of LUN Owner associated with the volume.
lunOwnerNames	string[]	Name of LUN Owner associated with the volume.
volumeLocation	enum	The location of the volume. (For details about the valid values, see the table VolumeLocation in List of enumerators.) INTERNAL EXTERNAL_HIGH EXTERNAL_MID EXTERNAL_LOW EXTERNAL
ioControlSupportType	enum	I/O control support status. (For details about the valid values, see the table IoControlSupportType in List of enumerators.)
ioControlTaskIDs	string[]	ID of the I/O control task assigned to the volume.
ioControlTaskNames	string[]	Name of the I/O control task assigned to the volume.
ioControlLimitvalIOPS	long	Limit value(IOPS) of the I/O control task assigned to the volume.
ioControlLimitvalTransferRate	long	Upper limit for the transfer rate, in KBp set to the volume.
mixed	boolean	true if a path that is assigned I/O control and a path that is not assigned I/O control are mixed.
automationDirectorTaskIDs	string[]	Task IDs of Ops Center Automator
assignmentSchedule	dateTime	Scheduled Assignment Time
virtualLdev	string	Name of the virtual LDEV.
virtualStorageSubsystem	string	Name of the virtual storage machine that the volume belongs to.
virtualStorageSubsystemModel	string	Model name of the virtual storage machine that the volume belongs to.
virtualStorageSubsystemSerialNumber	string	Serial number of the virtual storage machine that the volume belongs to.
copyType	string	Copy Type
nvmSubsystemNQN	string	NVM subsystem NQN of volume.
nvmNamespaceID	string	NVM namespace ID of volume.
nvmHostNQNs	string[]	NVM host NQN of volume.
nvmHostNicknames	string[]	NVM host nickname of volume.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.
503	Service Unavailable	Analyzer detail view server communication error.

Example code

[Request Header]
GET /Analytics/v1/objects/Volumes
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 02:26:03 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : "raidLdev#10000-00^00^63",
    "status" : "Normal",
    "ldev" : "00:00:63",
    "storageSubsystemID" : "raidStorage#10000",
    "storageSubsystem" : "VSP 5500H (10000)",
    "storageSubsystemMonitorStatus" : "Manage",
    "parityGroup" : "01-29",
    "storageSubsystemModel" : "VSP 5500H",
    "hostGroupIDs" : [ ],
    "hostGroupNames" : [ ],
    "vssbComputeNodeNames" : [ ],
    "label" : "BasicVol_00099",
    "thresholdProfileID" : "thProfile#RAID_VOLUME",
    "thresholdProfileName" : "Default Profile for Volume",
    "groupIDs" : [ "group#0" ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "-" ],
    "gradeOrders" : [ 2147483647 ],
    "profileResourceType" : "RAID_VOLUME",
    "virtualMachineIDs" : [ ],
    "virtualMachineNames" : [ ],
    "hostIDs" : [ ],
    "hostNames" : [ ],
    "groupIDsOfRelatedResources" : [ ],
    "groupNamesOfRelatedResources" : [ ],
    "lunOwnerIDs" : [ ],
    "lunOwnerNames" : [ ],
    "volumeLocation" : "INTERNAL",
    "ioControlSupportType" : "supported",
    "ioControlTaskIDs" : [ ],
    "ioControlTaskNames" : [ ],
    "automationDirectorTaskIDs" : [ ],
    "nvmHostNQNs" : [ ],
    "nvmHostNicknames" : [ ]  }, {
  ........
  } ],
  "count" : 100
}