REST API Reference Guide for Virtual Storage Platform One Block Administrator

Version: A3-03-0x
Audience: anonymous
Part Number: MK-23VSP1B002-01

Overview of the REST API
System configuration of REST API
Requirements for SSL communications
Roles and access permissions of users executing API requests
Specifying resources to manage (URL)
Specifying an object ID
Supported HTTP methods
User authentication
Request headers
Response headers
HTTP status codes
Request and response formats
Query parameters
Data type
Output format
Data object
commandStatus object
Error object
Common operations in the REST API
Getting status information about an API function that performs asynchronous processing
Deleting status information about an API function that performs asynchronous processing
Performing operations on an entire storage system
Getting setting information for server management
Changing setting information for server management
Getting information about a storage system
Getting the operating status of snapshots and pools
Preparing management resources and attaching volumes
Drive management
Getting drive information
Getting information about a specific drive
Pool management
Getting pool information
Getting information about a specific pool
Creating a pool
Changing pool settings
Deleting a pool
Expanding the capacity of a pool
Port management
Getting port information
Getting information about a specific port
Changing port settings
Server management
Getting server information
Getting information about a specific server
Registering a server
Changing server settings
Deleting a server
Adding host groups (iSCSI target) to a server
Synchronizing a host group name (iSCSI target name) with a server nickname
Getting information about the WWN of an HBA (iSCSI name)
Getting information about the WWN of an HBA (iSCSI name) of a specific server
Adding information about the WWN of an HBA (iSCSI name)
Deleting information about the WWN of an HBA (iSCSI name) from a server
Getting a list of server path information
Getting information about the paths between a server and a specific port
Adding path information to a server
Deleting path information from a server
Getting information about iSCSI targets
Getting information about a specific iSCSI target
Changing the settings of an iSCSI target
Volume management
Getting volume information
Getting information about a specific volume
Creating a volume
Changing the volume settings
Expanding the capacity of a volume
Deleting a volume
Getting information about the QoS settings of a specific volume
Changing the QoS settings of a volume
Getting information about the connections between volumes and servers
Getting information about the connection between a volume and a specific server
Attaching a volume to a server
Detaching a volume from a specific server
Snapshot operations
Workflow for snapshots
Getting a list of snapshot group names
Getting information about a specific snapshot group
Getting snapshot information
Getting information about a specific snapshot
Creating a snapshot
Mapping a snapshot
Restoring a snapshot
Deleting a snapshot group
Deleting a snapshot
Configuring a global-active device environment
Workflow for configuring a global-active device environment
Getting external volume information
Getting information about a specific external volume
Creating an external volume
Changing the nickname of an external volume
Getting information about external volume groups
Getting information about a specific external volume group
Getting information about external path groups
Getting information about a specific external path group
Getting information about quorum disks
Getting information about a specific quorum disk
Registering information about a quorum disk
Deleting information about a quorum disk
Switching to server management that uses Hitachi VSP One Block Administrator from another management tool
Settings for attaching storage system volumes to a server
Requirements for managing host groups (or iSCSI targets) from a server
Using a server to manage host groups (or iSCSI targets)
Notes and restrictions
Notes and restrictions

Back to home page