StorPool API Reference

Copyright (c) 2014-2015 StorPool. All rights reserved.

This reference document describes the StorPool API version 14.10 and the supported API calls.

1. General
2. Peers
1. List the network peers
3. Tasks
1. List tasks
4. Services
1. List all StorPool services
2. List all blocked StorPool servers
5. Servers
1. List all disks on a server
2. Describe a disk on a server
6. Clients
1. Get the current status of all the clients
2. Wait until a client updates to the current configuration
3. List all the active requests on a client
7. AoE Targets
1. Display AoE status
2. Export a volume
3. Unexport a volume
4. Export a snapshot
5. Unexport a snaphot
6. List all active requests on an AoE target
8. Disks
1. List all disks
2. Describe a disk
3. Get disk info
4. Eject a disk
5. Forget a disk
6. Ignore a disk
7. Soft-eject a disk
8. Pause a disk's soft-eject operation
9. Cancel a disk's soft-eject operation
10. Set a disk's description
11. List all the active requests on a disk
9. Volumes
1. List all volumes
2. Get volume and snapshot status
3. List a single volume
4. Describe a volume
5. Get volume info
6. List the parent snapshots of a volume
7. Create a new volume
8. Update a volume
9. Freeze a volume
10. Rebase a volume
11. Abandon disk
12. Delete a volume
10. Snapshots
1. List all snapshots
2. List a single snapshot
3. Describe a snapshot
4. Get snapshot info
5. Snapshot a volume
6. Update a snapshot
7. Rebase a snapshot
8. Abandon disk
9. Delete a snapshot
11. Attachments
1. List all attachments
2. Reassign volumes and/or snapshots
12. Placement Groups
1. List all placement groups
2. Describe a single placement group
3. Create and/or update a placement group
4. Delete a placement group
13. Volume Templates
1. List all volume templates
2. List the status of all volume templates
3. Describe a single volume template
4. Create a volume template
5. Update a volume template
6. Delete a volume template
14. Volume Relocator
1. Turn the relocator on
2. Turn the relocator off
3. Get the relocator's status
15. Balancer
1. Turn the balancer on
2. Turn the balancer off
3. Get the balancer's status
16. Data Types

General

The StorPool API can be used with any tool that can generate HTTP requests with the GET and POST methods. The only requirement is to supply the Authorization header and, if required by the request, valid JSON data.

For each call there is an explanation of the HTTP request and response and an example in raw format as it should be sent to the StorPool management service.

Here are two examples using curl using the GET and POST methods respectively and their counterparts as issued by the StorPool CLI:

curl -H "Authorization: Storpool v1:1556129910218014736" 192.168.42.208:81/ctrl/1.0/DisksList
storpool disk list

curl -d '{"addDisks":["1"]}' -H "Authorization: Storpool v1:1556129910218014736" 192.168.42.208:81/ctrl/1.0/PlacementGroupUpdate/hdd
storpool placementGroup hdd addDisk 1

Python programs may use the API by importing the Python StorPool bindings (use 'pypi install storpool' to install them):

>>>import spapi
>>>api=spapi.Api('192.168.0.5', 80, '1556560560218011653')
>>>a.peersList()

{
  1: {
       'networks': {
         0: {
          'mac': '00:4A:E6:5F:34:C3'
         }
       }
  },
  2: {
       'networks': {
         0: {
          'mac': '52:54:E6:5F:34:DF'
         }
       }
  },
  3: {
        'networks': {
          0: {
           'mac': '52:57:5F:54:E6:3A'
          }
        }
  }
}

The calls that may be used may be found in the file spapi.py

Note: Requests will sometimes use GET instead of POST and consequently, will not require JSON. Responses on the other hand always produce JSON content.

Peers

List the network peers (NetworkPeersList)

List the network nodes running the StorPool beacon including information such as the ID of the node, the networks it communicates through and the corresponding MAC addresses.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/NetworkPeersList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/NetworkPeersList
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "PeerID": {
           "networks": {
             "NetID": {
               "mac": MAC Address
             }, ...
           }
         }, ...
       }
     }
     

   • Response Data: A dict from PeerID to PeerDesc
     • Key type: PeerID
     • Value type: PeerDesc
       • networks: List of the networks that StorPool communicates through on this node.A dict from NetID to NetDesc
         • Key type: NetID
         • Value type: NetDesc
           • mac: (MAC Address)

Tasks

List tasks (TasksList)

List the currently active recovery tasks. This call will return JSON data only when there is a relocation in progress. Under normal operation of the cluster it will return no data.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/TasksList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/TasksList
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "allObjects": int,
         "completedObjects": int,
         "diskId": DiskID,
         "dispatchedObjects": int,
         "transactionId": long,
         "unresolvedObjects": int /* Internal */
       }, ...]
     }
     

   • Response Data:
     Element type: Task
     • allObjects: (int): The number of all the objects that the task is performing actions on.
     • completedObjects: (int): The number of objects that the task has finished working on.
     • diskId: (DiskID): The disk ID this task is on.
     • dispatchedObjects: (int): Objects that the task has started working on.
     • transactionId: (long): An ID associated with the currently running task. This ID is the same for all the tasks running on different disks but initiated by the same action (e.g. when reallocating a volume, all tasks associated with that volume will have the same ID).
     • unresolvedObjects: (Internal int)

Services

List all StorPool services (ServicesList)

List all the services in the cluster (StorPool servers, clients, management, etc). If the whole cluster is not operational this call will return an error.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ServicesList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ServicesList
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "aoeTargets": {
           "AoeTargetID": {
             "id": AoeTargetID,
             "nodeId": NodeID,
             "status": ClientStatus,
             "version": string
           }, ...
         },
         "clients": {
           "ClientID": {
             "id": ClientID,
             "nodeId": NodeID,
             "status": ClientStatus,
             "version": string
           }, ...
         },
         "clusterStatus": ClusterStatus,
         "mgmt": {
           "MgmtID": {
             "active": bool,
             "id": MgmtID,
             "nodeId": NodeID,
             "prio": int /* Internal */,
             "status": ClientStatus,
             "version": string
           }, ...
         },
         "servers": {
           "ServerID": {
             "id": ServerID,
             "missingDisks": [DiskID, ...],
             "nodeId": NodeID,
             "pendingDisks": [DiskID, ...],
             "status": ServerStatus,
             "version": string
           }, ...
         }
       }
     }
     

   • Response Data: ClusterStatus
     • aoeTargets: A dict from AoeTargetID to AoeTarget
       • Key type: AoeTargetID
       • Value type: AoeTarget
         • id: (AoeTargetID): The ID of the service.
         • nodeId: (NodeID): The ID of the node on which the service is running.
         • status: (ClientStatus): The current status of the AoE target.
         • version: (string): The version of the running StorPool service.
     • clients: A dict from ClientID to Client
       • Key type: ClientID
       • Value type: Client
         • id: (ClientID): The ID of the service. Currently this is the same as the ID of the node.
         • nodeId: (NodeID): The ID of the node on which the service is running.
         • status: (ClientStatus): The current status of the client.
         • version: (string): The version of the running StorPool service.
     • clusterStatus: (ClusterStatus): The current status of the whole cluster. running - At least one running server; a cluster is formed. waiting - In quorum but negotiations between servers are not over yet. down - No quorum; most likely because more beacons are needed.
     • mgmt: A dict from MgmtID to Mgmt
       • Key type: MgmtID
       • Value type: Mgmt
         • active: (bool): If the instance is currently active. For a given cluster one mgmt instance will be active at any given time.
         • id: (MgmtID): The ID of the service.
         • nodeId: (NodeID): The ID of the node on which the service is running.
         • prio: (Internal int)
         • status: (ClientStatus): The current status of the mgmt instance.
         • version: (string): The version of the running StorPool service.
     • servers: A dict from ServerID to Server
       • Key type: ServerID
       • Value type: Server
         • id: (ServerID): The ID of the service. Currently this is the same as the ID of the node.
         • missingDisks: The cluster will remain down until these disks are seen again. This happens in the case of simultaneous failure of the whole cluster (power failure); the servers keep track of where the most recent configuration and data was stored.
           Element type: DiskID
         • nodeId: (NodeID): The ID of the node on which the service is running.
         • pendingDisks: Similar to missingDisks, these are the disks that are ready and waiting for the missing ones.
           Element type: DiskID
         • status: (ServerStatus): down - There is no storpool_server daemon running or it is still recovering its drives from a crashed state. waiting - storpool_server is running but waiting for some disks to appear to prevent split-brain situations. booting - No missing disks; the server is in the process of joining the cluster ...
         • version: (string): The version of the running StorPool service.

List all blocked StorPool servers (ServersListBlocked)

List the currently active StorPool servers even before the cluster has become operational, along with information about any missing disks that the cluster is waiting for.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ServersListBlocked HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ServersListBlocked
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "aoeTargets": {
           "AoeTargetID": {
             "id": AoeTargetID,
             "nodeId": NodeID,
             "status": ClientStatus,
             "version": string
           }, ...
         },
         "clients": {
           "ClientID": {
             "id": ClientID,
             "nodeId": NodeID,
             "status": ClientStatus,
             "version": string
           }, ...
         },
         "clusterStatus": ClusterStatus,
         "mgmt": {
           "MgmtID": {
             "active": bool,
             "id": MgmtID,
             "nodeId": NodeID,
             "prio": int /* Internal */,
             "status": ClientStatus,
             "version": string
           }, ...
         },
         "servers": {
           "ServerID": {
             "id": ServerID,
             "missingDisks": [DiskID, ...],
             "nodeId": NodeID,
             "pendingDisks": [DiskID, ...],
             "status": ServerStatus,
             "version": string
           }, ...
         }
       }
     }
     

   • Response Data: ClusterStatus
     • aoeTargets: A dict from AoeTargetID to AoeTarget
       • Key type: AoeTargetID
       • Value type: AoeTarget
         • id: (AoeTargetID): The ID of the service.
         • nodeId: (NodeID): The ID of the node on which the service is running.
         • status: (ClientStatus): The current status of the AoE target.
         • version: (string): The version of the running StorPool service.
     • clients: A dict from ClientID to Client
       • Key type: ClientID
       • Value type: Client
         • id: (ClientID): The ID of the service. Currently this is the same as the ID of the node.
         • nodeId: (NodeID): The ID of the node on which the service is running.
         • status: (ClientStatus): The current status of the client.
         • version: (string): The version of the running StorPool service.
     • clusterStatus: (ClusterStatus): The current status of the whole cluster. running - At least one running server; a cluster is formed. waiting - In quorum but negotiations between servers are not over yet. down - No quorum; most likely because more beacons are needed.
     • mgmt: A dict from MgmtID to Mgmt
       • Key type: MgmtID
       • Value type: Mgmt
         • active: (bool): If the instance is currently active. For a given cluster one mgmt instance will be active at any given time.
         • id: (MgmtID): The ID of the service.
         • nodeId: (NodeID): The ID of the node on which the service is running.
         • prio: (Internal int)
         • status: (ClientStatus): The current status of the mgmt instance.
         • version: (string): The version of the running StorPool service.
     • servers: A dict from ServerID to Server
       • Key type: ServerID
       • Value type: Server
         • id: (ServerID): The ID of the service. Currently this is the same as the ID of the node.
         • missingDisks: The cluster will remain down until these disks are seen again. This happens in the case of simultaneous failure of the whole cluster (power failure); the servers keep track of where the most recent configuration and data was stored.
           Element type: DiskID
         • nodeId: (NodeID): The ID of the node on which the service is running.
         • pendingDisks: Similar to missingDisks, these are the disks that are ready and waiting for the missing ones.
           Element type: DiskID
         • status: (ServerStatus): down - There is no storpool_server daemon running or it is still recovering its drives from a crashed state. waiting - storpool_server is running but waiting for some disks to appear to prevent split-brain situations. booting - No missing disks; the server is in the process of joining the cluster ...
         • version: (string): The version of the running StorPool service.

Servers

List all disks on a server (ServerDisksList)

Return detailed information about each disk on the given server.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ServerDisksList/{serverId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ServerDisksList/{serverId}
   • Arguments:
     • serverId - ServerID: integer, 1 <= value <= 32767
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "DiskID": Either({
           "agAllocated": int /* Internal */,
           "agCount": int /* Internal */,
           "agFree": int /* Internal */,
           "agFreeing": int /* Internal */,
           "agFull": int /* Internal */,
           "agMaxSizeFull": int /* Internal */,
           "agMaxSizePartial": int /* Internal */,
           "agPartial": int /* Internal */,
           "description": DiskDescritpion,
           "device": string,
           "empty": bool,
           "entriesAllocated": int,
           "entriesCount": int,
           "entriesFree": int,
           "generationLeft": -1,
           "id": DiskID,
           "model": string,
           "objectsAllocated": int,
           "objectsCount": int,
           "objectsFree": int,
           "objectsOnDiskSize": long,
           "sectorsCount": long,
           "serial": string,
           "serverId": ServerID,
           "softEject": DiskSoftEjectStatus,
           "ssd": bool
         }, {
           "description": DiskDescritpion,
           "generationLeft": long,
           "id": DiskID,
           "model": string,
           "serial": string,
           "serverId": ServerID,
           "softEject": DiskSoftEjectStatus
         }), ...
       }
     }
     

   • Response Data: A dict from DiskID to Either(UpDiskSummary, DownDiskSummary)
     • Key type: DiskID
     • Value type: The value must be of one of the following types: UpDiskSummary, DownDiskSummary.
       Subtypes:
       • UpDiskSummary
         • agAllocated: (Internal int)
         • agCount: (Internal int)
         • agFree: (Internal int)
         • agFreeing: (Internal int)
         • agFull: (Internal int)
         • agMaxSizeFull: (Internal int)
         • agMaxSizePartial: (Internal int)
         • agPartial: (Internal int)
         • description: (DiskDescritpion): A user-defined description of the disk for easier identification of the device.
         • device: (string): The name of the physical disk device on the server.
         • empty: (bool): True if no volumes or snapshots are on this disk.
         • entriesAllocated: (int): Used entries of the disk.
         • entriesCount: (int): The maximum amount of entries that can exists on the disk.
         • entriesFree: (int): The remaining number of entries that can be stored on the disk.
         • generationLeft: (-1): The last cluster generation when the disk was active on a running server, or -1 if the disk is currently active.
         • id: (DiskID): The ID of this disk. It is set when the disk is formatted to work with StorPool.
         • model: (string)
         • objectsAllocated: (int): Used objects of the disk.
         • objectsCount: (int): The maximum amount of object that can exists on the disk.
         • objectsFree: (int): The remaining number of objects that can be stored on the disk.
         • objectsOnDiskSize: (long): Total size occupied by objects. In essence, this is the estimated disk usage by StorPool.
         • sectorsCount: (long): The amount of 512-byte sectors on the disk.
         • serial: (string)
         • serverId: (ServerID): The ID of the server this disk is currently on. In case the disk is currently down, the last known server ID is reported.
         • softEject: (DiskSoftEjectStatus): The status of the soft-eject process.
         • ssd: (bool): Whether the device is an SSD.
       • DiskSummaryBase
         • description: (DiskDescritpion): A user-defined description of the disk for easier identification of the device.
         • generationLeft: (long): The last cluster generation when the disk was active on a running server, or -1 if the disk is currently active.
         • id: (DiskID): The ID of this disk. It is set when the disk is formatted to work with StorPool.
         • model: (string)
         • serial: (string)
         • serverId: (ServerID): The ID of the server this disk is currently on. In case the disk is currently down, the last known server ID is reported.
         • softEject: (DiskSoftEjectStatus): The status of the soft-eject process.

Describe a disk on a server (ServerDiskDescribe)

Return detailed information about a disk on the given server and the objects on it.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ServerDiskDescribe/{serverId}/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ServerDiskDescribe/{serverId}/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
     • serverId - ServerID: integer, 1 <= value <= 32767
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "agAllocated": int /* Internal */,
         "agCount": int /* Internal */,
         "agFree": int /* Internal */,
         "agFreeing": int /* Internal */,
         "agFull": int /* Internal */,
         "agMaxSizeFull": int /* Internal */,
         "agMaxSizePartial": int /* Internal */,
         "agPartial": int /* Internal */,
         "description": DiskDescritpion,
         "device": string,
         "empty": bool,
         "entriesAllocated": int,
         "entriesCount": int,
         "entriesFree": int,
         "generationLeft": -1,
         "id": DiskID,
         "model": string,
         "objects": {
           "int": {
             "generation": long,
             "objectId": int /* Internal */,
             "onDiskSize": int,
             "parentVolume": string,
             "state": ObjectState,
             "storedSize": int,
             "version": long,
             "volume": string,
             "volumeId": long /* Internal */
           }, ...
         },
         "objectsAllocated": int,
         "objectsCount": int,
         "objectsFree": int,
         "objectsOnDiskSize": long,
         "sectorsCount": long,
         "serial": string,
         "serverId": ServerID,
         "softEject": DiskSoftEjectStatus,
         "ssd": bool
       }
     }
     

   • Response Data: Disk
     • agAllocated: (Internal int)
     • agCount: (Internal int)
     • agFree: (Internal int)
     • agFreeing: (Internal int)
     • agFull: (Internal int)
     • agMaxSizeFull: (Internal int)
     • agMaxSizePartial: (Internal int)
     • agPartial: (Internal int)
     • description: (DiskDescritpion): A user-defined description of the disk for easier identification of the device.
     • device: (string): The name of the physical disk device on the server.
     • empty: (bool): True if no volumes or snapshots are on this disk.
     • entriesAllocated: (int): Used entries of the disk.
     • entriesCount: (int): The maximum amount of entries that can exists on the disk.
     • entriesFree: (int): The remaining number of entries that can be stored on the disk.
     • generationLeft: (-1): The last cluster generation when the disk was active on a running server, or -1 if the disk is currently active.
     • id: (DiskID): The ID of this disk. It is set when the disk is formatted to work with StorPool.
     • model: (string)
     • objects: Detailed information about each object on the disk.A dict from int to DiskObject
       • Key type: int
       • Value type: DiskObject
         • generation: (long): The generation when the last write to this object occurred.
         • objectId: (Internal int)
         • onDiskSize: (int): The space allocated on the disk for the object. This can go up to 32MB.
         • parentVolume: (string): The name of the parent snapshot.
         • state: (ObjectState)
         • storedSize: (int): The size of the actual data in that object (<= onDiskSize).
         • version: (long): With each write the version is increased.
         • volume: (string): The name of the volume for which the object contains data.
         • volumeId: (Internal long)
     • objectsAllocated: (int): Used objects of the disk.
     • objectsCount: (int): The maximum amount of object that can exists on the disk.
     • objectsFree: (int): The remaining number of objects that can be stored on the disk.
     • objectsOnDiskSize: (long): Total size occupied by objects. In essence, this is the estimated disk usage by StorPool.
     • sectorsCount: (long): The amount of 512-byte sectors on the disk.
     • serial: (string)
     • serverId: (ServerID): The ID of the server this disk is currently on. In case the disk is currently down, the last known server ID is reported.
     • softEject: (DiskSoftEjectStatus): The status of the soft-eject process.
     • ssd: (bool): Whether the device is an SSD.

Clients

Get the current status of all the clients (ClientsConfigDump)

Return the status of each client including its current generation and generation update status.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ClientsConfigDump HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ClientsConfigDump
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "clientGeneration": long,
         "configStatus": client status,
         "delay": int,
         "generation": long,
         "id": ClientID
       }, ...]
     }
     

   • Response Data:
     Element type: ClientConfigStatus
     • clientGeneration: (long): The generation of the specific client.
     • configStatus: (client status): Whether there is an update of the configuration in progress.
     • delay: (int): The time it took for the client generation to reach the cluster generation. Only applicable to ClientConfigWait. Always 0 in ClientsConfigDump.
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • id: (ClientID)

Wait until a client updates to the current configuration (ClientConfigWait)

Return the same JSON as ClientsConfigDump but block until the client has updated its configuration information to the current generation at the time of the request.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ClientConfigWait/{clientId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ClientConfigWait/{clientId}
   • Arguments:
     • clientId - ClientID: integer, 1 <= value <= 24575
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "clientGeneration": long,
         "configStatus": client status,
         "delay": int,
         "generation": long,
         "id": ClientID
       }, ...]
     }
     

   • Response Data:
     Element type: ClientConfigStatus
     • clientGeneration: (long): The generation of the specific client.
     • configStatus: (client status): Whether there is an update of the configuration in progress.
     • delay: (int): The time it took for the client generation to reach the cluster generation. Only applicable to ClientConfigWait. Always 0 in ClientsConfigDump.
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • id: (ClientID)

List all the active requests on a client (ClientActiveRequests)

List detailed information about the requests being currently processed on the given client.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ClientActiveRequests/{clientId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ClientActiveRequests/{clientId}
   • Arguments:
     • clientId - ClientID: integer, 1 <= value <= 24575
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "clientId": ClientID,
         "requests": [{
           "address": long,
           "drOp": string /* Internal */,
           "msecActive": int,
           "op": RequestOp,
           "prevState": string /* Internal */,
           "requestId": string,
           "requestIdx": int,
           "size": int,
           "state": string /* Internal */,
           "volume": Either(VolumeName, SnapshotName)
         }, ...]
       }
     }
     

   • Response Data: ClientActiveRequests
     • clientId: (ClientID)
     • requests: A detailed listing of all the requests associated with the given client.
       Element type: ActiveRequestDesc
       • address: (long): The offset in bytes within the logical volume.
       • drOp: (Internal string): An internal attribute used only for debugging. We strongly recommend that you do not use this attribute in any kind of automation.
       • msecActive: (int): Time in microseconds since the request was submitted.
       • op: (RequestOp): The type of the requested operation; one of read, write, system, merge, entries flush, #bad_state, #bad_drOp
       • prevState: (Internal string): An internal attribute used only for debugging. We strongly recommend that you do not use this attribute in any kind of automation.
       • requestId: (string): A unique request ID that may be matched between clients and disks.
       • requestIdx: (int): A temporary local request identifier for this request on this client or disk.
       • size: (int): The size of the request in bytes.
       • state: (Internal string): An internal attribute used only for debugging. We strongly recommend that you do not use this attribute in any kind of automation.
       • volume: The value must be of one of the following types: VolumeName, SnapshotName.
         Subtypes:
         • VolumeName
         • SnapshotName

AoE Targets

Display AoE status (AoeStatus)

List the StorPool volumes and snapshots exported over AoE.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/AoeStatus HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/AoeStatus
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "aoeId": string,
         "name": Either(VolumeName, SnapshotName),
         "snapshot": bool,
         "status": AoeExportStatus,
         "target": Either(null, AoeTargetID)
       }, ...]
     }
     

   • Response Data:
     Element type: AoeExport
     • aoeId: (string): The AoE identifier that the volume is exported as.
     • name: The name of the StorPool volume.The value must be of one of the following types: VolumeName, SnapshotName.
       Subtypes:
       • VolumeName
       • SnapshotName
     • snapshot: (bool): True if this entry describes a snapshot instead of a volume.
     • status: (AoeExportStatus): The status of the StorPool AoE target node if target is set.
     • target: The StorPool node that serves as an AoE target to export this volume.The value must be of one of the following types: null, AoeTargetID.
       Subtypes:
       • null
       • AoeTargetID

Export a volume (AoeExportVolume)

Export the specified volume over AoE.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/AoeExportVolume/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/AoeExportVolume/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Unexport a volume (AoeExportSnapshot)

Export the specified snapshot over AoE.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/AoeExportSnapshot/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/AoeExportSnapshot/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: a string(200), matching ^\*?[A-Za-z0-9_\-.:@]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Export a snapshot (AoeUnexportVolume)

Stop exporting the specified volume over AoE.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/AoeUnexportVolume/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/AoeUnexportVolume/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Unexport a snaphot (AoeUnexportSnapshot)

Stop exporting the specified snapshot over AoE.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/AoeUnexportSnapshot/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/AoeUnexportSnapshot/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: a string(200), matching ^\*?[A-Za-z0-9_\-.:@]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

List all active requests on an AoE target (AoeTargetActiveRequests)

List detailed information about the requests being currently processed on the given AoE target

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/AoeTargetActiveRequests/{aoeTargetId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/AoeTargetActiveRequests/{aoeTargetId}
   • Arguments:
     • aoeTargetId - AoeTargetID: integer, 1 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "aoeTargetId": AoeTargetID,
         "requests": [{
           "address": long,
           "drOp": string /* Internal */,
           "msecActive": int,
           "op": RequestOp,
           "prevState": string /* Internal */,
           "requestId": string,
           "requestIdx": int,
           "size": int,
           "state": string /* Internal */,
           "volume": Either(VolumeName, SnapshotName)
         }, ...]
       }
     }
     

   • Response Data: AoeTargetActiveRequests
     • aoeTargetId: (AoeTargetID)
     • requests: A detailed listing of all the requests associated with the given AoE target.
       Element type: ActiveRequestDesc
       • address: (long): The offset in bytes within the logical volume.
       • drOp: (Internal string): An internal attribute used only for debugging. We strongly recommend that you do not use this attribute in any kind of automation.
       • msecActive: (int): Time in microseconds since the request was submitted.
       • op: (RequestOp): The type of the requested operation; one of read, write, system, merge, entries flush, #bad_state, #bad_drOp
       • prevState: (Internal string): An internal attribute used only for debugging. We strongly recommend that you do not use this attribute in any kind of automation.
       • requestId: (string): A unique request ID that may be matched between clients and disks.
       • requestIdx: (int): A temporary local request identifier for this request on this client or disk.
       • size: (int): The size of the request in bytes.
       • state: (Internal string): An internal attribute used only for debugging. We strongly recommend that you do not use this attribute in any kind of automation.
       • volume: The value must be of one of the following types: VolumeName, SnapshotName.
         Subtypes:
         • VolumeName
         • SnapshotName

Disks

List all disks (DisksList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/DisksList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/DisksList
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "DiskID": Either({
           "agAllocated": int /* Internal */,
           "agCount": int /* Internal */,
           "agFree": int /* Internal */,
           "agFreeing": int /* Internal */,
           "agFull": int /* Internal */,
           "agMaxSizeFull": int /* Internal */,
           "agMaxSizePartial": int /* Internal */,
           "agPartial": int /* Internal */,
           "description": DiskDescritpion,
           "device": string,
           "empty": bool,
           "entriesAllocated": int,
           "entriesCount": int,
           "entriesFree": int,
           "generationLeft": -1,
           "id": DiskID,
           "model": string,
           "objectsAllocated": int,
           "objectsCount": int,
           "objectsFree": int,
           "objectsOnDiskSize": long,
           "sectorsCount": long,
           "serial": string,
           "serverId": ServerID,
           "softEject": DiskSoftEjectStatus,
           "ssd": bool
         }, {
           "description": DiskDescritpion,
           "generationLeft": long,
           "id": DiskID,
           "model": string,
           "serial": string,
           "serverId": ServerID,
           "softEject": DiskSoftEjectStatus
         }), ...
       }
     }
     

   • Response Data: A dict from DiskID to Either(UpDiskSummary, DownDiskSummary)
     • Key type: DiskID
     • Value type: The value must be of one of the following types: UpDiskSummary, DownDiskSummary.
       Subtypes:
       • UpDiskSummary
         • agAllocated: (Internal int)
         • agCount: (Internal int)
         • agFree: (Internal int)
         • agFreeing: (Internal int)
         • agFull: (Internal int)
         • agMaxSizeFull: (Internal int)
         • agMaxSizePartial: (Internal int)
         • agPartial: (Internal int)
         • description: (DiskDescritpion): A user-defined description of the disk for easier identification of the device.
         • device: (string): The name of the physical disk device on the server.
         • empty: (bool): True if no volumes or snapshots are on this disk.
         • entriesAllocated: (int): Used entries of the disk.
         • entriesCount: (int): The maximum amount of entries that can exists on the disk.
         • entriesFree: (int): The remaining number of entries that can be stored on the disk.
         • generationLeft: (-1): The last cluster generation when the disk was active on a running server, or -1 if the disk is currently active.
         • id: (DiskID): The ID of this disk. It is set when the disk is formatted to work with StorPool.
         • model: (string)
         • objectsAllocated: (int): Used objects of the disk.
         • objectsCount: (int): The maximum amount of object that can exists on the disk.
         • objectsFree: (int): The remaining number of objects that can be stored on the disk.
         • objectsOnDiskSize: (long): Total size occupied by objects. In essence, this is the estimated disk usage by StorPool.
         • sectorsCount: (long): The amount of 512-byte sectors on the disk.
         • serial: (string)
         • serverId: (ServerID): The ID of the server this disk is currently on. In case the disk is currently down, the last known server ID is reported.
         • softEject: (DiskSoftEjectStatus): The status of the soft-eject process.
         • ssd: (bool): Whether the device is an SSD.
       • DiskSummaryBase
         • description: (DiskDescritpion): A user-defined description of the disk for easier identification of the device.
         • generationLeft: (long): The last cluster generation when the disk was active on a running server, or -1 if the disk is currently active.
         • id: (DiskID): The ID of this disk. It is set when the disk is formatted to work with StorPool.
         • model: (string)
         • serial: (string)
         • serverId: (ServerID): The ID of the server this disk is currently on. In case the disk is currently down, the last known server ID is reported.
         • softEject: (DiskSoftEjectStatus): The status of the soft-eject process.

Describe a disk (DiskDescribe)

List all disks including detailed information about the objects on each disk.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/DiskDescribe/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/DiskDescribe/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "agAllocated": int /* Internal */,
         "agCount": int /* Internal */,
         "agFree": int /* Internal */,
         "agFreeing": int /* Internal */,
         "agFull": int /* Internal */,
         "agMaxSizeFull": int /* Internal */,
         "agMaxSizePartial": int /* Internal */,
         "agPartial": int /* Internal */,
         "description": DiskDescritpion,
         "device": string,
         "empty": bool,
         "entriesAllocated": int,
         "entriesCount": int,
         "entriesFree": int,
         "generationLeft": -1,
         "id": DiskID,
         "model": string,
         "objects": {
           "int": {
             "generation": long,
             "objectId": int /* Internal */,
             "onDiskSize": int,
             "parentVolume": string,
             "state": ObjectState,
             "storedSize": int,
             "version": long,
             "volume": string,
             "volumeId": long /* Internal */
           }, ...
         },
         "objectsAllocated": int,
         "objectsCount": int,
         "objectsFree": int,
         "objectsOnDiskSize": long,
         "sectorsCount": long,
         "serial": string,
         "serverId": ServerID,
         "softEject": DiskSoftEjectStatus,
         "ssd": bool
       }
     }
     

   • Response Data: Disk
     • agAllocated: (Internal int)
     • agCount: (Internal int)
     • agFree: (Internal int)
     • agFreeing: (Internal int)
     • agFull: (Internal int)
     • agMaxSizeFull: (Internal int)
     • agMaxSizePartial: (Internal int)
     • agPartial: (Internal int)
     • description: (DiskDescritpion): A user-defined description of the disk for easier identification of the device.
     • device: (string): The name of the physical disk device on the server.
     • empty: (bool): True if no volumes or snapshots are on this disk.
     • entriesAllocated: (int): Used entries of the disk.
     • entriesCount: (int): The maximum amount of entries that can exists on the disk.
     • entriesFree: (int): The remaining number of entries that can be stored on the disk.
     • generationLeft: (-1): The last cluster generation when the disk was active on a running server, or -1 if the disk is currently active.
     • id: (DiskID): The ID of this disk. It is set when the disk is formatted to work with StorPool.
     • model: (string)
     • objects: Detailed information about each object on the disk.A dict from int to DiskObject
       • Key type: int
       • Value type: DiskObject
         • generation: (long): The generation when the last write to this object occurred.
         • objectId: (Internal int)
         • onDiskSize: (int): The space allocated on the disk for the object. This can go up to 32MB.
         • parentVolume: (string): The name of the parent snapshot.
         • state: (ObjectState)
         • storedSize: (int): The size of the actual data in that object (<= onDiskSize).
         • version: (long): With each write the version is increased.
         • volume: (string): The name of the volume for which the object contains data.
         • volumeId: (Internal long)
     • objectsAllocated: (int): Used objects of the disk.
     • objectsCount: (int): The maximum amount of object that can exists on the disk.
     • objectsFree: (int): The remaining number of objects that can be stored on the disk.
     • objectsOnDiskSize: (long): Total size occupied by objects. In essence, this is the estimated disk usage by StorPool.
     • sectorsCount: (long): The amount of 512-byte sectors on the disk.
     • serial: (string)
     • serverId: (ServerID): The ID of the server this disk is currently on. In case the disk is currently down, the last known server ID is reported.
     • softEject: (DiskSoftEjectStatus): The status of the soft-eject process.
     • ssd: (bool): Whether the device is an SSD.

Get disk info (DiskGetInfo)

List all disks including information about the volumes stored on each disk.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/DiskGetInfo/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/DiskGetInfo/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "agAllocated": int /* Internal */,
         "agCount": int /* Internal */,
         "agFree": int /* Internal */,
         "agFreeing": int /* Internal */,
         "agFull": int /* Internal */,
         "agMaxSizeFull": int /* Internal */,
         "agMaxSizePartial": int /* Internal */,
         "agPartial": int /* Internal */,
         "description": DiskDescritpion,
         "device": string,
         "empty": bool,
         "entriesAllocated": int,
         "entriesCount": int,
         "entriesFree": int,
         "generationLeft": -1,
         "id": DiskID,
         "model": string,
         "objectStates": {
           "ObjectState": int, ...
         },
         "objectsAllocated": int,
         "objectsCount": int,
         "objectsFree": int,
         "objectsOnDiskSize": long,
         "sectorsCount": long,
         "serial": string,
         "serverId": ServerID,
         "softEject": DiskSoftEjectStatus,
         "ssd": bool,
         "volumeInfos": {
           "string": {
             "name": string,
             "objectStates": {
               "ObjectState": int, ...
             },
             "objectsCount": long,
             "onDiskSize": long,
             "storedSize": long
           }, ...
         }
       }
     }
     

   • Response Data: DiskInfo
     • agAllocated: (Internal int)
     • agCount: (Internal int)
     • agFree: (Internal int)
     • agFreeing: (Internal int)
     • agFull: (Internal int)
     • agMaxSizeFull: (Internal int)
     • agMaxSizePartial: (Internal int)
     • agPartial: (Internal int)
     • description: (DiskDescritpion): A user-defined description of the disk for easier identification of the device.
     • device: (string): The name of the physical disk device on the server.
     • empty: (bool): True if no volumes or snapshots are on this disk.
     • entriesAllocated: (int): Used entries of the disk.
     • entriesCount: (int): The maximum amount of entries that can exists on the disk.
     • entriesFree: (int): The remaining number of entries that can be stored on the disk.
     • generationLeft: (-1): The last cluster generation when the disk was active on a running server, or -1 if the disk is currently active.
     • id: (DiskID): The ID of this disk. It is set when the disk is formatted to work with StorPool.
     • model: (string)
     • objectStates: A dict from ObjectState to int
       • Key type: ObjectState
       • Value type: int
     • objectsAllocated: (int): Used objects of the disk.
     • objectsCount: (int): The maximum amount of object that can exists on the disk.
     • objectsFree: (int): The remaining number of objects that can be stored on the disk.
     • objectsOnDiskSize: (long): Total size occupied by objects. In essence, this is the estimated disk usage by StorPool.
     • sectorsCount: (long): The amount of 512-byte sectors on the disk.
     • serial: (string)
     • serverId: (ServerID): The ID of the server this disk is currently on. In case the disk is currently down, the last known server ID is reported.
     • softEject: (DiskSoftEjectStatus): The status of the soft-eject process.
     • ssd: (bool): Whether the device is an SSD.
     • volumeInfos: Detailed information about the volumes that have data stored on the disk.A dict from str to DiskVolumeInfo
       • Key type: string
       • Value type: DiskVolumeInfo
         • name: (string)
         • objectStates: For each state, the number of objects that are in that state. 0-undefined 1-ok 2-outdated 3-in_recovery 4-waiting_for_version 5-waiting_for_disk 6-data_not_present 7-data_lost 8-waiting_for_chain 9-wait_idleA dict from ObjectState to int
           • Key type: ObjectState
           • Value type: int
         • objectsCount: (long): The number of objects of the volume stored on this disk.
         • onDiskSize: (long): The space allocated on the disk for the object. This can go up to 32MB.
         • storedSize: (long): The size of the actual data in that object (<= onDiskSize).

Eject a disk (DiskEject)

Stop operations on the given disk even if it is not empty.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskEject/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskEject/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Forget a disk (DiskForget)

Remove the disk from any placement groups or volumes that it is used in.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskForget/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskForget/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Ignore a disk (DiskIgnore)

Try to boot the cluster by ignoring this disk.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskIgnore/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskIgnore/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Soft-eject a disk (DiskSoftEject)

Stop writes to the given disk and start relocating all the data stored on it to other disks.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskSoftEject/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskSoftEject/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Pause a disk's soft-eject operation (DiskSoftEjectPause)

Temporarily pause the relocation tasks for the disk. This can be helpful in heavy load situations.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskSoftEjectPause/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskSoftEjectPause/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Cancel a disk's soft-eject operation (DiskSoftEjectCancel)

Stop the relocation tasks for the disk and mark it as usable again. After this operation data will be moved back to the disk.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskSoftEjectCancel/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskSoftEjectCancel/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Set a disk's description (DiskSetDescription)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskSetDescription/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "description": DiskDescritpion
     }

   • Method: POST
   • Path: /ctrl/1.0/DiskSetDescription/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: DiskDescUpdate
     • description: (DiskDescritpion): A user-defined description of the disk for easier identification of the device.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

List all the active requests on a disk (DiskActiveRequests)

List detailed information about the requests being currently processed on the given disk.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/DiskActiveRequests/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/DiskActiveRequests/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "diskId": DiskID,
         "requests": [{
           "address": long,
           "drOp": string /* Internal */,
           "msecActive": int,
           "op": RequestOp,
           "prevState": string /* Internal */,
           "requestId": string,
           "requestIdx": int,
           "size": int,
           "state": string /* Internal */,
           "volume": Either(VolumeName, SnapshotName)
         }, ...]
       }
     }
     

   • Response Data: DiskActiveRequests
     • diskId: (DiskID)
     • requests: A detailed listing of all the requests associated with the given disk.
       Element type: ActiveRequestDesc
       • address: (long): The offset in bytes within the logical volume.
       • drOp: (Internal string): An internal attribute used only for debugging. We strongly recommend that you do not use this attribute in any kind of automation.
       • msecActive: (int): Time in microseconds since the request was submitted.
       • op: (RequestOp): The type of the requested operation; one of read, write, system, merge, entries flush, #bad_state, #bad_drOp
       • prevState: (Internal string): An internal attribute used only for debugging. We strongly recommend that you do not use this attribute in any kind of automation.
       • requestId: (string): A unique request ID that may be matched between clients and disks.
       • requestIdx: (int): A temporary local request identifier for this request on this client or disk.
       • size: (int): The size of the request in bytes.
       • state: (Internal string): An internal attribute used only for debugging. We strongly recommend that you do not use this attribute in any kind of automation.
       • volume: The value must be of one of the following types: VolumeName, SnapshotName.
         Subtypes:
         • VolumeName
         • SnapshotName

Volumes

List all volumes (VolumesList)

Return configuration information about all the volumes.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumesList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumesList
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int /* Internal */,
         "id": long /* Internal */,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "originalParentVolumeId": long /* Internal */,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long /* Internal */,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateId": long /* Internal */,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data:
     Element type: VolumeSummary
     • bw: (Bandwidth): Bandwidth limit in KB.
     • creationTimestamp: (long)
     • flags: (Internal int)
     • id: (Internal long)
     • iops: (IOPS): iops limit.
     • name: (VolumeName): The name of this volume.
     • objectsCount: (int): The number of objects that the volume/snapshot is comprised of.
     • originalParentVolumeId: (Internal long)
     • parentName: The volume/snapshot's parent snapshot.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • parentVolumeId: (Internal long): The ID of the parent snapshot.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Replication): The number of copies/replicas kept.
     • size: (Size): The volume/snapshots's size in bytes.
     • templateId: (Internal long)
     • templateName: The template that the volume/snapshot's settings are taken from.The value must be of one of the following types: "", VolumeTemplateName.
       Subtypes:
       • ""
       • VolumeTemplateName
     • visibleVolumeId: (long): The ID by which the volume/snapshot was created.

Get volume and snapshot status (VolumesGetStatus)

Return the status of each volume and snapshot.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumesGetStatus HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumesGetStatus
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "VolumeName": {
           "balancerBlocked": bool,
           "decreasedRedundancy": bool,
           "downBytes": int,
           "downDrives": [DiskID, ...],
           "migrating": bool,
           "missingDrives": [DiskID, ...],
           "missingTargetDrives": [DiskID, ...],
           "name": VolumeName,
           "onDiskSize": int,
           "replication": Replication,
           "size": Size,
           "snapshot": bool,
           "softEjectingDrives": [DiskID, ...],
           "status": VolumeCurentStatus,
           "storedSize": int,
           "syncingDataBytes": int,
           "syncingMetaObjects": int
         }, ...
       }
     }
     

   • Response Data: A dict from VolumeName to VolumeStatus
     • Key type: VolumeName
     • Value type: VolumeStatus
       • balancerBlocked: (bool)
       • decreasedRedundancy: (bool): True if any of the replicas of the volume are missing.
       • downBytes: (int): The number of bytes of the volume that are not accessible at the moment.
       • downDrives: The IDs of the drives that are not accessible at the moment but needed by this volume. The volume will be in the 'down' status until all or some of these drives reappear.
         Element type: DiskID
       • migrating: (bool): True if there are tasks for reallocation of the volume.
       • missingDrives: The IDs of the drives that are not accessible at the moment. The volume has all the needed data on the rest of the disks and can continue serving requests but it is in the 'degraded' status.
         Element type: DiskID
       • missingTargetDrives:
         Element type: DiskID
       • name: (VolumeName)
       • onDiskSize: (int): The actual size that the objects of this volume occupy on the disks.
       • replication: (Replication): The number of copies/replicas kept.
       • size: (Size): The volume's size in bytes.
       • snapshot: (bool): True if this response describes a snapshot instead of a volume.
       • softEjectingDrives:
         Element type: DiskID
       • status: (VolumeCurentStatus): up - The volume is operational. up soon - Synchronizing versions of objects after a disk has come back up. data lost - The last copy of some of the data in the volume has been lost. down - Some or all of the objects of the volume are missing and the volume is not in a state to continue serving operations.
       • storedSize: (int): The number of bytes of client data on the volume. This does not take into account the StorPool replication and overhead, thus it is never larger than the volume size.
       • syncingDataBytes: (int): The total number of bytes in objects currently being synchronized (degraded objects or objects with not yet known version)
       • syncingMetaObjects: (int): The number of objects currently being synchronized (degraded objects or objects with not yet known version)

List a single volume (Volume)

Same as VolumeList but only return information about a given volume.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/Volume/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/Volume/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int /* Internal */,
         "id": long /* Internal */,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "originalParentVolumeId": long /* Internal */,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long /* Internal */,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateId": long /* Internal */,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data:
     Element type: VolumeSummary
     • bw: (Bandwidth): Bandwidth limit in KB.
     • creationTimestamp: (long)
     • flags: (Internal int)
     • id: (Internal long)
     • iops: (IOPS): iops limit.
     • name: (VolumeName): The name of this volume.
     • objectsCount: (int): The number of objects that the volume/snapshot is comprised of.
     • originalParentVolumeId: (Internal long)
     • parentName: The volume/snapshot's parent snapshot.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • parentVolumeId: (Internal long): The ID of the parent snapshot.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Replication): The number of copies/replicas kept.
     • size: (Size): The volume/snapshots's size in bytes.
     • templateId: (Internal long)
     • templateName: The template that the volume/snapshot's settings are taken from.The value must be of one of the following types: "", VolumeTemplateName.
       Subtypes:
       • ""
       • VolumeTemplateName
     • visibleVolumeId: (long): The ID by which the volume/snapshot was created.

Describe a volume (VolumeDescribe)

Return detailed information about the distribution of the volume's data on the disks.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeDescribe/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeDescribe/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int /* Internal */,
         "id": long /* Internal */,
         "iops": IOPS,
         "name": VolumeName,
         "objects": [[DiskID, ...], ...],
         "objectsCount": int,
         "originalParentVolumeId": long /* Internal */,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long /* Internal */,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "targetDiskSets": [[DiskID, ...], ...],
         "templateId": long /* Internal */,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }
     }
     

   • Response Data: Volume
     • bw: (Bandwidth): Bandwidth limit in KB.
     • creationTimestamp: (long)
     • flags: (Internal int)
     • id: (Internal long)
     • iops: (IOPS): iops limit.
     • name: (VolumeName): The name of this volume.
     • objects: Where each object is actually stored.
       Element type:
       Element type: DiskID
     • objectsCount: (int): The number of objects that the volume/snapshot is comprised of.
     • originalParentVolumeId: (Internal long)
     • parentName: The volume/snapshot's parent snapshot.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • parentVolumeId: (Internal long): The ID of the parent snapshot.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Replication): The number of copies/replicas kept.
     • size: (Size): The volume/snapshots's size in bytes.
     • targetDiskSets: Sets of disks that the volume's data should be stored on.
       Element type:
       Element type: DiskID
     • templateId: (Internal long)
     • templateName: The template that the volume/snapshot's settings are taken from.The value must be of one of the following types: "", VolumeTemplateName.
       Subtypes:
       • ""
       • VolumeTemplateName
     • visibleVolumeId: (long): The ID by which the volume/snapshot was created.

Get volume info (VolumeGetInfo)

Return general information about the distribution of the volume's data on the disks.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeGetInfo/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeGetInfo/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "creationTimestamp": long,
         "disksCount": int,
         "flags": int /* Internal */,
         "id": long /* Internal */,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "objectsPerChain": [{
           "count": int,
           "disks": [DiskID, ...]
         }, ...],
         "objectsPerDisk": {
           "DiskID": int, ...
         },
         "objectsPerDiskSet": [{
           "count": int,
           "disks": [DiskID, ...]
         }, ...],
         "originalParentVolumeId": long /* Internal */,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long /* Internal */,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateId": long /* Internal */,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }
     }
     

   • Response Data: VolumeInfo
     • bw: (Bandwidth): Bandwidth limit in KB.
     • creationTimestamp: (long)
     • disksCount: (int)
     • flags: (Internal int)
     • id: (Internal long)
     • iops: (IOPS): iops limit.
     • name: (VolumeName): The name of this volume.
     • objectsCount: (int): The number of objects that the volume/snapshot is comprised of.
     • objectsPerChain:
       Element type: VolumeChainStat
       • count: (int): The number of objects on the disks.
       • disks: IDs of the disks.
         Element type: DiskID
     • objectsPerDisk: A dict from DiskID to int
       • Key type: DiskID
       • Value type: int
     • objectsPerDiskSet:
       Element type: VolumeChainStat
       • count: (int): The number of objects on the disks.
       • disks: IDs of the disks.
         Element type: DiskID
     • originalParentVolumeId: (Internal long)
     • parentName: The volume/snapshot's parent snapshot.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • parentVolumeId: (Internal long): The ID of the parent snapshot.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Replication): The number of copies/replicas kept.
     • size: (Size): The volume/snapshots's size in bytes.
     • templateId: (Internal long)
     • templateName: The template that the volume/snapshot's settings are taken from.The value must be of one of the following types: "", VolumeTemplateName.
       Subtypes:
       • ""
       • VolumeTemplateName
     • visibleVolumeId: (long): The ID by which the volume/snapshot was created.

List the parent snapshots of a volume (VolumeListSnapshots)

List a volume's parent snapshots in the same format as VolumeList

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeListSnapshots/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeListSnapshots/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int /* Internal */,
         "id": long /* Internal */,
         "iops": IOPS,
         "name": SnapshotName,
         "objectsCount": int,
         "onVolume": VolumeName,
         "originalParentVolumeId": long /* Internal */,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long /* Internal */,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateId": long /* Internal */,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data:
     Element type: SnapshotSummary
     • bw: (Bandwidth): Bandwidth limit in KB.
     • creationTimestamp: (long)
     • flags: (Internal int)
     • id: (Internal long)
     • iops: (IOPS): iops limit.
     • name: (SnapshotName): The name of this snapshot
     • objectsCount: (int): The number of objects that the volume/snapshot is comprised of.
     • onVolume: (VolumeName): The name of the volume that this is a parent of.
     • originalParentVolumeId: (Internal long)
     • parentName: The volume/snapshot's parent snapshot.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • parentVolumeId: (Internal long): The ID of the parent snapshot.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Replication): The number of copies/replicas kept.
     • size: (Size): The volume/snapshots's size in bytes.
     • templateId: (Internal long)
     • templateName: The template that the volume/snapshot's settings are taken from.The value must be of one of the following types: "", VolumeTemplateName.
       Subtypes:
       • ""
       • VolumeTemplateName
     • visibleVolumeId: (long): The ID by which the volume/snapshot was created.

Create a new volume (VolumeCreate)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeCreate HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "baseOn": VolumeName /* Optional */,
       "bw": Bandwidth /* Optional */,
       "iops": IOPS /* Optional */,
       "name": VolumeName,
       "parent": SnapshotName /* Optional */,
       "placeAll": PlacementGroupName /* Optional */,
       "placeTail": PlacementGroupName /* Optional */,
       "replication": Replication /* Optional */,
       "size": Size /* Optional */,
       "template": VolumeTemplateName /* Optional */
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeCreate
   • Arguments: No arguments
   • JSON: VolumeCreateDesc
     • baseOn: (Optional VolumeName): The name of an already existing volume that the new volume is to be a copy of.
     • bw: (Optional Bandwidth): Bandwidth limit in KB.
     • iops: (Optional IOPS): iops limit.
     • name: (VolumeName): The name of the volume to be created.
     • parent: (Optional SnapshotName): The name of the snapshot that the new volume is based on.
     • placeAll: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Optional Replication): The number of copies/replicas kept.
     • size: (Optional Size): The volume's size in bytes.
     • template: (Optional VolumeTemplateName): The name of the template that the settings of the new volume are based on.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Update a volume (VolumeUpdate)

Alter the configuration of an existing volume.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeUpdate/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bw": Bandwidth /* Optional */,
       "iops": IOPS /* Optional */,
       "placeAll": PlacementGroupName /* Optional */,
       "placeTail": PlacementGroupName /* Optional */,
       "rename": VolumeName /* Optional */,
       "replication": Replication /* Optional */,
       "shrinkOk": bool /* Optional */,
       "size": Size /* Optional */,
       "sizeAdd": SizeAdd /* Optional */,
       "template": VolumeTemplateName /* Optional */
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeUpdate/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: VolumeUpdateDesc
     • bw: (Optional Bandwidth): Bandwidth limit in KB.
     • iops: (Optional IOPS): iops limit.
     • placeAll: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • rename: (Optional VolumeName): The new name to be set.
     • replication: (Optional Replication): The number of copies/replicas kept.
     • shrinkOk: (Optional bool)
     • size: (Optional Size): The new size in bytes.
     • sizeAdd: (Optional SizeAdd): The number of bytes that the volume's size should be increased by.
     • template: (Optional VolumeTemplateName): The new template that the volume's settings should be based on.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Freeze a volume (VolumeFreeze)

Convert the volume to a snapshot

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeFreeze/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeFreeze/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Rebase a volume (VolumeRebase)

Change the parent of the volume by choosing from the ones higher in the hierarchy or by rebasing it to no parent.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeRebase/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "parentName": SnapshotName /* Optional */
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeRebase/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: VolumeRebaseDesc
     • parentName: (Optional SnapshotName): The name of one of the volume's parents on which to re-base. If left out, it will be re-based to base.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Abandon disk (VolumeAbandonDisk)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeAbandonDisk/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "diskId": DiskID
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeAbandonDisk/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: AbandonDiskDesc
     • diskId: (DiskID): the disk to abandon.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Delete a volume (VolumeDelete)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeDelete/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeDelete/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Snapshots

Snapshots in their essence are very similar to volumes in the sense that many operations supported by volumes are also supported by snapshots (all except write-related operations). They can not be modified and play an essential role in copy-on-write scenarios.

List all snapshots (SnapshotsList)

List all the snapshots in the cluster in the same format as VolumeList.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/SnapshotsList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/SnapshotsList
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int /* Internal */,
         "id": long /* Internal */,
         "iops": IOPS,
         "name": SnapshotName,
         "objectsCount": int,
         "onVolume": VolumeName,
         "originalParentVolumeId": long /* Internal */,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long /* Internal */,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateId": long /* Internal */,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data:
     Element type: SnapshotSummary
     • bw: (Bandwidth): Bandwidth limit in KB.
     • creationTimestamp: (long)
     • flags: (Internal int)
     • id: (Internal long)
     • iops: (IOPS): iops limit.
     • name: (SnapshotName): The name of this snapshot
     • objectsCount: (int): The number of objects that the volume/snapshot is comprised of.
     • onVolume: (VolumeName): The name of the volume that this is a parent of.
     • originalParentVolumeId: (Internal long)
     • parentName: The volume/snapshot's parent snapshot.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • parentVolumeId: (Internal long): The ID of the parent snapshot.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Replication): The number of copies/replicas kept.
     • size: (Size): The volume/snapshots's size in bytes.
     • templateId: (Internal long)
     • templateName: The template that the volume/snapshot's settings are taken from.The value must be of one of the following types: "", VolumeTemplateName.
       Subtypes:
       • ""
       • VolumeTemplateName
     • visibleVolumeId: (long): The ID by which the volume/snapshot was created.

List a single snapshot (Snapshot)

Same as SnapshotList but only return information about a given snapshot.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/Snapshot/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/Snapshot/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: a string(200), matching ^\*?[A-Za-z0-9_\-.:@]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int /* Internal */,
         "id": long /* Internal */,
         "iops": IOPS,
         "name": SnapshotName,
         "objectsCount": int,
         "onVolume": VolumeName,
         "originalParentVolumeId": long /* Internal */,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long /* Internal */,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateId": long /* Internal */,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data:
     Element type: SnapshotSummary
     • bw: (Bandwidth): Bandwidth limit in KB.
     • creationTimestamp: (long)
     • flags: (Internal int)
     • id: (Internal long)
     • iops: (IOPS): iops limit.
     • name: (SnapshotName): The name of this snapshot
     • objectsCount: (int): The number of objects that the volume/snapshot is comprised of.
     • onVolume: (VolumeName): The name of the volume that this is a parent of.
     • originalParentVolumeId: (Internal long)
     • parentName: The volume/snapshot's parent snapshot.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • parentVolumeId: (Internal long): The ID of the parent snapshot.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Replication): The number of copies/replicas kept.
     • size: (Size): The volume/snapshots's size in bytes.
     • templateId: (Internal long)
     • templateName: The template that the volume/snapshot's settings are taken from.The value must be of one of the following types: "", VolumeTemplateName.
       Subtypes:
       • ""
       • VolumeTemplateName
     • visibleVolumeId: (long): The ID by which the volume/snapshot was created.

Describe a snapshot (SnapshotDescribe)

Return detailed information about the distribution of the snapshot's data on the disks.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/SnapshotDescribe/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/SnapshotDescribe/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: a string(200), matching ^\*?[A-Za-z0-9_\-.:@]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int /* Internal */,
         "id": long /* Internal */,
         "iops": IOPS,
         "name": VolumeName,
         "objects": [[DiskID, ...], ...],
         "objectsCount": int,
         "originalParentVolumeId": long /* Internal */,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long /* Internal */,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "targetDiskSets": [[DiskID, ...], ...],
         "templateId": long /* Internal */,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }
     }
     

   • Response Data: Volume
     • bw: (Bandwidth): Bandwidth limit in KB.
     • creationTimestamp: (long)
     • flags: (Internal int)
     • id: (Internal long)
     • iops: (IOPS): iops limit.
     • name: (VolumeName): The name of this volume.
     • objects: Where each object is actually stored.
       Element type:
       Element type: DiskID
     • objectsCount: (int): The number of objects that the volume/snapshot is comprised of.
     • originalParentVolumeId: (Internal long)
     • parentName: The volume/snapshot's parent snapshot.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • parentVolumeId: (Internal long): The ID of the parent snapshot.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Replication): The number of copies/replicas kept.
     • size: (Size): The volume/snapshots's size in bytes.
     • targetDiskSets: Sets of disks that the volume's data should be stored on.
       Element type:
       Element type: DiskID
     • templateId: (Internal long)
     • templateName: The template that the volume/snapshot's settings are taken from.The value must be of one of the following types: "", VolumeTemplateName.
       Subtypes:
       • ""
       • VolumeTemplateName
     • visibleVolumeId: (long): The ID by which the volume/snapshot was created.

Get snapshot info (SnapshotGetInfo)

Return general information about the distribution of the snapshot's data on the disks.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/SnapshotGetInfo/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/SnapshotGetInfo/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: a string(200), matching ^\*?[A-Za-z0-9_\-.:@]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "creationTimestamp": long,
         "disksCount": int,
         "flags": int /* Internal */,
         "id": long /* Internal */,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "objectsPerChain": [{
           "count": int,
           "disks": [DiskID, ...]
         }, ...],
         "objectsPerDisk": {
           "DiskID": int, ...
         },
         "objectsPerDiskSet": [{
           "count": int,
           "disks": [DiskID, ...]
         }, ...],
         "originalParentVolumeId": long /* Internal */,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long /* Internal */,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateId": long /* Internal */,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }
     }
     

   • Response Data: VolumeInfo
     • bw: (Bandwidth): Bandwidth limit in KB.
     • creationTimestamp: (long)
     • disksCount: (int)
     • flags: (Internal int)
     • id: (Internal long)
     • iops: (IOPS): iops limit.
     • name: (VolumeName): The name of this volume.
     • objectsCount: (int): The number of objects that the volume/snapshot is comprised of.
     • objectsPerChain:
       Element type: VolumeChainStat
       • count: (int): The number of objects on the disks.
       • disks: IDs of the disks.
         Element type: DiskID
     • objectsPerDisk: A dict from DiskID to int
       • Key type: DiskID
       • Value type: int
     • objectsPerDiskSet:
       Element type: VolumeChainStat
       • count: (int): The number of objects on the disks.
       • disks: IDs of the disks.
         Element type: DiskID
     • originalParentVolumeId: (Internal long)
     • parentName: The volume/snapshot's parent snapshot.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • parentVolumeId: (Internal long): The ID of the parent snapshot.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Replication): The number of copies/replicas kept.
     • size: (Size): The volume/snapshots's size in bytes.
     • templateId: (Internal long)
     • templateName: The template that the volume/snapshot's settings are taken from.The value must be of one of the following types: "", VolumeTemplateName.
       Subtypes:
       • ""
       • VolumeTemplateName
     • visibleVolumeId: (long): The ID by which the volume/snapshot was created.

Snapshot a volume (VolumeSnapshot)

Create a snapshot of the given volume; the snapshot becomes the parent of the volume.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeSnapshot/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bind": bool /* Optional */,
       "name": VolumeName /* Optional */
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeSnapshot/{volumeName}
   • Arguments:
     • volumeName - VolumeName: a string(200), matching ^\#?[A-Za-z0-9_\-.:]+$, except {list, status}
   • JSON: VolumeSnapshotDesc
     • bind: (Optional bool): If true, the lifetime of the newly created snapshot will be bound to the lifetime of its children. As soon as it remains childless the snapshot will be garbage-collected.
     • name: (Optional VolumeName): The name of the newly created snapshot. If not specified, a name will be auto-generated by the StorPool management service.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Update a snapshot (SnapshotUpdate)

Alter the configuration of an existing snapshot.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/SnapshotUpdate/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bind": bool /* Optional */,
       "bw": Bandwidth /* Optional */,
       "iops": IOPS /* Optional */,
       "placeAll": PlacementGroupName /* Optional */,
       "placeTail": PlacementGroupName /* Optional */,
       "rename": VolumeName /* Optional */,
       "replication": Replication /* Optional */
     }

   • Method: POST
   • Path: /ctrl/1.0/SnapshotUpdate/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: a string(200), matching ^\*?[A-Za-z0-9_\-.:@]+$, except {list, status}
   • JSON: SnapshotUpdateDesc
     • bind: (Optional bool): When true bind this snapshot, when false - unbind it. If not set or missing - no change.
     • bw: (Optional Bandwidth): Bandwidth limit in KB.
     • iops: (Optional IOPS): iops limit.
     • placeAll: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • rename: (Optional VolumeName): The new name to be set.
     • replication: (Optional Replication): The number of copies/replicas kept.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Rebase a snapshot (SnapshotRebase)

Change the parent of the snapshot by choosing from the ones higher in the hierarchy or by rebasing it to no parent.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/SnapshotRebase/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "parentName": SnapshotName /* Optional */
     }

   • Method: POST
   • Path: /ctrl/1.0/SnapshotRebase/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: a string(200), matching ^\*?[A-Za-z0-9_\-.:@]+$, except {list, status}
   • JSON: VolumeRebaseDesc
     • parentName: (Optional SnapshotName): The name of one of the volume's parents on which to re-base. If left out, it will be re-based to base.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Abandon disk (VolumeAbandonDisk)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeAbandonDisk/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "diskId": DiskID
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeAbandonDisk/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: a string(200), matching ^\*?[A-Za-z0-9_\-.:@]+$, except {list, status}
   • JSON: AbandonDiskDesc
     • diskId: (DiskID): the disk to abandon.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Delete a snapshot (SnapshotDelete)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/SnapshotDelete/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/SnapshotDelete/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: a string(200), matching ^\*?[A-Za-z0-9_\-.:@]+$, except {list, status}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Attachments

List all attachments (AttachmentsList)

List the volumes and snapshots currently attached to clients along with the read/write rights of each attachment.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/AttachmentsList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/AttachmentsList
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "client": ClientID,
         "pos": AttachmentPos,
         "rights": AttachmentRights,
         "snapshot": bool,
         "volume": VolumeName
       }, ...]
     }
     

   • Response Data:
     Element type: AttachmentDesc
     • client: (ClientID): The ID of the client on which it is attached.
     • pos: (AttachmentPos): The attachment position on the client; used by the StorPool client to form the name of the internal /dev/spN device node.
     • rights: (AttachmentRights): Whether the volume is attached as read only or read/write; always ro for snapshots.
     • snapshot: (bool): Whether it is a snapshot or a volume.
     • volume: (VolumeName)

Reassign volumes and/or snapshots (VolumesReassign)

Perform bulk attach/detach and attachment rights modification.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumesReassign HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     [Either({
       "detach": Either("all", [ClientID, ...]) /* Optional */,
       "force": bool, default=false,
       "ro": [ClientID, ...] /* Optional */,
       "rw": [ClientID, ...] /* Optional */,
       "volume": VolumeName
     }, {
       "detach": Either("all", [ClientID, ...]) /* Optional */,
       "force": bool, default=false,
       "ro": [ClientID, ...] /* Optional */,
       "snapshot": SnapshotName
     }), ...]

   • Method: POST
   • Path: /ctrl/1.0/VolumesReassign
   • Arguments: No arguments
   • JSON:
     Element type: The value must be of one of the following types: VolumeReassignDesc, SnapshotReassignDesc.
     Subtypes:
     • VolumeReassignDesc
       • detach: (Optional Either("all", [ClientID])): The clients from which to detach the given volume.
       • force: (bool, default=false): Whether to force detaching of open volumes.
       • ro: (Optional [ClientID]): The clients on which to attach the volume as read only.
       • rw: (Optional [ClientID]): The clients on which to attach the volume as read/write.
       • volume: (VolumeName): The name of the volume to be reassigned.
     • SnapshotReassignDesc
       • detach: (Optional Either("all", [ClientID])): The clients from which to detach the given snapshot.
       • force: (bool, default=false): Whether to force detaching of open snapshots.
       • ro: (Optional [ClientID]): The clients on which to attach the snapshot.
       • snapshot: (SnapshotName): The name of the snapshot which should be reassigned.
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Placement Groups

Placement groups provide a way to specify the disks on which a volume's data should be stored.

List all placement groups (PlacementGroupsList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/PlacementGroupsList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/PlacementGroupsList
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "PlacementGroupName": {
           "disks": [DiskID, ...],
           "id": int /* Internal */,
           "name": PlacementGroupName,
           "servers": [ServerID, ...]
         }, ...
       }
     }
     

   • Response Data: A dict from PlacementGroupName to PlacementGroup
     • Key type: PlacementGroupName
     • Value type: PlacementGroup
       • disks: IDs of the participating disks.
         Element type: DiskID
       • id: (Internal int)
       • name: (PlacementGroupName)
       • servers: IDs of the participating servers.
         Element type: ServerID

Describe a single placement group (PlacementGroupDescribe)

Same as PlacementGroupsList but only return information about a given group.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/PlacementGroupDescribe/{placementGroupName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/PlacementGroupDescribe/{placementGroupName}
   • Arguments:
     • placementGroupName - PlacementGroupName: a string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "disks": [DiskID, ...],
         "id": int /* Internal */,
         "name": PlacementGroupName,
         "servers": [ServerID, ...]
       }
     }
     

   • Response Data: PlacementGroup
     • disks: IDs of the participating disks.
       Element type: DiskID
     • id: (Internal int)
     • name: (PlacementGroupName)
     • servers: IDs of the participating servers.
       Element type: ServerID

Create and/or update a placement group (PlacementGroupUpdate)

If a group by the specified name does not exist, it will be created.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/PlacementGroupUpdate/{placementGroupName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "addDisks": [DiskID, ...],
       "addServers": [ServerID, ...],
       "rename": PlacementGroupName /* Optional */,
       "rmDisks": [DiskID, ...],
       "rmServers": [ServerID, ...]
     }

   • Method: POST
   • Path: /ctrl/1.0/PlacementGroupUpdate/{placementGroupName}
   • Arguments:
     • placementGroupName - PlacementGroupName: a string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
   • JSON: PlacementGroupUpdateDesc
     • addDisks: IDs of the disks to add to this group.
       Element type: DiskID
     • addServers: IDs of the servers to add to this group. (This will add all the accessible disks of these servers)
       Element type: ServerID
     • rename: (Optional PlacementGroupName): The new name of the placement group.
     • rmDisks: IDs of the disks to be removed from this group.
       Element type: DiskID
     • rmServers: IDs of the servers to be removed from this group.
       Element type: ServerID
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Delete a placement group (PlacementGroupDelete)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/PlacementGroupDelete/{placementGroupName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/PlacementGroupDelete/{placementGroupName}
   • Arguments:
     • placementGroupName - PlacementGroupName: a string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Volume Templates

Templates are a set of rules used for creating many similar volumes.

List all volume templates (VolumeTemplatesList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeTemplatesList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeTemplatesList
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "id": int /* Internal */,
         "iops": IOPS,
         "name": VolumeTemplateName,
         "parentName": Either("", SnapshotName),
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Either("-", Replication),
         "size": Either("-", Size)
       }, ...]
     }
     

   • Response Data:
     Element type: VolumeTemplateDesc
     • bw: (Bandwidth): Bandwidth limit in KB.
     • id: (Internal int)
     • iops: (IOPS): iops limit.
     • name: (VolumeTemplateName): The name of the template.
     • parentName: The name of the snapshot on which volumes will be based.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: A default number of copies to be kept by StorPool.The value must be of one of the following types: "-", Replication.
       Subtypes:
       • "-"
       • Replication
     • size: A default size for the volumes (in bytes).The value must be of one of the following types: "-", Size.
       Subtypes:
       • "-"
       • Size

List the status of all volume templates (VolumeTemplatesStatus)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeTemplatesStatus HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeTemplatesStatus
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "availablePlaceAll": long,
         "availablePlaceTail": long,
         "id": int /* Internal */,
         "name": VolumeTemplateName,
         "onDiskSize": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "removingSnapshotsCount": int,
         "replication": Either("-", Replication),
         "size": Either(0, Size),
         "snapshotsCount": int,
         "storedSize": long,
         "totalSize": Either(0, Size),
         "volumesCount": int
       }, ...]
     }
     

   • Response Data:
     Element type: VolumeTemplateStatusDesc
     • availablePlaceAll: (long): An estimate of the available space on all the disks in this template's placeAll placement group.
     • availablePlaceTail: (long): An estimate of the available space on all the disks in this template's placeTail placement group.
     • id: (Internal int)
     • name: (VolumeTemplateName): The name of the template.
     • onDiskSize: (long): The actual on-disk number of bytes occupied by all the volumes based on this template.
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • removingSnapshotsCount: (int): The number of snapshots based on this template currently being deleted.
     • replication: The number of copies to be kept by StorPool if defined for this template, otherwise "-".The value must be of one of the following types: "-", Replication.
       Subtypes:
       • "-"
       • Replication
     • size: The number of bytes of all volumes based on this template, not counting the StorPool replication and checksums overhead.The value must be of one of the following types: 0, Size.
       Subtypes:
       • 0
       • Size
     • snapshotsCount: (int): The number of snapshots based on this template (incl. snapshots currently being deleted).
     • storedSize: (long): The number of bytes of client data on all the volumes based on this template. This does not take into account the StorPool replication and overhead, thus it is never larger than the volume size.
     • totalSize: The number of bytes of all volumes based on this template, including the StorPool replication overhead.The value must be of one of the following types: 0, Size.
       Subtypes:
       • 0
       • Size
     • volumesCount: (int): The number of volumes based on this template.

Describe a single volume template (VolumeTemplateDescribe)

Same as VolumeTemplatesList but only return information about a given template.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeTemplateDescribe/{templateName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeTemplateDescribe/{templateName}
   • Arguments:
     • templateName - VolumeTemplateName: a string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "id": int /* Internal */,
         "iops": IOPS,
         "name": VolumeTemplateName,
         "parentName": Either("", SnapshotName),
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Either("-", Replication),
         "size": Either("-", Size)
       }
     }
     

   • Response Data: VolumeTemplateDesc
     • bw: (Bandwidth): Bandwidth limit in KB.
     • id: (Internal int)
     • iops: (IOPS): iops limit.
     • name: (VolumeTemplateName): The name of the template.
     • parentName: The name of the snapshot on which volumes will be based.The value must be of one of the following types: "", SnapshotName.
       Subtypes:
       • ""
       • SnapshotName
     • placeAll: (PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: A default number of copies to be kept by StorPool.The value must be of one of the following types: "-", Replication.
       Subtypes:
       • "-"
       • Replication
     • size: A default size for the volumes (in bytes).The value must be of one of the following types: "-", Size.
       Subtypes:
       • "-"
       • Size

Create a volume template (VolumeTemplateCreate)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeTemplateCreate HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bw": Bandwidth /* Optional */,
       "iops": IOPS /* Optional */,
       "name": VolumeTemplateName,
       "parent": SnapshotName /* Optional */,
       "placeAll": PlacementGroupName /* Optional */,
       "placeTail": PlacementGroupName /* Optional */,
       "replication": Replication /* Optional */,
       "size": Size /* Optional */
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeTemplateCreate
   • Arguments: No arguments
   • JSON: VolumeTemplateCreateDesc
     • bw: (Optional Bandwidth): Bandwidth limit in KB.
     • iops: (Optional IOPS): iops limit.
     • name: (VolumeTemplateName)
     • parent: (Optional SnapshotName): The name of the snapshot on which to base volumes created by this template.
     • placeAll: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • replication: (Optional Replication): The number of copies/replicas kept.
     • size: (Optional Size): A default size for the volumes (in bytes).
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Update a volume template (VolumeTemplateUpdate)

Alter the configuration of an existing volume template.

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeTemplateUpdate/{templateName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bw": Bandwidth /* Optional */,
       "iops": IOPS /* Optional */,
       "parent": SnapshotName /* Optional */,
       "placeAll": PlacementGroupName /* Optional */,
       "placeTail": PlacementGroupName /* Optional */,
       "propagate": bool /* Optional */,
       "rename": VolumeTemplateName /* Optional */,
       "replication": Replication /* Optional */,
       "size": Size /* Optional */
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeTemplateUpdate/{templateName}
   • Arguments:
     • templateName - VolumeTemplateName: a string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
   • JSON: VolumeTemplateUpdateDesc
     • bw: (Optional Bandwidth): Bandwidth limit in KB.
     • iops: (Optional IOPS): iops limit.
     • parent: (Optional SnapshotName): The name of the snapshot on which to base volumes created by this template.
     • placeAll: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for all but the last replica.
     • placeTail: (Optional PlacementGroupName): The name of a placement group which describes the disks to be used for the last replica, the one used for reading.
     • propagate: (Optional bool): Whether to propagate this change to all the volumes and snapshots using this template.
     • rename: (Optional VolumeTemplateName): The new name of the template.
     • replication: (Optional Replication): The number of copies/replicas kept.
     • size: (Optional Size): A default size for the volumes (in bytes).
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Delete a volume template (VolumeTemplateDelete)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeTemplateDelete/{templateName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeTemplateDelete/{templateName}
   • Arguments:
     • templateName - VolumeTemplateName: a string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Volume Relocator

This is a service that moves data when needed, e.g. when removing or adding disks.

Turn the relocator on (VolumeRelocatorOn)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeRelocatorOn HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeRelocatorOn
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Turn the relocator off (VolumeRelocatorOff)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeRelocatorOff HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeRelocatorOff
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Get the relocator's status (VolumeRelocatorStatus)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeRelocatorStatus HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeRelocatorStatus
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "status": RelocatorStatus
       }
     }
     

   • Response Data: VolumeRelocatorStatus
     • status: (RelocatorStatus)

Balancer

This is a service that decides when it is a good time to move data.

Turn the balancer on (VolumeBalancerOn)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeBalancerOn HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeBalancerOn
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Turn the balancer off (VolumeBalancerOff)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeBalancerOff HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeBalancerOff
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: (long): The cluster generation based on the number of configuration changes since the cluster was created.
     • ok: (true): Always returns true. If something goes wrong, an ApiError is returned instead.

Get the balancer's status (VolumeBalancerStatus)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeBalancerStatus HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeBalancerStatus
   • Arguments: No arguments
   • JSON: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "status": BalancerStatus
       }
     }
     

   • Response Data: VolumeBalancerStatus
     • status: (BalancerStatus)

Data Types