Specifying the resource to be managed

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

In REST API, domains are separated for each type of operation. The URL format differs for each domain. The domains used in REST API and the URL format are as follows:

Objects domain:

A domain for defining operations on each object subject to REST API operations, such as operations on storage system resources (for example, LDEVs or pools). Specify the URL in the following format:

protocol://host-name:port-number/ConfigurationManager/version/objects
Services domain:

A domain for defining the services provided by the REST API server. Services indicate batch operations for multiple objects, or operations for using or changing the configuration of the REST API server, such as locking or unlocking a resource group. Specify the URL in the following format:

protocol://host-name:port-number/ConfigurationManager/version/services
Configuration domain:

A domain for defining settings related to the REST API server, for example, collecting REST API version information. Specify the URL in the following format:

protocol://host-name:port-number/ConfigurationManager/configuration
Base URL:
protocol://host-name:port-number/ConfigurationManager
  • For the protocol, specify https or http. Specify a valid protocol in the storage system settings. We recommend using https for security.

  • Host name: Specify the IP address of the GUM (SVP) or a host name that can be resolved.

  • Port number: Specify the port number to be used for communications with the REST API server. The default port number is 443 for SSL communications, and 80 for non-SSL communications. The port number can be omitted if the default port number is used for communications.

  • Version: Specify the version of the REST API. Currently, only v1 can be specified.

Tip:

You can also specify the URL in the same format used for the Configuration Manager REST API. Specify the URL in the following format:

  • For the objects domain
    protocol://host-name:port-number/ConfigurationManager/version/objects/storages/storage-device-ID
  • For the services domain
    protocol://host-name:port-number/ConfigurationManager/version/storage-device-ID/services

For the storage device ID, specify a 12-digit value consisting of the fixed value designated for the model of the storage system and the storage system's 6-digit serial number. If the serial number is less than six digits, pad it with leading zeros. The fixed value designated for the storage system model is as follows.

Storage system

Fixed value

VSP 5100, 5500, 5100H, 5500H

VSP 5200, 5600, 5200H, 5600H

900000#1

VSP E590, VSP E790, VSP E590H, VSP E790H

934000

VSP E990

936000

VSP E1090, VSP E1090H

938000

VSP F370, F700, F900

VSP G370, G700, G900

886000

VSP F350

VSP G350

882000

VSP G130#2

880000

#1: These storage systems have serial numbers that are less than 6 digits. Pad the storage device ID with zeros, added after this designated value and before the serial number, to bring the total number of digits for the storage device ID up to 12.

#2: This model is available only in select markets. Contact your local sales representative for availability.

  • The following describes the URL formats supported by each domain.

    For the objects domain:

    URL formats (excluding the base URL)

    HTTP method

    Operations

    /v1/objects/storages

    GET

    Obtain general information about the target storage system

    /v1/objects/storages/instance

    You can also specify the URL in the following format:

    /v1/objects/storages/storage-device-ID

    GET

    Obtain detailed information about the target storage system

    /v1/objects/object-type

    You can also specify the URL in the following format:

    /v1/objects/storages/storage-device-ID/object-type

    GET

    Obtain a list of multiple objects

    POST

    Create new objects

    /v1/objects/object-type/object-ID

    You can also specify the URL in the following format:

    /v1/objects/storages/storage-device-ID/object-type/object-ID

    GET

    Obtain an object

    PATCH

    Change an attribute of an object

    DELETE

    Delete an object

    /v1/objects/object-type/object-ID/actions/action-name

    You can also specify the URL in the following format:

    /v1/objects/storages/storage-device-ID/object-type/object-ID/actions/action-name

    GET

    Obtain the action template for an object

    /v1/objects/object-type/object-ID/actions/action-name/invoke

    You can also specify the URL in the following format:

    /v1/objects/storages/storage-device-ID/object-type/object-ID/actions/action-name/invoke

    POST

    Run an action on an object

    For the services domain:

    URL formats (excluding the base URL)

    HTTP method

    Operations

    /v1/services/service-name/actions/action-name/invoke

    You can also specify the URL in the following format:

    /v1/storage-device-ID/services/service-name/actions/action-name/invoke

    POST

    Run a specific action of the service

    For the configuration domain:

    URL formats (excluding the base URL)

    HTTP method

    Operations

    configuration/version

    GET

    Obtain the version information of the REST API

The following is an example of a URL:

https://192.0.2.100/ConfigurationManager/v1/objects/ldevs