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

Dock

Lists information for all storage docks.

get/v1beta/{tenantId}/docks

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'

type'provisioner' | 'attacher'

status'available' | 'unavailable'

namestring

Response

idstring

createdAtstring date-time

updatedAtstring date-time

type'provisioner' | 'attacher'

namestring required

descriptionstring

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

status'available' | 'unavailable' required

endpointstring required

nodeIdstring required

metadataobject

Example response

[
  {
    "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
    "createdAt": "2017-07-10T14:36:58.014Z",
    "updatedAt": "2017-07-10T14:36:58.014Z",
    "endpoint": "0.0.0.0:50050",
    "nodeId": "127.0.0.1"
  }
]

Changes

Changed in 3 of the 50 revisions of this API.4812

Feb 3, 2020f797fa1d87f78See 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 status
  new-optional-request-parameter
- ○
  added the new optional query request parameter storageType
  new-optional-request-parameter
- ○
  added the new optional query request parameter type
  new-optional-request-parameter
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, 20183a7682f5369d48See 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 status
  request-parameter-removed
- ●
  deleted the query request parameter storageType
  request-parameter-removed
- ●
  deleted the query request parameter type
  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