GET /v1beta/:tenantId/pools — soda-api

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

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"
        }
      }
    }
  }
]

Changes

Changed in 6 of the 50 revisions of this API.61023

Feb 3, 2020f797fa1d87f76See the full diff
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the new optional query request parameter name
  new-optional-request-parameter
- ○
  added the new optional query request parameter offset
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortDir
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortKey
  new-optional-request-parameter
- ○
  added the new optional query request parameter storageType
  new-optional-request-parameter
Dec 5, 20190d720ad6985a25See the full diff
- ●
  added the new DSWare enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new nvmeof enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value thick was added for the status
  response-property-default-value-added
- ○
  removed the DSWARE enum value from the //// response property for the response status
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 22, 2019a41e1157d0e7213See the full diff
- ▲
  the response property //// became optional for the status
  response-property-became-optional
- ▲
  the //// response's property type changed from string to array for status
  response-property-type-changed
- ●
  added the new NFS enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  removed the Execute enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the Read enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the Write enum value from the //// response property for the response status
  response-property-enum-value-removed
Nov 20, 201964d46542013a15See the full diff
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 6, 2019fd0669e1e56f4See the full diff
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 4, 20183a7682f5369d46See the full diff
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ●
  deleted the query request parameter limit
  request-parameter-removed
- ●
  deleted the query request parameter name
  request-parameter-removed
- ●
  deleted the query request parameter offset
  request-parameter-removed
- ●
  deleted the query request parameter sortDir
  request-parameter-removed
- ●
  deleted the query request parameter sortKey
  request-parameter-removed
- ●
  deleted the query request parameter storageType
  request-parameter-removed
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history