Virtual Storage Platform Block Storage REST API Reference

Version: A3-05-2x, A0-05-4x
File Size: 4495 KB
Audience: anonymous
Part Number: MK-26VSP1B027-02
Published: 2026-05-04

Introduction
For Simple API
For Detailed API
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 User Group Settings
Assigning Resource Groups to a User Group
Releasing Resource Groups from 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
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
Preface
Servers
Authentication methods
simple/gui-settings
Getting setting information for server management
Changing setting information for server management
simple/storage
Getting information about a storage system
simple/drives
Getting drive information
Getting information about a specific drive
simple/pools
Getting pool information
Creating a pool
Getting information about a specific pool
Deleting a pool
Changing pool settings
Expanding the capacity of a pool
simple/volumes
Getting volume information
Creating a volume
Clear virtual information of volumes
Getting information about a specific volume
Deleting a volume
Changing the volume settings
Expanding the capacity of a volume
Getting information about the QoS settings of a specific volume
Changing the QoS settings of a volume
simple/volume-server-connections
Getting information about the connections between volumes and servers
Attaching a volume to a server
Getting information about the connection between a volume and a specific server
Detaching a volume from a specific server
simple/snapshots
Getting snapshot information
Creating a snapshot
Getting information about a specific snapshot
Deleting a snapshot
Mapping a snapshot
Restoring a snapshot
simple/snapshot-groups
Getting a list of snapshot group names
Getting information about a specific snapshot group
Deleting a snapshot group
simple/servers
Getting server information
Registering a server
Getting information about a specific server
Deleting a server
Changing server settings
Getting information about the WWN of an HBA (iSCSI name)
Adding information about the WWN of an HBA (iSCSI name)
Getting information about the WWN of an HBA (iSCSI name) of a specific server
Deleting information about the WWN of an HBA (iSCSI name) from a server
Getting a list of server path information
Adding path information to a server
Getting information about the paths between a server and a specific port
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
Adding host groups (iSCSI target) to a server
Synchronizing a host group name (iSCSI target name) with a server nickname
simple/ports
Getting port information
Getting information about a specific port
Changing port settings
simple/qos-groups
Getting QoS group information
Creating a QoS group
Getting information for a specific QoS group
Changing QoS settings for a QoS group
Deleting a QoS group
Adding volumes to a QoS group
Deleting volumes from a QoS group
simple/parity-groups
Getting parity group information
Getting information about a specific parity groups
simple/external-volumes
Getting external volume information
Creating an external volume
Getting information about a specific external volume
Changing the nickname of an external volume
simple/external-path-groups
Getting information about external path groups
Getting information about a specific external path group
simple/external-parity-groups
Getting information about external volume groups
Getting information about a specific external volume group
simple/quorum-disks
Getting information about quorum disks
Registering information about a quorum disk
Getting information about a specific quorum disk
Deleting information about a quorum disk
simple/command-status
Getting status information about an API function that performs asynchronous processing
Deleting status information about an API function that performs asynchronous processing
simple/performances
Getting performance information for a specific QoS group
simple/health-status
Getting the operating status of snapshots and pools and GAD Pairs
simple/all-types-of-pools
Getting a list of pool information of all types
Getting information about pools of all types
simple/all-types-of-volume-ids
Getting a list of volume ID information
Getting information about volume ID.
simple/all-types-of-volumes
Getting a list of volume information of all types
Getting information about volumes of all types
detail/version
Getting the version information
detail/storages
Getting a list of storage systems
Getting information about a specific storage system
detail/actions
Uploading the files required to set the transfer destination of audit log files or alert notifications
detail/alert-email-settings
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
detail/alert-syslog-settings
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
detail/alerts
Getting a list of alert information
detail/auditlog-syslog-servers
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
detail/channel-boards
Getting information about channel boards
detail/chap-users
Getting information about CHAP users
Setting the CHAP user name for the iSCSI target
Deleting the CHAP user from the iSCSI target
Getting information about a specific CHAP user
Setting a secret for the CHAP user
detail/clprs
Getting information about CLPRs
Creating a CLPR
Deleting a CLPR
Getting information about a specific CLPR
Changing the settings of a CLPR
detail/components
Getting information about the hardware installed in a storage system
detail/date-times
Getting the system date and time of a storage system
Setting the system date and time of a storage system
detail/drives
Getting a list of drive information
Getting information about a specific drive
Changing the drive settings
detail/encryption-key-counts
Getting the number of encryption keys
detail/encryption-keys
Getting information about a list of encryption keys
Creating encryption keys
Backing up encryption keys on the REST API client
Restoring encryption keys on the REST API client
Deleting an encryption key
Getting a specific encryption key
Rekeying the encryption key
Backing up encryption keys to the key management server
Restoring encryption keys backed up to a key management server
detail/encryption-modules
Getting information about the module used for encryption
detail/encryption-settings
Getting information about the encryption environment settings
Changing the encryption environment settings
detail/external-authentication-server-settings
Changing the user information used in searches of the external authentication server set for a storage system
detail/external-parity-groups
Getting information about external volume groups
Mapping a volume on the external storage system
Unmapping a volume on the external storage system
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
Disconnecting from a volume on the external storage system
detail/external-path-groups
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
detail/external-path-settings
Setting the blocked path monitoring time for external paths
detail/external-storage-luns
Getting a list of LUs defined for a port on an external storage system
detail/external-storage-ports
Getting a list of ports on an external storage system
detail/host-groups
Getting information about host groups or iSCSI targets
Creating a host group or an iSCSI target
Deleting a host group or the iSCSI target
Getting information about a specific host group or iSCSI target
Changing the host group or iSCSI target settings
Releasing the host reservation status by specifying a host group
detail/host-iscsis
Getting iSCSI names
Registering the iSCSI name for the iSCSI target
Deleting the iSCSI name from the iSCSI target
Getting information about a specific iSCSI name
Setting the nickname for an iSCSI name
detail/host-nqns
Deleting a host NQN for the NVM subsystem
Getting host NQN information
Setting the nickname for a host NQN
Getting host NQN information
Registering a host NQN for the NVM subsystem
detail/host-wwns
Getting WWN information
Registering a WWN for the host group
Deleting the WWN from a host group
Getting information about a specific WWN
Setting the nickname for a WWN
detail/io-control-ldev-wwns-iscsis
Getting a list of Server Priority Manager information
Setting Server Priority Manager information by specifying a volume and the WWN or iSCSI name of the HBA
Deleting Server Priority Manager information
Getting Server Priority Manager information by specifying a volume and the WWN or iSCSI name of an HBA
Changing the Server Priority Manager information
detail/iscsi-ports
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 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
Deleting an iSCSI name of an external storage system that is registered to a port on the local storage system
detail/jobs
Getting a list of job information
Getting job information
detail/journals
Getting journal information
Creating a journal
Deleting a journal
Getting information about a specific journal
Changing journal settings
Changing the MP blade assigned to a journal
Adding a journal volume
Deleting a journal volume from a journal
detail/kms-certificates
Getting information about certificate files
Uploading the certificate files
Deleting a certificate file
Getting information about a specific certificate file
detail/kms-settings
Getting key management server information
Registering information about a key management server
Deleting information about a key management server
Getting information about a specific key management server
Changing the key management server settings
Testing communications with the key management server
detail/ldevs
Getting volume information
Creating a volume
Deleting a volume
Getting information about a specific volume
Changing the volume settings
Assigning LDEVs to a CLPR
Changing the MP blade assigned to a volume
Setting a virtual LDEV number
Changing the volume status
Reclaiming zero pages of a DP volume
Expanding the capacity of a volume
Formatting a volume
Setting the command device
Changing a QoS settings
Shredding a volume
Deleting a virtual LDEV number
Changing the ESE setting of the volume
detail/licenses
Getting a list of license information
Installing software
Removing software
Getting information about a specific license
Enabling or disabling a license
detail/local-clone-copygroups
Getting a list of copy groups
Deleting a copy group
Getting information about a specific copy group
Performing migration for an entire copy group
Restoring ShadowImage pairs in units of copy groups
Resynchronizing ShadowImage pairs in units of copy groups
Splitting ShadowImage pairs or cancelling migration in units of copy groups
detail/local-clone-copypairs
Getting a list of ShadowImage pairs or Volume Migration pairs
Creating a pair (ShadowImage or to be used for Volume Migration)
Deleting a ShadowImage pair or a Volume Migration pair
Getting information about a specific ShadowImage pair or Volume Migration pair
Performing migration
Restoring a ShadowImage pair
Resynchronizing a ShadowImage pair
Splitting a ShadowImage pair or canceling migration
detail/local-replications
Getting information about all of ShadowImage pairs
detail/luns
Getting information about LU paths
Setting the LU path
Deleting a LU path
Getting information about a specific LU path
Releasing the host reservation status by specifying the LU path
detail/mps
Getting a list of MP information
detail/nvm-subsystem-ports
Deleting an NVM subsystem port
Getting information about a specific NVM subsystem port
Getting NVM subsystem port information
Setting an NVM subsystem port for the NVM subsystem
detail/nvm-subsystems
Getting NVM subsystem information
Creating an NVM subsystem
Deleting an NVM subsystem
Getting information about a specific NVM subsystem
Changing the NVM subsystem settings
detail/parity-groups
Getting information about parity groups
Creating a parity group
Deleting a parity group
Getting information about a specific parity group
Changing the accelerated compression setting of a parity group
Assigning parity groups to a CLPR
Formatting a parity group
detail/pav-ldevs
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
detail/pools
Getting pool information
Creating a pool
Deleting a pool
Getting information about a specific pool
Changing pool settings
Initializing the capacity saving function for a pool
Expanding a pool
Performing performance monitoring of a pool
Restoring a pool
Performing tier relocation
Shrinking a pool
Stop shrinking a pool
detail/ports
Getting port information
Getting information about a specific port
Changing the port settings
Sending the ping command to a specified host
Deleting the login information of the host NQN
detail/qos-monitor-ldevs
Getting performance information for a volume on which QoS has been set up
detail/quorum-disks
Getting information about quorum disks
Registering information about a quorum disk
Deleting information about a quorum disk
Getting information about quorum disks
detail/remote-copypairs
Getting TrueCopy or Universal Replicator or global-active device pair information
detail/remote-iscsi-ports
Getting information about iSCSI ports
Registering an iSCSI port
Removing the registration of an iSCSI port
Getting information about a specific iSCSI port
detail/remote-mirror-copygroups
Getting a list of remote copy groups
Deleting pairs (TrueCopy, Universal Replicator, or global-active device) in units of copy groups
Getting information about a specific remote copy group
Resynchronizing pairs (TrueCopy, Universal Replicator, or global-active device) in units of copy groups
Splitting pairs (TrueCopy, Universal Replicator, or global-active device) in units of copy groups
Enabling volumes at the secondary site to take over work in units of copy groups
detail/remote-mirror-copypairs
Creating a pair (TrueCopy, Universal Replicator, or global-active device)
Deleting a pair (TrueCopy, Universal Replicator, or global-active device)
Getting information about a specific remote copy pair
Resynchronizing a pair (TrueCopy, Universal Replicator, or global-active device)
Splitting a pair (TrueCopy, Universal Replicator, or global-active device)
Enabling volumes at the secondary site to take over work in units of copy pairs
detail/remote-replications
Getting information about all of remote copy pairs
detail/server-verification-certificates
Getting information about certificate files (for external server verification)
Uploading the certificate files (for external server verification)
Deleting a certificate file (for external server verification)
Getting information about a specific certificate file (for external server verification)
detail/remote-storages
Getting a list of remote storage systems
Registering information about remote storage systems
Deleting information about remote storage systems
Getting information about a specific remote storage system
detail/remotepath-groups
Getting a list of remote connections
Creating a remote connection
Deleting a remote connection
Getting information about a specific remote connection
Changing the remote connection settings
Adding remote paths to a remote connection
Deleting a remote path from a remote connection
detail/remote-replica-options
Getting information about remote replica options settings
Changing the remote replica options settings
detail/resource-groups
Getting a list of resource groups
Creating a resource group
Deleting a resource group
Getting information about a specific resource group
Adding a resource to a resource group
Removing a resource from a resource group
detail/sessions
Getting a list of sessions
Generating sessions
Discarding sessions
Getting information about a specific session
detail/snapshot-groups
Getting information about Thin Image pairs in units of snapshot groups
Deleting Thin Image pairs in units of snapshot groups
Getting information about Thin Image pairs in a specified snapshot group
Cloning pairs in a specified snapshot group
Restoring snapshot data in units of snapshot groups
Resynchronizing Thin Image pair in units of snapshot groups and deleting snapshot data
Storing snapshot data in units of snapshot groups
Setting the retention period for obtained snapshot data in units of snapshot groups
Performing virtual clone operations in units of snapshot groups
detail/snapshot-replications
Getting information about all of Thin Image pairs
detail/snapshots
Getting information about Thin Image pairs
Creating a Thin Image pair
Deleting a Thin Image pair
Getting information about a specific Thin Image pair
Assigning a secondary volume to snapshot data
Cloning a Thin Image pair
Restoring snapshot data
Resynchronizing a Thin Image pair and deleting snapshot data
Storing snapshot data
Unassigning the secondary volume for snapshot data
Setting the retention period for obtained snapshot data
Performing virtual clone operations
detail/snmp-settings
Getting SNMP settings
Specifying the SNMP alert notification destinations
Sending a test SNMP trap
detail/storage-summaries
Getting summary information about storage systems
detail/supported-host-modes
Getting a list of host modes and host mode options
detail/time-zones
Getting a list of time zones that can be used in a storage system
detail/total-capacities
Getting information about the capacity of a storage system
detail/total-efficiencies
Getting information about the total efficiency of a storage system
detail/user-groups
Getting a list of user groups
Creating a user group
Deleting a user group
Getting information about a specific user group
Changing the user group settings
Assigning resource groups to a user group
Releasing resource groups assigned to a user group
detail/users
Getting a list of users
Creating a user account
Deleting a user account
Getting information about a specific user
Changing the password of the user
Adding users to user groups
Removing users from user groups
detail/virtual-clone-parent-volumes
Getting a list of volumes that have the vClone Parent attribute
detail/snapshot-family
Getting information about volumes that have the vClone attribute
detail/virtual-storages
Getting a list of virtual storage machines
Creating a virtual storage machine
Deleting a virtual storage machine
Getting information about a specific virtual storage machine
detail/encryption-key-service
Deleting multiple encryption keys
detail/kms-setting-service
Changing the priority of key management servers within a cluster
detail/lun-service
Setting the priority levels of ALUA paths
detail/resource-group-service
Locking a resource group
Unlocking a resource group
detail/snapshot-tree
Deleting garbage data of all Thin Image pairs in a snapshot tree
Deleting Thin Image pairs by snapshot tree
detail/storage-cache-service
Updating the cache of storage system configuration information
detail/configuration-reports
Create a configuration report
Get the status of configuration report creation
Download a configuration report
detail/dkc-power-states
Get the status of the DKC power
Change the status of the DKC power
detail/namespace-paths
Deleting a host-namespace path
Getting information about a host-namespace path
Getting host-namespace path information
Setting a host-namespace path
detail/namespaces
Getting namespace information
Creating a namespace in an NVM subsystem
Deleting a namespace
Getting information about a specific namespace
Setting the nickname for a namespace
detail/edif-kms-settings
Getting key management server information for EDiF
Registering information about a key management server for EDiF
Deleting information about a key management server for EDiF
Getting information about a specific key management server for EDiF
Changing the key management server settings for EDiF
Testing communications with the key management server for EDiF
detail/mainframe-system-functions
Getting information about Mainframe System Functions
Modify the settings for Mainframe System Functions
detail/edif-kms-setting-service
Changing the priority of key management servers for EDiF within a cluster
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
Request message
Object ID
Query parameters
Body
Response message
BOdy
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