IBM Hyper-Scale Manager Version 5.5.1 REST API Specifications IBM IBM Confidential SC27-6440-06 IBM Confidential Note Before using this information and the product it supports, read the information in “Notices” on page 73. Edition Notice Publication number: SC27-6440-06. This edition applies to IBM® Hyper-Scale Manager version 5.5.1 and to all subsequent releases and modifications, until otherwise indicated in a newer publication. © Copyright International Business Machines Corporation 2014, 2019. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM Confidential Contents List of Tables........................................................................................................vii About this guide................................................................................................... ix Who should use this guide.......................................................................................................................... ix Conventions used in this guide................................................................................................................... ix Related information and publications.........................................................................................................ix Getting information, help, and service.........................................................................................................x IBM Publications Center.............................................................................................................................. x Sending or posting your comments............................................................................................................. x Chapter 1. Introduction......................................................................................... 1 Protocol version........................................................................................................................................... 1 HTTP methods............................................................................................................................................. 1 URL scope specifiers and resource names..................................................................................................1 Chapter 2. General requests.................................................................................. 3 Chapter 3. Query requests..................................................................................... 5 Query paging support...................................................................................................................................5 Query response format................................................................................................................................ 6 System query requests................................................................................................................................ 7 System Fiber Channel (FC) port query requests....................................................................................8 System iSCSI port query requests......................................................................................................... 8 Pool query requests..................................................................................................................................... 8 Volume query requests................................................................................................................................9 Volume snapshot query requests................................................................................................................9 Consistency group query requests............................................................................................................10 Snapshot group query requests................................................................................................................ 10 Mapping query requests............................................................................................................................ 10 Mirror query requests................................................................................................................................ 11 Host query requests.................................................................................................................................. 11 Host port query requests..................................................................................................................... 12 Cluster query requests.............................................................................................................................. 12 Performance class query requests............................................................................................................13 Event query requests.................................................................................................................................13 Chapter 4. Update requests................................................................................. 15 Update response format............................................................................................................................15 Pool update requests.................................................................................................................................16 Pool creation requests......................................................................................................................... 16 Pool resize requests............................................................................................................................. 17 Pool resize snapshot size requests......................................................................................................18 Pool rename requests.......................................................................................................................... 18 Pool deletion requests......................................................................................................................... 19 Volume update requests............................................................................................................................20 Volume creation requests.................................................................................................................... 20 Volume resize requests........................................................................................................................21 Volume lock requests...........................................................................................................................21 Volume unlock requests.......................................................................................................................22 Volume rename requests..................................................................................................................... 22 iii IBM Confidential Volume copy requests..........................................................................................................................23 Volume move requests.........................................................................................................................23 Volume deletion requests.................................................................................................................... 24 Volume snapshot update requests........................................................................................................... 25 Volume snapshot creation requests.................................................................................................... 25 Volume snapshot overwrite requests.................................................................................................. 25 Volume snapshot lock requests...........................................................................................................26 Volume snapshot unlock requests.......................................................................................................26 Volume snapshot duplication requests............................................................................................... 27 Volume snapshot deletion requests.................................................................................................... 27 Consistency group update requests..........................................................................................................28 Consistency group creation requests.................................................................................................. 28 Consistency group add volume requests.............................................................................................28 Consistency group remove volume requests...................................................................................... 29 Consistency group deletion requests.................................................................................................. 29 Snapshot group update requests.............................................................................................................. 30 Snapshot group creation requests.......................................................................................................30 Snapshot group overwrite requests.....................................................................................................30