Virtual Storage Platform Block Storage REST API Reference

Version: A0-05-2x
Audience: anonymous
Part Number: MK-26VSP1B027-00

Overview of the REST API
System configuration of the REST API
Notes on managing VSP One B85, VSP One B20 series
Notes on managing VSP 5000 series storage systems
Requirements for SSL communications
SSL communication between the REST API clients and the REST API server
SSL communication between the REST API servers
Specifying the resource to be managed
Specifying an object ID
Supported HTTP methods
User authentication
Session management
Request headers
Response headers
HTTP status codes
Request and response formats
Query parameters
Data type
Output format
Data object
Error object
Action template object
Locking resources
Common operations in the REST API
Getting the version information
Getting a list of sessions
Getting information about a specific session
Generating sessions
Discarding sessions
Locking a resource group
Unlocking a resource group
User management and access control
Overview of user management and access control
Workflow for user management and access control
Input rules for user IDs and passwords
Getting a list of resource groups
Getting information about a specific resource group
Creating a resource group
Adding a resource to a resource group
Removing a resource from a resource group
Deleting a resource group
Getting a list of user groups
Getting information about a specific user group
Creating a user group
Changing the user group settings
Assigning resource groups to a user group
Releasing resource groups assigned to a user group
Deleting a user group
Getting a list of users
Getting information about a specific user
Creating a user account
Changing the password of the user
Adding users to user groups
Removing users from user groups
Deleting a user account
Simple API
Common operations in the REST API
commandStatus object
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
Parity group management
Getting parity group information
Getting information about a specific parity group
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 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
QoS management
Getting information about the QoS settings of a specific volume
Changing the QoS settings of a volume
Getting QoS group information
Getting information for a specific QoS group
Creating a QoS group
Changing QoS settings for a QoS group
Adding volumes to a QoS group
Deleting volumes from a QoS group
Deleting a QoS group
Getting performance information for a specific QoS group
Performing 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
Performing Universal Volume Manager operations
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
Configuring a global-active device environment
Workflow for configuring a global-active device environment
Getting information about quorum disks
Getting information about a specific quorum disk
Registering information about a quorum disk
Deleting information about a quorum disk
Detailed API
Performing job operations
Job object
Request object
Getting a list of job information
Getting job information
Performing operations to get information about an entire storage system
Getting a list of storage systems
Getting information about a specific storage system
Getting summary information about storage systems
Parity group management
Overview of a parity group
Getting information about parity groups
Getting information about a specific parity group
Getting a list of drive information
Getting information about a specific drive
Creating a parity group
Changing the drive settings
Changing the accelerated compression setting of a parity group
Formatting a parity group
Deleting a parity group
Volume allocation
Overview of volume allocation
Getting information about the capacity of a storage system
Getting information about the total efficiency of a storage system
Getting volume information
Getting information about a specific volume
Creating a volume
Formatting a volume
Expanding the capacity of a volume
Changing the volume settings
Changing the volume status
Shredding a volume
Reclaiming zero pages of a DP volume
Changing the MP blade assigned to a volume
Deleting a volume
Getting port information
Getting information about a specific port
Changing the port settings
Getting information about host groups or iSCSI targets
Getting information about a specific host group or iSCSI target
Getting a list of host modes and host mode options
Creating a host group or an iSCSI target
Changing the host group or iSCSI target settings
Deleting a host group or the iSCSI target
Getting WWN information
Getting information about a specific WWN
Registering a WWN for the host group
Setting the nickname for a WWN
Deleting the WWN from a host group
Getting iSCSI names
Getting information about a specific iSCSI name
Registering the iSCSI name for the iSCSI target
Setting the nickname for an iSCSI name
Deleting the iSCSI name from the iSCSI target
Getting information about CHAP users
Getting information about a specific CHAP user
Setting the CHAP user name for the iSCSI target
Setting a secret for the CHAP user
Deleting the CHAP user from the iSCSI target
Getting information about LU paths
Getting information about a specific LU path
Sending the ping command to a specified host
Setting the LU path
Setting the priority levels of ALUA paths
Deleting a LU path
Setting the command device
Getting a list of MP information
Releasing the host reservation status by specifying the LU path
Releasing the host reservation status by specifying a host group
Getting PAV LDEV information
Getting information about a specific PAV LDEV
Assigning the alias to the base device
Unassigning the alias from the base device
Changing the ESE setting of the volume
Volume Allocation (when an NVMe-oF connection is used)
Overview of volume allocation (NVMe-oF)
Getting NVM subsystem information
Getting information about a specific NVM subsystem
Creating an NVM subsystem
Changing the NVM subsystem settings
Deleting an NVM subsystem
Getting NVM subsystem port information
Getting information about a specific NVM subsystem port
Setting an NVM subsystem port for the NVM subsystem
Deleting an NVM subsystem port
Getting host NQN information
Getting information about a specific host NQN
Registering a host NQN in an NVM subsystem
Setting the nickname for a host NQN
Deleting the login information of the host NQN
Deleting a host NQN
Getting namespace information
Getting information about a specific namespace
Creating a namespace in an NVM subsystem
Setting the nickname for a namespace
Deleting a namespace
Getting host-namespace path information
Getting information about a host-namespace path
Setting a host-namespace path
Deleting a host-namespace path
Pool management
Overview of a pool
Getting pool information
Getting information about a specific pool
Creating a pool
Changing pool settings
Expanding a pool
Shrinking a pool
Stop Shrinking a Pool
Performing performance monitoring of a pool
Performing tier relocation
Restoring a pool
Initializing the capacity saving function for a pool
Deleting a pool
Optimizing I/O performance
Overview of optimizing I/O performance
Getting information about CLPRs
Getting information about a specific CLPR
Creating a CLPR
Changing the settings of a CLPR
Deleting a CLPR
Assigning LDEVs to a CLPR
Assigning parity groups to a CLPR
Getting information about external volume groups
Getting information about a specific external volume group
Assigning external volume groups to a CLPR
Changing the MP blade assigned to an external volume group
Configuring QoS settings for a volume
Getting performance information for a volume on which QoS has been set up
Managing QoS groups
Getting a list of Server Priority Manager information
Getting Server Priority Manager information by specifying a volume and the WWN or iSCSI name of an HBA
Setting Server Priority Manager information by specifying a volume and the WWN or iSCSI name of the HBA
Changing the Server Priority Manager information
Deleting Server Priority Manager information
Managing ShadowImage pairs
Overview of ShadowImage
Workflow for operating ShadowImage pairs
Pair status (ShadowImage)
Getting a list of copy groups
Getting information about a specific copy group
Getting a list of ShadowImage pairs
Getting information about a specific ShadowImage pair
Getting information about all of ShadowImage pairs
Creating a ShadowImage pair
Splitting ShadowImage pairs in units of copy groups
Splitting a ShadowImage pair
Resynchronizing ShadowImage pairs in units of copy groups
Resynchronizing a ShadowImage pair
Restoring ShadowImage pairs in units of copy groups
Restoring a ShadowImage pair
Deleting a copy group
Deleting a ShadowImage pair
Managing Thin Image pairs
Overview of Thin Image
Workflow for operating Thin Image pairs
Pair status (Thin Image)
Getting information about Thin Image pairs in units of snapshot groups
Getting information about Thin Image pairs in a specified snapshot group
Getting information about Thin Image pairs
Getting information about a specific Thin Image pair
Getting information about all of Thin Image pairs
Getting a list of volumes that have the vClone Parent attribute
Getting information about volumes that have the vClone attribute
Creating a Thin Image pair
Storing snapshot data in units of snapshot groups
Storing snapshot data
Resynchronizing Thin Image pair in units of snapshot groups and deleting snapshot data
Resynchronizing a Thin Image pair and deleting snapshot data
Restoring snapshot data in units of snapshot groups
Restoring snapshot data
Assigning a secondary volume to snapshot data
Unassigning the secondary volume for snapshot data
Setting the retention period for obtained snapshot data in units of snapshot groups
Setting the retention period for obtained snapshot data
Deleting Thin Image pairs in units of snapshot groups
Deleting a Thin Image pair
Deleting Thin Image pairs by snapshot tree
Deleting garbage data of all Thin Image pairs in a snapshot tree
Cloning pairs in a specified snapshot group
Cloning a Thin Image pair
Performing virtual clone operations in units of snapshot groups
Performing virtual clone operations
Configuring a remote copy environment
Workflow for configuring a remote copy environment
Registering and deleting information about remote storage systems
Overview of registering and deleting information about remote storage systems
Getting a list of remote storage systems
Getting information about a specific remote storage system
Registering information about remote storage systems
Deleting information about remote storage systems
Setting remote connections
Overview of the remote connection settings
Getting a list of remote connections
Getting information about a specific remote connection
Creating a remote connection
Changing the remote connection settings
Adding remote paths to a remote connection
Deleting a remote path from a remote connection
Deleting a remote connection
Getting information about iSCSI ports
Getting information about a specific iSCSI port
Registering an iSCSI port
Removing the registration of an iSCSI port
Getting information about the remote replica options
Changing the remote replica options settings
Setting journals
Getting journal information
Getting information about a specific journal
Creating a journal
The mirror journal status
Changing journal settings
Adding a journal volume
Deleting a journal volume from a journal
Changing the MP blade assigned to a journal
Deleting a journal
Setting quorum
Getting information about quorum disks
Getting information about a specific quorum disk
Registering information about a quorum disk
Deleting information about a quorum disk
Managing TrueCopy pairs or Universal Replicator pairs
Overview of TrueCopy and Universal Replicator
Workflow for operating TrueCopy pairs or Universal Replicator pairs
Flow of recovery operations to be performed when a failure occurs at the primary site of a Universal Replicator pair
Pair status (TrueCopy and Universal Replicator)
Getting a list of remote copy groups
Getting information about a specific remote copy group
Getting information about a specific remote copy pair
Getting TrueCopy or Universal Replicator pair information
Getting information about all of remote copy pairs
Creating a TrueCopy pair or Universal Replicator pair
Splitting TrueCopy pairs or Universal Replicator pairs in units of copy groups
Splitting a TrueCopy pair or Universal Replicator pair
Resynchronizing TrueCopy pairs or Universal Replicator pairs in units of copy groups
Resynchronizing a TrueCopy pair or Universal Replicator pair
Deleting TrueCopy pairs or Universal Replicator pairs in units of copy groups
Deleting a TrueCopy pair or Universal Replicator pair
Enabling volumes at the secondary site to take over work in units of copy groups
Enabling volumes at the secondary site to take over work in units of copy pairs
Managing global-active device pairs
Overview of global-active device
Workflow for operating global-active device pairs
Pair status (global-active device)
Getting a list of remote copy groups
Getting information about a specific remote copy group
Getting information about global-active device pairs
Getting information about a specific remote copy pair
Getting information about all of remote copy pairs
Creating a global-active device pair
Deleting global-active device pairs in units of copy groups
Deleting a global-active device pair
Suspending global-active device pairs in units of copy groups
Suspending a global-active device pair
Resynchronizing global-active device pairs in units of copy groups
Resynchronizing a global-active device pair
Performing Volume Migration operations
Overview of Volume Migration
Workflow for performing Volume Migration
Pair status transitions (Volume Migration)
Creating a pair to be used for Volume Migration
Performing migration for an entire copy group
Performing migration
Getting a list of copy groups (Volume Migration)
Getting information about a specific copy group (Volume Migration)
Getting a list of pairs (Volume Migration)
Getting information about a specific pair (Volume Migration)
Deleting a pair (Volume Migration)
Deleting a copy group (Volume Migration)
Canceling migration for an entire copy group
Canceling migration
Performing Universal Volume Manager operations
Overview of Universal Volume Manager
Workflow for Universal Volume Manager
Getting information about an iSCSI target of a port on an external storage system
Registering an iSCSI name of an external storage system to a port on the local storage system
Getting the iSCSI name of an external storage system that is registered to a port on the local storage system
Performing a login test on an iSCSI target of an external storage system that is registered to a port on the local storage system
Getting a list of ports on an external storage system
Getting a list of LUs defined for a port on an external storage system
Mapping a volume on the external storage system
Getting a list of external path groups
Getting information about a specific external path group
Adding an external path to an external path group
Removing an external path from an external path group
Setting the blocked path monitoring time for external paths
Unmapping a volume on the external storage system
Disconnecting from a volume on the external storage system
Deleting an iSCSI name of an external storage system that is registered to a port on the local storage system
Initial settings for a storage system
Overview of the initial settings of a storage system
Getting the system date and time of a storage system
Getting a list of time zones that can be used in a storage system
Setting the system date and time of a storage system
Uploading the files required to set the transfer destination of audit log files or alert notifications
Getting information about the transfer destinations of audit log files
Specifying the transfer destinations of audit log files
Sending test messages to the transfer destinations of audit log files
Getting information about the transfer destinations of alert notifications
Specifying the transfer destinations of alert notifications
Sending test messages to the transfer destinations of alert notifications
Getting SNMP settings
Specifying the SNMP alert notification destinations
Sending a test SNMP trap
Getting information about the alert notification email settings
Specifying settings for alert notification emails
Adding a destination address for alert notification emails
Deleting a destination address for alert notification emails
Sending a test alert notification email
Getting a list of license information
Getting information about a specific license
Installing software
Enabling or disabling a license
Removing software
Changing the user information used in searches of the external authentication server set for a storage system
Getting information about certificate files (for external server verification)
Getting information about a specific certificate file (for external server verification)
Uploading the certificate files (for external server verification)
Deleting a certificate file (for external server verification)
Encrypting data
Overview of data encryption
Workflow for operations related to data encryption
Getting information about the encryption environment settings
Changing the encryption environment settings
Getting information about the module used for encryption
Getting the number of encryption keys
Getting information about a list of encryption keys
Getting a specific encryption key
Creating encryption keys
Deleting one or more encryption keys at one time
Deleting an encryption key
Backing up encryption keys on the REST API client
Restoring encryption keys on the REST API client
Getting information about certificate files
Getting information about a specific certificate file
Uploading the certificate files
Deleting a certificate file
Getting key management server information
Getting information about a specific key management server
Registering information about a key management server
Testing communications with the key management server
Changing the key management server settings
Changing the priority of key management servers within a cluster
Deleting information about a key management server
Backing up encryption keys to the key management server
Restoring encryption keys backed up to a key management server
Rekeying the encryption key
Monitoring storage systems
Getting a list of alert information
Getting information about the hardware installed in a storage system
Getting information about channel boards
Managing resources by using virtual storage machines
Overview of managing resources by using virtual storage machines
Workflow for managing resources by using virtual storage machines
Getting a list of virtual storage machines
Getting information about a specific virtual storage machine
Creating a virtual storage machine
Deleting a virtual storage machine
Getting information about virtual LDEVs
Setting a virtual LDEV number
Deleting a virtual LDEV number
Sample coding
Overview of sample coding
Sample coding for volume allocation
Sample coding for ShadowImage pair operations
Sample coding for registering remote storage system information
Sample coding for TrueCopy pair operations
Sample coding for uploading files (specifying the transfer destinations of audit log files)
Sample coding for downloading a file (backing up encryption keys)
Sample coding for re-creating a parity group (data encryption)
Functions used in the sample coding
Simple API and Detailed API
About Simple API and Detailed API
Management models for pool creation (drives, parity groups, pool volumes, and pools)
Volume allocation (server management and host group management)
Switching to server management from host group management
Requirements for managing host groups (or iSCSI targets) from a server
Using a server to manage host groups (or iSCSI targets)
Switching to host group management from server management
Snapshot (Thin Image Advanced)
Universal Volume Manager
Getting configuration information (including additional information) from the SVP
About getting additional information from the SVP
API requests for getting information from the SVP
Updating the cache of storage system configuration information
Implementing retry processing
Implementing retry processing
Operations performed on QoS groups by using REST API requests that include simple in the request line
Operations on QoS groups
Getting a list of QoS groups
Getting information for a specific QoS group
Getting performance information for a specific QoS group
Checking the physical configuration and setting information of the storage system
About checking the physical configuration and setting information of the storage system
Creating a configuration report
Getting the status of configuration report creation
Downloading a configuration report
DKC power control
DKC power control
Getting the status of the DKC power
Changing the status of the DKC power
About the Data in Place upgrade of VSP 5000 series storage systems
Notes on performing a Data in Place upgrade
Re-registering a storage system after a Data in Place upgrade
Notes and restrictions
Notes and restrictions (Simple API)
Notes and restrictions (Detailed API)

Back to home page