@itentialopensource/adapter-openstack_cinder
Version:
This adapter integrates with system described as: Openstack Block Storage (Cinder) Service
1,835 lines (1,833 loc) • 205 kB
YAML
openapi: 3.0.0
info:
title: Openstack Cinder API
contact: {}
version: '1.0'
servers:
- url: http://{host}:{port}
description: Block Storage service (cinder) administrative endpoint
variables:
host:
default: localhost
port:
default: '8776'
paths:
/:
get:
tags:
- API versions
summary: listAllApiVersions
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-all-api-versions
operationId: listAllApiVersions
parameters: []
responses:
'300':
description: The resource corresponds to more than one representation.
headers: {}
content: {}
'400':
description: Some content in the request was invalid.
headers: {}
content: {}
'401':
description: User must authenticate before making a request.
headers: {}
content: {}
'403':
description: Policy does not allow current user to do this operation.
headers: {}
content: {}
'404':
description: The requested resource could not be found.
headers: {}
content: {}
'405':
description: Method is not valid for this endpoint and resource.
headers: {}
content: {}
'409':
description: This resource has an action in progress that would conflict with this request.
headers: {}
content: {}
'500':
description: >-
Something went wrong with the service which prevents it from fulfilling
the request.
headers: {}
content: {}
'503':
description: The service cannot handle the request right now.
headers: {}
content: {}
deprecated: false
/v3/:
get:
tags:
- API version details
summary: showAPIV3Details
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-api-v3-details
operationId: showAPIV3Details
parameters: []
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'403':
description: Policy does not allow current user to do this operation.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/extensions:
get:
tags:
- API extensions (extensions)
summary: listKnownAPIExtensions
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-known-api-extensions
operationId: listKnownAPIExtensions
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'300':
description: The resource corresponds to more than one representation.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types/{volume_type_id}:
put:
tags:
- Volume types (types)
summary: updateAVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-a-volume-type
operationId: updateAVolumeType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3TypesRequest'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
get:
tags:
- Volume types (types)
summary: showVolumeTypeDetail
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-volume-type-detail
operationId: showVolumeTypeDetail
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Volume types (types)
summary: deleteAVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-a-volume-type
operationId: deleteAVolumeType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'202':
description: Request is accepted, but processing may take some time.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types/{volume_type_id}/extra_specs:
post:
tags:
- Volume types (types)
summary: createOrUpdateExtraSpecsForVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-or-update-extra-specs-for-volume-type
operationId: createOrUpdateExtraSpecsForVolumeType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3TypesExtraSpecsRequest'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
get:
tags:
- Volume types (types)
summary: showAllExtraSpecificationsForVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-all-extra-specifications-for-volume-type
operationId: showAllExtraSpecificationsForVolumeType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types/{volume_type_id}/extra_specs/{key}:
get:
tags:
- Volume types (types)
summary: showExtraSpecificationForVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-extra-specification-for-volume-type
operationId: showExtraSpecificationForVolumeType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: key
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
put:
tags:
- Volume types (types)
summary: updateExtraSpecificationForVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-extra-specification-for-volume-type
operationId: updateExtraSpecificationForVolumeType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: key
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3TypesExtraSpecsKeyRequest'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Volume types (types)
summary: deleteExtraSpecificationForVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-extra-specification-for-volume-type
operationId: deleteExtraSpecificationForVolumeType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: key
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'202':
description: Request is accepted, but processing may take some time.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types/default:
get:
tags:
- Volume types (types)
summary: showDefaultVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-default-volume-type
operationId: showDefaultVolumeType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'404':
description: The requested resource could not be found.
headers: {}
content: {}
'500':
description: >-
Something went wrong with the service which prevents it from fulfilling
the request.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types:
get:
tags:
- Volume types (types)
summary: listAllVolumeTypes
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-all-volume-types
operationId: listAllVolumeTypes
parameters:
- name: is_public
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: marker
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
post:
tags:
- Volume types (types)
summary: createAVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-a-volume-type
operationId: createAVolumeType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3TypesRequest1'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types/{volume_type_id}/encryption:
get:
tags:
- Volume types (types)
summary: showAnEncryptionType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-an-encryption-type
operationId: showAnEncryptionType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
post:
tags:
- Volume types (types)
summary: createAnEncryptionType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-an-encryption-type
operationId: createAnEncryptionType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3TypesEncryptionRequest'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types/{volume_type_id}/encryption/{key}:
get:
tags:
- Volume types (types)
summary: showEncryptionSpecsItem
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-encryption-specs-item
operationId: showEncryptionSpecsItem
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: key
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types/{volume_type_id}/encryption/{encryption_id}:
delete:
tags:
- Volume types (types)
summary: deleteAnEncryptionType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-an-encryption-type
operationId: deleteAnEncryptionType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: encryption_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'202':
description: Request is accepted, but processing may take some time.
headers: {}
content: {}
deprecated: false
put:
tags:
- Volume types (types)
summary: updateAnEncryptionType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-an-encryption-type
operationId: updateAnEncryptionType
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: encryption_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3TypesEncryptionEncryptionIdRequest'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types/{volume_type}/action:
post:
tags:
- Volume type access (types, action) (types, os-volume-type-access)
summary: addPrivateVolumeTypeAccessToProject
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#add-private-volume-type-access-to-project
operationId: addPrivateVolumeTypeAccessToProject
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3TypesActionRequest'
required: false
responses:
'202':
description: Request is accepted, but processing may take some time.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/types/{volume_type}/os-volume-type-access:
get:
tags:
- Volume type access (types, action) (types, os-volume-type-access)
summary: listPrivateVolumeTypeAccessDetail
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-private-volume-type-access-detail
operationId: listPrivateVolumeTypeAccessDetail
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_type
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/default-types/{project-id}:
put:
tags:
- Default Volume Types (default-types)
summary: createOrUpdateADefaultVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-or-update-a-default-volume-type
operationId: createOrUpdateADefaultVolumeType
parameters:
- name: project-id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3DefaultTypesRequest'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'400':
description: Some content in the request was invalid.
headers: {}
content: {}
'404':
description: The requested resource could not be found.
headers: {}
content: {}
deprecated: false
get:
tags:
- Default Volume Types (default-types)
summary: showADefaultVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-a-default-volume-type
operationId: showADefaultVolumeType
parameters:
- name: project-id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'404':
description: The requested resource could not be found.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Default Volume Types (default-types)
summary: deleteADefaultVolumeType
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-a-default-volume-type
operationId: deleteADefaultVolumeType
parameters:
- name: project-id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'204':
description: Request fulfilled but service does not return anything.
headers: {}
content: {}
'404':
description: The requested resource could not be found.
headers: {}
content: {}
deprecated: false
/v3/default-types/:
get:
tags:
- Default Volume Types (default-types)
summary: listDefaultVolumeTypes
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-default-volume-types
operationId: listDefaultVolumeTypes
parameters: []
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'404':
description: The requested resource could not be found.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/volumes/detail:
get:
tags:
- Volumes (volumes)
summary: listAccessibleVolumesWithDetails
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-accessible-volumes-with-details
operationId: listAccessibleVolumesWithDetails
parameters:
- name: all_tenants
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: marker
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: with_count
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: created_at
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: updated_at
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: consumes_quota
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'400':
description: Some content in the request was invalid.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/volumes:
post:
tags:
- Volumes (volumes)
summary: createAVolume
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-a-volume
operationId: createAVolume
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3VolumesRequest'
required: false
responses:
'202':
description: Request is accepted, but processing may take some time.
headers: {}
content: {}
deprecated: false
get:
tags:
- Volumes (volumes)
summary: listAccessibleVolumes
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-accessible-volumes
operationId: listAccessibleVolumes
parameters:
- name: all_tenants
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: marker
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: with_count
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: created_at
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: consumes_quota
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: updated_at
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'400':
description: Some content in the request was invalid.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/volumes/{volume_id}:
get:
tags:
- Volumes (volumes)
summary: showAVolume’sDetails
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-a-volume-s-details
operationId: showAVolume’sDetails
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
put:
tags:
- Volumes (volumes)
summary: updateAVolume
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-a-volume
operationId: updateAVolume
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3VolumesRequest1'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Volumes (volumes)
summary: deleteAVolume
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-a-volume
operationId: deleteAVolume
parameters:
- name: cascade
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: force
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'202':
description: Request is accepted, but processing may take some time.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/volumes/{volume_id}/metadata:
post:
tags:
- Volumes (volumes)
summary: createMetadataForVolume
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-metadata-for-volume
operationId: createMetadataForVolume
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3VolumesMetadataRequest'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
get:
tags:
- Volumes (volumes)
summary: showAVolume’sMetadata
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-a-volume-s-metadata
operationId: showAVolume’sMetadata
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
put:
tags:
- Volumes (volumes)
summary: updateAVolume’sMetadata
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-a-volume-s-metadata
operationId: updateAVolume’sMetadata
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3VolumesMetadataRequest'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/volumes/{volume_id}/metadata/{key}:
get:
tags:
- Volumes (volumes)
summary: showAVolume’sMetadataForASpecificKey
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-a-volume-s-metadata-for-a-specific-key
operationId: showAVolume’sMetadataForASpecificKey
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: key
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Volumes (volumes)
summary: deleteAVolume’sMetadata
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#delete-a-volume-s-metadata
operationId: deleteAVolume’sMetadata
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: key
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
put:
tags:
- Volumes (volumes)
summary: updateAVolume’sMetadataForASpecificKey
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#update-a-volume-s-metadata-for-a-specific-key
operationId: updateAVolume’sMetadataForASpecificKey
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: key
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3VolumesMetadataKeyRequest'
required: false
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/volumes/summary:
get:
tags:
- Volumes (volumes)
summary: getVolumesSummary
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#get-volumes-summary
operationId: getVolumesSummary
parameters:
- name: all_tenants
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/volumes/{volume_id}/action:
post:
tags:
- Volume actions (volumes, action)
summary: extendAVolumeSize
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#extend-a-volume-size
operationId: extendAVolumeSize
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: volume_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3VolumesActionRequest'
required: false
responses:
'202':
description: Request is accepted, but processing may take some time.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/manageable_volumes:
post:
tags:
- Volume manage extension (manageable_volumes)
summary: manageAnExistingVolume
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#manage-an-existing-volume
operationId: manageAnExistingVolume
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3ManageableVolumesRequest'
required: false
responses:
'202':
description: Request is accepted, but processing may take some time.
headers: {}
content: {}
deprecated: false
get:
tags:
- Volume manage extension (manageable_volumes)
summary: listSummaryOfVolumesAvailableToManage
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-summary-of-volumes-available-to-manage
operationId: listSummaryOfVolumesAvailableToManage
parameters:
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: offset
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: marker
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: host
in: query
description: ''
style: form
explode: true
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/manageable_volumes/detail:
get:
tags:
- Volume manage extension (manageable_volumes)
summary: listDetailOfVolumesAvailableToManage
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-detail-of-volumes-available-to-manage
operationId: listDetailOfVolumesAvailableToManage
parameters:
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: offset
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: marker
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: host
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/snapshots/detail:
get:
tags:
- Volume snapshots (snapshots)
summary: listSnapshotsAndDetails
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-snapshots-and-details
operationId: listSnapshotsAndDetails
parameters:
- name: all_tenants
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: marker
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: with_count
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: consumes_quota
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'400':
description: Some content in the request was invalid.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/snapshots:
post:
tags:
- Volume snapshots (snapshots)
summary: createASnapshot
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#create-a-snapshot
operationId: createASnapshot
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V3SnapshotsRequest'
required: false
responses:
'202':
description: Request is accepted, but processing may take some time.
headers: {}
content: {}
deprecated: false
get:
tags:
- Volume snapshots (snapshots)
summary: listAccessibleSnapshots
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-accessible-snapshots
operationId: listAccessibleSnapshots
parameters:
- name: all_tenants
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: sort
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: offset
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: marker
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: consumes_quota
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: with_count
in: query
description: ''
style: form
explode: true
schema:
type: boolean
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request was successful.
headers: {}
content: {}
'400':
description: Some content in the request was invalid.
headers: {}
content: {}
deprecated: false
/v3/{project_id}/snapshots/{snapshot_id}/metadata:
get:
tags:
- Volume snapshots (snapshots)
summary: showASnapshot’sMetadata
description: ''
externalDocs:
url: https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-a-snapshot-s-metadata
operationId: showASnapshot’sMetadata
parameters:
- name: project_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: snapshot_id
in: path
description: ''
required: true
style: simp