Specifying resources to manage (URL)

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
For REST API requests that include simple in the request line, the resources to manage must be specified in URL format.

To specify resources to manage, specify the URL in the following format:

protocol://host:port/application/version/domain
  • protocol

    Specify https or http.

    Specify a valid protocol in the storage system settings.

    We recommend using https for security.

  • host

    Specify the IP address of the SVP or a host name that can be resolved.

  • port

    Specify the port number to use for communication.

    The default port number is 443 (for SSL communication) and 80 (for non-SSL communication). The port number can be omitted if the default port number is used for communications.

  • application

    Specify ConfigurationManager/simple.

Note:

In this document, protocol://host:port/ConfigurationManager is indicated as a base URL.

  • version

    Specify the version of the REST API request that includes simple in the request line. Currently, only v1 can be specified.

  • domain

    Specify the domain. Currently only objects can be specified.

    The URL formats are as follows.

    Under objects, specify the type of object on which operations will be performed:

    • performances
    • qos-groups

The following tables describe the URL formats supported for object type.

Resources for the object type performances:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/performances/qos-groups/object-ID

GET

Synchronous

Getting performance information for a specific QoS group

Resources for the object type qos-groups:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/qos-groups

GET

Synchronous

Getting a list of QoS groups

/simple/v1/objects/qos-groups/object-ID

GET

Synchronous

Getting information for a specific QoS group

REST API requests that include simple in the request line have the following processing methods:

  • Synchronous processing

    The processing results are returned as the response.

Note:

A maximum of 16 requests can be executed at the same time.