Skip to content

Latest commit

 

History

History
235 lines (137 loc) · 6.17 KB

VolumeApi.md

File metadata and controls

235 lines (137 loc) · 6.17 KB
Raw

\VolumeApi

All URIs are relative to http://localhost

Method HTTP request Description
VolumeBind Post /1.4/volumes/{volume}/bind
VolumeCreate Post /1.4/volumes
VolumeDelete Delete /1.4/volumes/{volume}
VolumeGet Get /1.4/volumes/{volume}
VolumeList Get /1.4/volumes
VolumePlansList Get /1.4/volumeplans
VolumeUnbind Delete /1.4/volumes/{volume}/bind
VolumeUpdate Put /1.4/volumes/{volume}

VolumeBind

VolumeBind(ctx, volume, volumeBindData)

Bind volume.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
volume string Volume name.
volumeBindData VolumeBindData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumeCreate

VolumeCreate(ctx, volume)

Create volume.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
volume Volume

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumeDelete

VolumeDelete(ctx, volume)

Delete volume.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
volume string Volume name.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumeGet

Volume VolumeGet(ctx, volume)

Get a volume.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
volume string Volume name.

Return type

Volume

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumeList

[]Volume VolumeList(ctx, )

List volumes.

Required Parameters

This endpoint does not need any parameter.

Return type

[]Volume

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumePlansList

map[string]VolumePlan VolumePlansList(ctx, )

List volume plans.

Required Parameters

This endpoint does not need any parameter.

Return type

map[string]VolumePlan

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumeUnbind

VolumeUnbind(ctx, volume, volumeBindData)

Unbind volume.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
volume string Volume name.
volumeBindData VolumeBindData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumeUpdate

VolumeUpdate(ctx, volume, volumeUpdateData)

Update volume.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
volume string Volume name.
volumeUpdateData VolumeUpdateData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]