Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-176940115.5 KB
Pool

Lists information for all block storage pool.

get/v1beta/{tenantId}/pools

Query parameters

limitinteger

Number of query results on multiple pages

offsetinteger

Start position of the pagination query

sortDir'asc' | 'desc'

Ascending or descending

sortKeystring

Sorting key word, such as name, createdAt

storageType'block' | 'file' | 'object'
namestring

Response

OK

idstring
createdAtstring date-time
updatedAtstring date-time
namestring required
storageType'block' | 'file' | 'object'
descriptionstring
multiAttachboolean
status'available' | 'unavailable' required
availabilityZonestring required
totalCapacityinteger required
freeCapacityinteger required
dockIdstring required

Example response

[
  {
    "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
    "createdAt": "2017-07-10T14:36:58.014Z",
    "updatedAt": "2017-07-10T14:36:58.014Z",
    "dockId": "f4a5e666-c669-4c64-a2a1-8f9ecd560c78",
    "extras": {
      "dataStorage": {
        "recoveryTimeObjective": 10,
        "characterCodeSet": "ASCII",
        "maxFileNameLengthBytes": 255
      },
      "ioConnectivity": {
        "accessProtocol": "iscsi",
        "maxIOPS": 150,
        "minIOPS": 50,
        "maxBWS": 5,
        "minBWS": 1,
        "latency": 1
      },
      "dataProtection": {
        "isIsolated": true,
        "minLifetime": "P3Y6M4DT12H30M5S",
        "RecoveryGeographicObjective": "datacenter",
        "RecoveryPointObjectiveTime": "P3Y6M4DT12H30M5S",
        "RecoveryTimeObjective": "offline",
        "ReplicaType": "snapshot"
      },
      "customProperties": {
        "key1": "value1",
        "key2": false,
        "key3": {
          "key31": "value31"
        }
      }
    }
  }
]