REST API Reference Guide
The Configuration Manager REST API
provides the Web API, which follows the principles of Representational State Transfer (REST),
for getting information about storage systems or changing the configuration of storage
systems.
- Common specifications of the REST API
- 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
- Job object
- Error object
- Request object
- Action template object
- Locking resources
- Common operations in the REST API
- Getting the version information
- Getting a list of storage systems
- Getting information about a specific storage system
- Registering a storage system
- Changing information about a storage system
- Deleting information about a storage system
- Getting summary information about storage systems
- Getting a list of sessions
- Getting information about a specific session
- Generating sessions
- Discarding sessions
- Getting a list of job information
- Getting job information
- Locking a resource group
- Unlocking a resource group
- User management and access control
- Overview of user management and access control
- User management and access control operations
- 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
- Search function for storage systems
- Overview of the search function for storage systems
- Methods for updating the REST API server database to its latest state
- Refreshing the storage system configuration information
- Query parameters to be used for the search function
- Searching for storage system information
- Storage system resources obtained by the search function
- Enabling or disenabling the search function
- 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 attribute
- 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
- 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
- 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 parity groups
- Getting information about a specific external parity group
- Assigning external parity groups to a CLPR
- Changing the MP blade assigned to an external parity group
- Configuring QoS settings for a volume
- Getting performance information for a volume on which QoS has been set up
- 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
- 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
- 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
- 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 an external volume
- 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
- Unmapping an external volume
- Disconnecting from an external volume
- 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 for initial configuration
- 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 SNMP settings
- Specifying the SNMP error notification destinations
- Sending a test SNMP trap
- Getting information about the error notification email settings
- Specifying settings for error notification emails
- Adding a destination address for error notification emails
- Deleting a destination address for error notification emails
- Sending a test error 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
- 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 the number of encryption keys
- Getting information about a list of encryption keys
- Getting a specific encryption key
- Creating encryption keys
- Deleting an encryption key
- Backing up encryption keys
- Restoring encryption keys
- 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 registering storage system information
- 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
- Sending notifications about changes to storage system configurations
- Notifications of changes to storage system configurations
- Getting a list of destinations for sending notifications about changes to storage system configurations
- Getting specific destinations for sending notifications about changes to storage system configurations
- Registering destinations for sending notifications about changes to storage system configurations
- Deleting destinations for sending notifications about changes to storage system configurations
- Configuration Manager version
- The following describes points to note when a storage system's microcode version is downgraded, as well as methods for handling related issues.