Specifying resources to manage (URL)

Storage Advisor Embedded User Guide

Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

In the REST API, 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 GUM IP address or a host name that can be resolved. Specify either the GUM IP address for controller 1 (CTL1) or the GUM IP address for controller 2 (CTL2).

  • 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. Currently, only v1 can be specified.

    Note: Specifying the version is not necessary for the configuration domain.

  • domain

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

    Objects domain:
    A domain for defining the operations that can be performed on each object subject to REST API operations, such as operations on storage system resources (for example, volumes or pools)
    Configuration domain:
    A domain defined when operations related to the settings information for the REST API are performed

For the objects domain:

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

  • command-status
  • drives
  • external-path-groups
  • external-parity-groups
  • external-volumes
  • health-status
  • pools
  • ports
  • quorum-disks
  • servers
  • snapshot-groups
  • snapshots
  • storage
  • volumes
  • volume-server-connections

Resources for the object type command-status:

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

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/command-status/object-ID

GET

Synchronous

Obtains status information about an API function that performs asynchronous processing

DELETE

Synchronous

Clears status information about an API function that performs asynchronous processing

Resources for the object type drives:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/drives

GET

Synchronous

Obtains drive information

/simple/v1/objects/drives/actions/set-spare/invoke

POST

Asynchronous

Sets a specific spare drive

/simple/v1/objects/drives/actions/release-spare/invoke

POST

Asynchronous

Disables the settings of a specific spare drive

/simple/v1/objects/drives/object-ID

GET

Synchronous

Obtains information about a specific drive

Resources for the object type external-path-groups:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/external-path-groups

GET

Synchronous

Obtains information about external path groups

/simple/v1/objects/external-path-groups/object-ID

GET

Synchronous

Obtains information about a specific external path group

Resources for the object type external-parity-groups:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/external-parity-groups

GET

Synchronous

Obtains information about external parity groups

/simple/v1/objects/external-parity-groups/object-ID

GET

Synchronous

Obtains information about a specific external parity group

Resources for the object type external-volumes:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/external-volumes

GET

Synchronous

Obtains information about external volumes

POST

Asynchronous

Creates an external volume

/simple/v1/objects/external-volumes/object-ID

GET

Synchronous

Obtains information about a specific external volume

PATCH

Synchronous

Changes the nickname of an external volume

Resources for the object type health-status:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/health-status

GET

Synchronous

Obtains the operating status of storage resources

Resources for the object type pools:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/pools

GET

Synchronous

Obtains pool information

POST

Asynchronous

Creates a pool

/simple/v1/objects/pools/object-ID

GET

Synchronous

Obtains information about a specific pool

PATCH

Synchronous

Changes pool settings

DELETE

Asynchronous

Deletes a pool

/simple/v1/objects/pools/object-ID/actions/expand/invoke

POST

Asynchronous

Adds drives to a pool

Resources for the object type ports:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/ports

GET

Synchronous

Obtains port information

/simple/v1/objects/ports/object-ID

GET

Synchronous

Obtains information about a specific port

PATCH

Synchronous

Changes port settings

Resources for the object type quorum-disks:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/quorum-disks

GET

Synchronous

Obtains information about quorum disks

POST

Asynchronous

Registers information about a quorum disk

/simple/v1/objects/quorum-disks/object-ID

GET

Synchronous

Obtains information about a specific quorum disk

DELETE

Asynchronous

Deletes information about a quorum disk

Resources for the object type servers:

Note:

These resources can only be used if the servers that use a storage system are managed by Storage Advisor Embedded.

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/servers

GET

Synchronous

Obtains server information

POST

Asynchronous

Registers a server

/simple/v1/objects/servers/object-ID

GET

Synchronous

Obtains information about a specific server

PATCH

Asynchronous

Changes server settings

DELETE

Asynchronous

Deletes server information

/simple/v1/objects/servers/object-ID/actions/add-host-groups/invoke

POST

Asynchronous

Adds host groups (iSCSI target) to a server

/simple/v1/objects/servers/object-ID/actions/sync-host-group-names/invoke

POST

Asynchronous

Synchronizes the host group name (iSCSI target name) with the server nickname

/simple/v1/objects/servers/object-ID/hbas

GET

Synchronous

Obtains information about the WWN (iSCSI name) of the HBA for the specified server

POST

Asynchronous

Adds information about the WWN (iSCSI name) of the HBA for the specified server

/simple/v1/objects/servers/object-ID/hbas/object-ID

GET

Synchronous

Obtains information about the server specified by the server ID and the WWN (iSCSI name) of the HBA

DELETE

Asynchronous

Deletes information from the server specified by the server ID and the WWN (iSCSI name) of the HBA

/simple/v1/objects/servers/object-ID/paths

GET

Synchronous

Obtains server path information

POST

Asynchronous

Adds path information to a server

/simple/v1/objects/servers/object-ID/paths/object-ID

GET

Synchronous

Obtains path information for a specific server

DELETE

Asynchronous

Deletes path information from the server

/simple/v1/objects/servers/object-ID/target-iscsi-ports

GET

Synchronous

Obtains information about iSCSI targets

/simple/v1/objects/servers/object-ID/target-iscsi-ports/object-ID

GET

Synchronous

Obtains information about a specific iSCSI target

PATCH

Asynchronous

Changes the settings of an iSCSI target

Resources for the object type snapshot-groups:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/snapshot-groups

GET

Synchronous

Obtains snapshot group information

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

GET

Synchronous

Obtains information about a specific snapshot group

DELETE

Asynchronous

Deletes a snapshot group

Resources for the object type snapshots:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/snapshots

GET

Synchronous

Obtains snapshot information

POST

Asynchronous

Creates a snapshot

/simple/v1/objects/snapshots/object-ID

GET

Synchronous

Obtains information about a specific snapshot

DELETE

Asynchronous

Deletes a snapshot

/simple/v1/objects/snapshots/object-ID,object-ID/actions/map/invoke

POST

Asynchronous

Maps a snapshot

/simple/v1/objects/snapshots/object-ID,object-ID/actions/restore/invoke

POST

Asynchronous

Restores a snapshot

Resources for the object type storage:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/storage

GET

Synchronous

Obtains storage system information

Resources for the object type volumes:

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/volumes

GET

Synchronous

Obtains volume information

POST

Asynchronous

Creates a volume

/simple/v1/objects/volumes/object-ID

GET

Synchronous

Obtains information about a specific volume

PATCH

  • Synchronous
  • Asynchronous

Changes volume settings

DELETE

Asynchronous

Deletes a volume

/simple/v1/objects/volumes/object-ID/actions/expand/invoke

POST

Asynchronous

Expands the capacity of a volume

/simple/v1/objects/volumes/object-ID/qos-setting

GET

Synchronous

Obtains the QoS settings of a specific volume

PATCH

Asynchronous

Edits the QoS settings of a volume

Resources for the object type volume-server-connections:

Note:

These resources can only be used if the servers that use a storage system are managed by Storage Advisor Embedded.

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/v1/objects/volume-server-connections

GET

Synchronous

Obtains information about the connection between a volume and a server

POST

Asynchronous

Connects a volume and a server

/simple/v1/objects/volume-server-connections/object-ID

GET

Synchronous

Obtains information about the connection between a volume and a specific server

DELETE

Asynchronous

Disconnects a volume and a specific server

For the configuration domain:

The supported URL formats are as follows.

URL formats (excluding the base URL)

HTTP method

Processing method

Operations

/simple/configuration/gui-settings

GET

Synchronous

Obtains the settings information for server management.

PATCH

Asynchronous

Modifies the settings information for server management.

The REST API has the following two processing methods:

  • Synchronous processing

    The processing results are returned as the response.

  • Asynchronous processing

    The object information and the HTTP status code (202), indicating that the processing has been accepted, are returned as the response.

Note:

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