Virtual Storage Platform One SDS Block and SDS Cloud REST API Reference

Version: 1.19.x
Audience: anonymous
Part Number: MK-24VSP1SDS004-08

Overview
System configuration
Basic system configuration
Supported HTTP method
Roles
Security
How to execute API requests
HTTP status codes
Query parameters
REST API input and output format
Request header
Response header
Object
Uploading and downloading files
Audit log management
GET /v1/objects/audit-log-setting
PATCH /v1/objects/audit-log-setting
POST /v1/objects/audit-logs/actions/create-file/invoke
GET /v1/objects/audit-logs/download
Common information management
GET /configuration/version
GET /v1/objects/jobs
GET /v1/objects/jobs/< jobId >
Compute node connection management
GET /v1/objects/chap-users
POST /v1/objects/chap-users
DELETE /v1/objects/chap-users/< chapUserId >
GET /v1/objects/chap-users/< chapUserId >
PATCH /v1/objects/chap-users/< chapUserId >
GET /v1/objects/port-auth-settings/< id >
PATCH /v1/objects/port-auth-settings/< id >
GET /v1/objects/port-auth-settings/< id >/chap-users
POST /v1/objects/port-auth-settings/< id >/chap-users
DELETE /v1/objects/port-auth-settings/< id >/chap-users/< chapUserId >
GET /v1/objects/port-auth-settings/< id >/chap-users/< chapUserId >
GET /v1/objects/ports
GET /v1/objects/ports/< id >
PATCH /v1/objects/ports/< id >
POST /v1/objects/ports/actions/switch-protocol/invoke
Compute node management
GET /v1/objects/servers
POST /v1/objects/servers
DELETE /v1/objects/servers/< id >
GET /v1/objects/servers/< id >
PATCH /v1/objects/servers/< id >
GET /v1/objects/servers/< id >/hbas
POST /v1/objects/servers/< id >/hbas
DELETE /v1/objects/servers/< id >/hbas/< hbaId >
GET /v1/objects/servers/< id >/hbas/< hbaId >
GET /v1/objects/servers/< id >/paths
POST /v1/objects/servers/< id >/paths
DELETE /v1/objects/servers/< id >/paths/< hbaId >,< portId >
GET /v1/objects/servers/< id >/paths/< hbaId >,< portId >
GET /v1/objects/volume-server-connections
POST /v1/objects/volume-server-connections
DELETE /v1/objects/volume-server-connections/< volumeId >,< serverId >
GET /v1/objects/volume-server-connections/< volumeId >,< serverId >
POST /v1/objects/volume-server-connections/actions/release/invoke
Drive management
GET /v1/objects/drives
GET /v1/objects/drives/< id >
POST /v1/objects/drives/< id >/actions/control-locator-led/invoke
POST /v1/objects/drives/< id >/actions/remove/invoke
Event log management
GET /v1/objects/event-log-setting
PATCH /v1/objects/event-log-setting
GET /v1/objects/event-logs
GET /v1/objects/event-logs/< id >
POST /v1/objects/smtp-server-root-certificates/< targetServer >/actions/import/invoke
GET /v1/objects/smtp-server-root-certificates/< targetServer >/download
Failure analysis
POST /v1/objects/dump-file/actions/create-file/invoke
GET /v1/objects/dump-file/download
GET /v1/objects/dump-files/< fileName >/download
DELETE /v1/objects/dump-files/< fileName >
GET /v1/objects/dump-statuses
GET /v1/objects/dump-status
POST /v1/objects/tickets
POST /v1/objects/tickets/actions/revoke-all/invoke
Login message management
GET /configuration/login-message
PATCH /configuration/login-message
High resolution monitor
GET /v1/objects/detail-performances/control-ports
GET /v1/objects/detail-performances/control-ports/< id >
GET /v1/objects/detail-performances/drives
GET /v1/objects/detail-performances/drives/< id >
GET /v1/objects/detail-performances/internode-ports
GET /v1/objects/detail-performances/internode-ports/< id >
GET /v1/objects/detail-performances/journals
GET /v1/objects/detail-performances/journals/< id >
GET /v1/objects/detail-performances/ports
GET /v1/objects/detail-performances/ports/< id >
GET /v1/objects/detail-performances/storage-nodes
GET /v1/objects/detail-performances/storage-nodes/< id >
GET /v1/objects/detail-performances/volumes
GET /v1/objects/detail-performances/volumes/< id >
License management
GET /v1/objects/license-setting
PATCH /v1/objects/license-setting
GET /v1/objects/licenses
POST /v1/objects/licenses
DELETE /v1/objects/licenses/< id >
GET /v1/objects/licenses/< id >
Low resolution monitor
GET /v1/objects/performances/control-ports
GET /v1/objects/performances/control-ports/< id >
GET /v1/objects/performances/drives
GET /v1/objects/performances/drives/< id >
GET /v1/objects/performances/internode-ports
GET /v1/objects/performances/internode-ports/< id >
GET /v1/objects/performances/journals
GET /v1/objects/performances/journals/< id >
GET /v1/objects/performances/pool-capacities
GET /v1/objects/performances/pool-capacities/< id >
GET /v1/objects/performances/pools
GET /v1/objects/performances/pools/< id >
GET /v1/objects/performances/ports
GET /v1/objects/performances/ports/< id >
GET /v1/objects/performances/storage
GET /v1/objects/performances/storage-nodes
GET /v1/objects/performances/storage-nodes/< id >
GET /v1/objects/performances/volume-capacities
GET /v1/objects/performances/volume-capacities/< id >
GET /v1/objects/performances/volumes
GET /v1/objects/performances/volumes/< id >
Power management
POST /v1/objects/storage/actions/shutdown/invoke
Secure communication management
POST /v1/objects/server-certificate/actions/import/invoke
GET /v1/objects/web-server-access-setting
PATCH /v1/objects/web-server-access-setting
Session management
GET /v1/objects/sessions
POST /v1/objects/sessions
DELETE /v1/objects/sessions/< sessionId >
GET /v1/objects/sessions/< sessionId >
Snapshot management
GET /v1/objects/volumes/< id >/master-volume
GET /v1/objects/volumes/< id >/snapshot-volumes
POST /v1/objects/volumes/actions/create-snapshot/invoke
POST /v1/objects/volumes/actions/delete-snapshot/invoke
POST /v1/objects/volumes/actions/restore-snapshot/invoke
Software update
POST /v1/objects/storage/actions/stop-software-update/invoke
POST /v1/objects/storage/actions/update-software/invoke
POST /v1/objects/storage/actions/upload-software-update-file/invoke
GET /v1/objects/storage/software-update-file
Storage cluster management
GET /v1/objects/fault-domains
GET /v1/objects/fault-domains/<id>
GET /v1/objects/health-status
PATCH /v1/objects/snmp-setting
GET /v1/objects/protection-domains
GET /v1/objects/protection-domains/< id >
PATCH /v1/objects/protection-domains/< id >
POST /v1/objects/protection-domains/< id >/actions/resume-drive-data-relocation/invoke
POST /v1/objects/protection-domains/< id >/actions/suspend-drive-data-relocation/invoke
GET /v1/objects/snmp-setting
GET /v1/objects/storage
POST /v1/objects/bmc-root-certificate/actions/delete/invoke
POST /v1/objects/bmc-root-certificate/actions/import/invoke
GET /v1/objects/bmc-root-certificate/download
GET /v1/objects/spare-nodes
POST /v1/objects/spare-nodes
DELETE /v1/objects/spare-nodes/<id>
GET /v1/objects/spare-nodes/<id>
PATCH /v1/objects/spare-nodes/<id>
POST /v1/objects/storage/actions/set-write-back-mode-with-cache-protection/invoke
POST /v1/objects/storage/actions/set-metadata-drive-write-reduction-mode/invoke
Storage controller management
GET /v1/objects/storage-controllers
GET /v1/objects/storage-controllers/< id >
POST /v1/objects/storage-controllers/actions/configure/invoke
Storage node management
POST /v1/objects/storage/actions/stop-removing-storage-nodes/invoke
GET /v1/objects/storage-nodes
DELETE /v1/objects/storage-nodes/< id >
GET /v1/objects/storage-nodes/< id >
POST /v1/objects/storage-nodes/< id >/actions/block-for-maintenance/invoke
POST /v1/objects/storage-nodes/< id >/actions/recover/invoke
POST /v1/objects/storage-nodes/< id >/actions/replace/invoke
POST /v1/objects/storage-nodes/<id>/actions/replace-with-configuration-file/invoke
POST /v1/objects/storage/actions/adding-storage-nodes/invoke
GET /v1/objects/storage-node-bmc-access-settings
GET /v1/objects/storage-node-bmc-access-settings/<id>
PATCH /v1/objects/storage-node-bmc-access-settings/<id>
Storage pool management
GET /v1/objects/pools
GET /v1/objects/pools/< id >
PATCH /v1/objects/pools/< id >
POST /v1/objects/pools/< id >/actions/expand/invoke
GET /v1/objects/pools/< id >/estimated-capacity-for-specified-configuration (Cloud for AWS)
GET /v1/objects/pools/< id >/estimated-capacity-for-updated-configuration (Cloud for AWS)
GET /v1/objects/storage-node-capacity-settings
GET /v1/objects/storage-node-capacity-settings/< id >
PATCH /v1/objects/storage-node-capacity-settings/< id >
GET /v1/objects/capacity-settings
PATCH /v1/objects/capacity-settings
GET /v1/objects/single-volume-overprovisioning-settings
PATCH /v1/objects/single-volume-overprovisioning-settings
GET /v1/objects/single-volume-overprovisioning-settings/< id >
PATCH /v1/objects/single-volume-overprovisioning-settings/< id >
System management
GET /configuration/storage-master-node-primary-flag
GET /v1/objects/control-ports
GET /v1/objects/control-ports/< id >
GET /v1/objects/internode-ports
GET /v1/objects/internode-ports/< id >
POST /v1/objects/storage/actions/resume-suppressed-start-processing/invoke
GET /v1/objects/storage-auto-recovery-setting
PATCH /v1/objects/storage-auto-recovery-setting
GET /v1/objects/storage-network-setting
GET /v1/objects/storage-node-network-settings
GET /v1/objects/storage-node-network-settings/< id >
GET /v1/objects/storage-time-setting
POST /v1/objects/system-requirements-file/actions/import/invoke
POST /v1/objects/configuration-file/actions/create/invoke
GET /v1/objects/configuration-file/download
GET /v1/objects/storage-configuration-summary
User role management
POST /v1/objects/external-auth-server-root-certificates/< targetServer >/actions/import/invoke
GET /v1/objects/external-auth-server-root-certificates/< targetServer >/download
GET /v1/objects/external-auth-server-setting
PATCH /v1/objects/external-auth-server-setting
POST /v1/objects/external-auth-server-setting/actions/verify-connectivity/invoke
GET /v1/objects/user-auth-setting
PATCH /v1/objects/user-auth-setting
GET /v1/objects/user-groups
POST /v1/objects/user-groups
DELETE /v1/objects/user-groups/< userGroupId >
GET /v1/objects/user-groups/< userGroupId >
PATCH /v1/objects/user-groups/< userGroupId >
GET /v1/objects/users
POST /v1/objects/users
DELETE /v1/objects/users/< userId >
GET /v1/objects/users/< userId >
PATCH /v1/objects/users/< userId >
POST /v1/objects/users/< userId >/actions/add-user-group/invoke
POST /v1/objects/users/< userId >/actions/delete-user-group/invoke
PATCH /v1/objects/users/< userId >/password
Virtual Private Storage (VPS) management
GET /v1/objects/virtual-private-storages
POST /v1/objects/virtual-private-storages
DELETE /v1/objects/virtual-private-storages/<id>
GET /v1/objects/virtual-private-storages/<id>
PATCH /v1/objects/virtual-private-storages/<id>
Volume management
GET /v1/objects/volumes
POST /v1/objects/volumes
DELETE /v1/objects/volumes/< id >
GET /v1/objects/volumes/< id >
PATCH /v1/objects/volumes/< id >
POST /v1/objects/volumes/< id >/actions/expand/invoke
POST /v1/objects/volumes/< id >/actions/discard-zero-page/invoke
POST /v1/objects/volumes/< id >/actions/stop-discard-zero-page/invoke
Encryption management
GET /v1/objects/encryption-keys
POST /v1/objects/encryption-keys
DELETE /v1/objects/encryption-keys/< id >
GET /v1/objects/encryption-keys/< id >
GET /v1/objects/encryption-key-counts
GET /v1/objects/encryption-settings
PATCH /v1/objects/encryption-settings
PATCH /v1/objects/encryption-units/pools/<id>
Remote iSCSI port management
GET /v1/objects/remote-iscsi-ports
POST /v1/objects/remote-iscsi-ports
DELETE /v1/objects/remote-iscsi-ports/< id >
GET /v1/objects/remote-iscsi-ports/< id >
Remote path group management
GET /v1/objects/remotepath-groups
POST /v1/objects/remotepath-groups
DELETE /v1/objects/remotepath-groups/< id >
GET /v1/objects/remotepath-groups/< id >
PATCH /v1/objects/remotepath-groups/< id >
POST /v1/objects/remotepath-groups/< id >/actions/add-remotepath/invoke
POST /v1/objects/remotepath-groups/< id >/actions/remove-remotepath/invoke
Journal management
GET /v1/objects/journals
POST /v1/objects/journals
DELETE /v1/objects/journals/< id >
GET /v1/objects/journals/< id >
PATCH /v1/objects/journals/< id >
POST /v1/objects/journals/< id >/actions/expand/invoke
POST /v1/objects/journals/< id >/actions/shrink/invoke
Response definitions
HTTP status code 200
HTTP status code 202
HTTP status code 204
HTTP status code 400
HTTP status code 401
HTTP status code 403
HTTP status code 404
HTTP status code 405
HTTP status code 406
HTTP status code 409
HTTP status code 411
HTTP status code 412
HTTP status code 413
HTTP status code 415
HTTP status code 417
HTTP status code 431
HTTP status code 500
HTTP status code 502
HTTP status code 503
HTTP status code 504
Schema definitions
addHbasServerParam: object
addPathServerParam: object
addRemotePathParam: object
addUserToUserGroupParam: object
allowlistSettingOfEditWebServerAccessSetting: object
allowlistSettingOfWebServerAccessSetting: object
approveChapUserParam: object
approvedChapUser: object
assignToServerVolumeParam: object
auditLogSetting: object
blockStorageNodeForMaintenance: object
capacitiesExcludingSystemDataOfStorageController: object
capacityBalancingSetting: object
capacityBalancingSettingParam: object
capacitySettings: object
changePasswordParam: object
chapUser: object
chapUserSummary: object
configurationFileAddressSetting: object
configureStorageControllerParam: object
controlPort: object
controlPortPerformance: object
controlPortPerformanceListResponse: object
controlPortPerformanceListResponseData: object
cpuPerformance: object
cpuSummaryPerformance: object
createChapUserParam: object
createConfigurationFileParam: object
createdSession: object
createDumpFileParam: object
createEncryptionKeyParam: object
createJournalParam: object
createRemoteIscsiPortParam: object
createRemotePathGroupParam: object
createServerParam: object
createSessionParam: object
createSnapshotParam: object
createSpareNodeParam: object
createTicketParam: object
createUserGroupParam: object
createUserParam: object
createVirtualPrivateStorageParam: object
createVolumeParam: object
createVolumeQosParam: object
dataReductionEffectOfVolume: object
dataReductionEffectOfVolumeSummary: object
deleteHbasServerParam: object
deleteJournalParam: object
deletePathServerParam: object
deleteServerParam: object
deleteSnapshotParam: object
deleteUserFromUserGroupParam: object
deleteVolumeParam: object
discardZeroPageParam: object
drive: object
driveLocatorLedParam: object
drivePerformance: object
drivePerformanceListResponse: object
drivePerformanceListResponseData: object
dumpStatus: object
dumpStatusList: object
emailReportSettingOfEditEventLogSetting: object
emailReportSettingOfEventLogSetting: object
encryptionKey: object
encryptionKeyCounts: object
encryptionSettings: object
errorInformationOfLdapServerConnectionVerification: object
errorResponse: object
estimatedCapacityForSpecifiedConfiguration: object
estimatedCapacityForUpdatedConfiguration: object
eventLog: object
eventLogSetting: object
expandJournalParam: object
expandPoolParam: object
expandVolumeParam: object
externalAuthServerConnectionVerification: object
externalAuthServerSetting: object
faultDomain: object
faultDomainSummary: object
fcInformationOfEditPort: object
fcPortPerformance: object
fcTarget: object
fcTargetPortPerformance: object
hba: object
healthStatus: object
installLicenseParam: object
internodePort: object
internodePortPerformance: object
internodePortPerformanceListResponse: object
internodePortPerformanceListResponseData: object
ipv4InformationOfControlPort: object
ipv4InformationOfInternodePort: object
ipv4InformationOfNvmeTcpTarget: object
ipv4InformationOfUniversal: object
ipv4RouteOfStorageNodeNetworkSetting: object
ipv6InformationOfNvmeTcpTarget: object
ipv6InformationOfUniversal: object
iscsiInformationOfEditPort: object
iscsiInitiatorPortPerformance: object
iscsiPortPerformance: object
iscsiTargetPortPerformance: object
iscsiUniversal: object
isnsServerOfEditIscsiInformation: object
isnsServerOfIscsiUniversal: object
job: object
journal: object
journalPerformance: object
journalPerformanceListResponse: object
journalPerformanceListResponseData: object
ldapServerConnectionVerification: object
ldapSettingOfEditExternalAuthServerSetting: object
ldapSettingOfExternalAuthServerSetting: object
license: object
licenseSetting: object
lockoutSettingOfEditUserAuthSetting: object
lockoutSettingOfUserAuthSetting: object
loginMessage: object
masterVolume: object
memoryPerformance: object
mirrorUnit: object
mirrorUnitSetting: object
nvmeTcpPortPerformance: object
nvmeTcpTarget: object
nvmeTcpTargetPortPerformance: object
passwordAgeSettingOfEditUserAuthSetting: object
passwordAgeSettingOfUserAuthSetting: object
passwordComplexitySettingOfEditUserAuthSetting: object
passwordComplexitySettingOfUserAuthSetting: object
patchAuditLogSettingParam: object
patchCapacitySettingParam: object
patchChapUserParam: object
patchEncryptionSettingsParam: object
patchEncryptionUnitsPoolParam: object
patchEventLogSettingParam: object
patchExternalAuthServerSettingParam: object
patchJournalParam: object
patchLicenseSettingParam: object
patchLoginMessageParam: object
patchPoolSettingParam: object
patchPortAuthSettingParam: object
patchPortParam: object
patchProtectionDomainParam: object
patchRemotePathGroupParam: object
patchServerParam: object
patchSingleVolumeOverprovisioningSettingAllParam: object
patchSingleVolumeOverprovisioningSettingParam: object
patchSnmpSettingParam: object
patchSpareNodeParam: object
patchStorageAutoRecoverySettingParam: object
patchStorageNodeBmcAccessSettingParam: object
patchStorageNodeCapacitySettingParam: object
patchUserAuthSettingParam: object
patchUserGroupParam: object
patchUserParam: object
patchVirtualPrivateStorageParam: object
patchVolumeParam: object
patchVolumeQosParam: object
patchWebServerAccessSettingParam: object
path: object
pathOfServer: object
pinInformationOfStorageController: object
pool: object
poolCapacity: object
poolCapacityListResponseData: object
poolPerformance: object
poolPerformanceListResponseData: object
port: object
portAuthSetting: object
portPerformance: object
portPerformanceListResponse: object
portPerformanceListResponseData: object
portSummary: object
portSwitchProtocolParam: object
primaryServerOfLdapServerConnectionVerificationError: object
primaryServerOfLdapServerConnectionVerificationResult: object
protectionDomain: object
protectionDomainSummary: object
rebuildableResourcesOfPool: object
rebuildableResourcesOfStorageNode: object
rebuildCapacityResourceSettingParam: object
releaseFromServerVolumeParam: object
releaseFromSingleServerSingleVolumeParam: object
remoteIscsiPort: object
remotePathGroup: object
remotePathGroupSummary: object
removeRemotePathParam: object
replaceStorageNodeParam: object
request: object
requestAuthenticationSettingOfEditSnmpSetting: object
requestAuthenticationSettingOfSnmpSetting: object
resourceStatusOfHealthStatus: object
restoreSnapshotParam: object
resultOfLdapServerConnectionVerification: object
savingEffectOfPool: object
savingEffectOfStorage: object
secondaryServerOfLdapServerConnectionVerificationError: object
secondaryServerOfLdapServerConnectionVerificationResult: object
sendingTrapSettingOfEditSnmpSetting: object
sendingTrapSettingOfSnmpSetting: object
server: object
serverSummary: object
session: object
sessionSettingOfEditUserAuthSetting: object
sessionSettingOfUserAuthSetting: object
setMetadataDriveWriteReductionModeParam: object
setWriteBackModeWithCacheProtectionParam: object
shrinkJournalParam: object
shutdownStorageParam: object
singleVolumeOverprovisioningSetting: object
smtpSettingOfEditEventLogSetting: object
smtpSettingOfEventLogSetting: object
snapshotVolume: object
snmpSetting: object
snmpv2cSettingOfEditRequestAuthenticationSetting: object
snmpv2cSettingOfEditSendingTrapSetting: object
snmpv2cSettingOfRequestAuthenticationSetting: object
snmpv2cSettingOfSendingTrapSetting: object
softwareUpdateFile: object
spareNode: object
spareNodeList: object
stopDiscardZeroPageParam: object
storage: object
storageAutoRecoverySetting: object
storageClusterCapacitySetting: object
storageConfigurationSummary: object
storageController: object
storageControllerCapacitySetting: object
storageMasterNodePrimaryFlag: object
storageNetworkSetting: object
storageNode: object
storageNodeBmcAccessSetting: object
storageNodeBmcAccessSettingList: object
storageNodeCapacitySetting: object
storageNodeNetworkSetting: object
storageNodePerformance: object
storageNodePerformanceListResponse: object
storageNodePerformanceListResponseData: object
storagePerformance: object
storagePerformanceListResponseData: object
storageTimeSetting: object
syslogForwardingSettingOfAuditLogSetting: object
syslogForwardingSettingOfEditAuditLogSetting: object
syslogForwardingSettingOfEditEventLogSetting: object
syslogForwardingSettingOfEventLogSetting: object
syslogServerSettingOfAuditLogSetting: object
syslogServerSettingOfEditAuditLogSetting: object
syslogServerSettingOfEditEventLogSetting: object
syslogServerSettingOfEventLogSetting: object
systemGroupInformationOfEditSnmpSetting: object
systemGroupInformationOfSnmpSetting: object
teamingOfControlPort: object
teamingOfInternodePort: object
ticket: object
updateSoftwareParam: object
user: object
userAuthSetting: object
userGroup: object
userGroupSummary: object
userPrivileges: object
version: object
virtualPrivateStorage: object
VirtualPrivateStorageDefaultVolumeSettings: object
virtualPrivateStorageList: object
virtualPrivateStorageSummaryInformation: object
volume: object
volumeCapacity: object
volumeCapacityListResponseData: object
volumeNameParam: object
volumeNicknameParam: object
volumePath: object
volumePerformance: object
volumePerformanceListResponse: object
volumePerformanceListResponseData: object
volumeQosParam: object
volumeSummary: object
warningThresholdSettingOfEditLicenseSetting: object
warningThresholdSettingOfLicenseSetting: object
webServerAccessSetting: object
whitelistSettingOfEditWebServerAccessSetting: object
whitelistSettingOfWebServerAccessSetting: object

Back to home page