OpenStack Block Storage (Cinder)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

2843 lines
62 KiB

# variables in header
x-openstack-request-id:
description: >
foo
in: header
required: false
type: string
# variables in path
admin_project_id:
description: |
The UUID of the administrative project.
in: path
required: true
type: string
all_tenants:
description: |
Shows details for all projects.
in: path
required: false
type: string
attachment_id_1:
description: |
The ID of the attachment.
in: path
required: true
type: string
backup_id:
description: |
The UUID for a backup.
in: path
required: true
type: string
cascade:
description: |
Remove any snapshots along with the volume. Default=False.
in: path
required: false
type: boolean
cgsnapshot_id_1:
description: |
The ID of the consistency group snapshot.
in: path
required: true
type: string
consistencygroup_id_2:
description: |
The ID of the consistency group.
in: path
required: true
type: string
encryption_id:
description: |
The ID of the encryption type.
in: path
required: true
type: string
group_id:
description: |
The ID of the group.
in: path
required: true
type: string
group_snapshot_id:
description: |
The ID of the group snapshot.
in: path
required: true
type: string
group_type_id:
description: |
The UUID for an existing group type.
in: path
required: false
type: string
group_type_id_1:
description: |
The UUID for an existing group type.
in: path
required: true
type: string
hostname:
description: |
The name of the host that hosts the storage back
end.
in: path
required: true
type: string
key_1:
description: |
The metadata key name for the metadata that you
want to remove.
in: path
required: true
type: string
key_2:
description: |
The metadata key name for the metadata that you
want to see.
in: path
required: true
type: string
key_3:
description: |
The metadata key name for the metadata that you
want to update.
in: path
required: true
type: string
message_id:
description: |
The UUID of the message.
in: path
required: true
type: string
project_id_path:
description: |
The UUID of the project in a multi-tenancy cloud.
in: path
required: true
type: string
qos_id:
description: |
The ID of the QoS specification.
in: path
required: true
type: string
quota_class_name:
description:
The name of the quota class for which to set quotas.
in: path
required: true
type: string
quotas_project_id:
description: |
The UUID of the project in a multi-tenancy cloud.
in: path
required: true
type: string
snapshot_id_path:
description: |
The UUID of the snapshot.
in: path
required: true
type: string
spec_id:
description: |
The id (key) of the group specification.
in: path
required: true
type: string
transfer_id:
description: |
The unique identifier for a volume transfer.
in: path
required: true
type: string
user_id_1:
description: |
The user ID. Specify in the URI as
``user_id={user_id}``.
in: path
required: false
type: string
vol_type_id:
description: |
The UUID for an existing volume type.
in: path
required: true
type: string
volume_id_path:
description: |
The UUID of the volume.
in: path
required: true
type: string
volume_type:
description: |
The ID of Volume Type to be accessed by project.
in: path
required: false
type: string
volume_type_id:
description: |
The UUID for an existing volume type.
in: path
required: true
type: string
# variables in query
action:
description: |
The action. Valid values are "set" or "unset."
in: query
required: true
type: string
all-tenants:
description: |
Shows details for all project. Admin only.
in: query
required: false
type: string
binary_query:
description: |
Filter the service list result by binary name of the service.
in: query
required: false
type: string
bootable_query:
description: |
Filters results by bootable status. Default=None.
in: query
required: false
type: boolean
detail:
description: |
Indicates whether to show pool details or only
pool names in the response. Set to ``true`` to show pool details.
Set to ``false`` to show only pool names. Default is ``false``.
in: query
required: false
type: boolean
force_3:
description: |
To delete a QoS specification even if it is in-
use, set to ``true``. Default is ``false``.
in: query
required: false
type: boolean
host_query:
description: |
Filter the service list result by host name of the service.
in: query
required: false
type: string
image-id:
description: |
Creates volume from image ID. Default=None.
in: query
required: false
type: string
limit:
description: |
Requests a page size of items. Returns a number
of items up to a limit value. Use the ``limit`` parameter to make
an initial limited request and use the ID of the last-seen item
from the response as the ``marker`` parameter value in a
subsequent limited request.
in: query
required: false
type: integer
limit_group_snapshot:
description: |
Requests a page size of items. Returns a number
of items up to a limit value. Use the ``limit`` parameter to make
an initial limited request and use the ID of the last-seen item
from the response as the ``marker`` parameter value in a
subsequent limited request.
in: query
required: false
type: integer
min_version: 3.29
marker:
description: |
The ID of the last-seen item. Use the ``limit``
parameter to make an initial limited request and use the ID of the
last-seen item from the response as the ``marker`` parameter value
in a subsequent limited request.
in: query
required: false
type: string
marker_group_snapshot:
description: |
The ID of the last-seen item. Use the ``limit``
parameter to make an initial limited request and use the ID of the
last-seen item from the response as the ``marker`` parameter value
in a subsequent limited request.
in: query
required: false
type: string
min_version: 3.29
metadata_query:
description: |
Filters results by a metadata key and value pair.
Default=None.
in: query
required: true
type: object
migration_status_query:
description: |
Filters results by a migration status. Default=None.
Admin only.
in: query
required: false
name_volume:
description: |
Filters results by a name. Default=None.
in: query
required: false
type: string
offset:
description: |
Used in conjunction with ``limit`` to return a slice of items. ``offset``
is where to start in the list.
in: query
required: false
type: integer
offset_group_snapshot:
description: |
Used in conjunction with ``limit`` to return a slice of items. ``offset``
is where to start in the list.
in: query
required: false
type: integer
min_version: 3.29
resource:
description: |
Filter for resource name.
in: query
required: false
type: string
sort:
description: |
Comma-separated list of sort keys and optional
sort directions in the form of < key > [: < direction > ]. A valid
direction is ``asc`` (ascending) or ``desc`` (descending).
in: query
required: false
type: string
sort_dir:
description: |
Sorts by one or more sets of attribute and sort
direction combinations. If you omit the sort direction in a set,
default is ``desc``.
in: query
required: false
type: string
sort_dir_group_snapshot:
description: |
Sorts by one or more sets of attribute and sort
direction combinations. If you omit the sort direction in a set,
default is ``desc``.
in: query
required: false
type: string
min_version: 3.29
sort_key:
description: |
Sorts by an attribute. A valid value is ``name``,
``status``, ``container_format``, ``disk_format``, ``size``,
``id``, ``created_at``, or ``updated_at``. Default is
``created_at``. The API uses the natural sorting direction of the
``sort_key`` attribute value.
in: query
required: false
type: string
sort_key_group_snapshot:
description: |
Sorts by an attribute. A valid value is ``name``,
``status``, ``group_id``, ``group_type_id``, ``size``,
``id``, ``created_at``, or ``updated_at``. Default is
``created_at``. The API uses the natural sorting direction of the
``sort_key`` attribute value.
in: query
required: false
type: string
min_version: 3.29
status_query:
description: |
Filters results by a status. Default=None.
in: query
required: false
type: boolean
usage:
description: |
Show project's quota usage information.
Default is ``false``.
in: query
required: false
type: boolean
vol_type_id_query:
description: |
A volume type ID.
in: query
required: true
type: string
# variables in body
absolute:
description: |
An ``absolute`` limits object.
in: body
required: true
type: object
active_backend_id:
description: |
The ID of active storage backend. Only in ``cinder-volume`` service.
in: body
required: false
type: string
add_volumes:
description: |
One or more volume UUIDs, separated by commas, to
add to the volume group or consistency group.
in: body
required: false
type: string
alias:
description: |
The alias for the extension. For example,
"FOXNSOX", "os- availability-zone", "os-extended-quotas", "os-
share-unmanage" or "os-used-limits."
in: body
required: true
type: string
allow_attached_volume:
description: |
Whether to allow failover if any volumes are 'in-use'.
in: body
required: true
type: boolean
attach_mode:
description: |
The attach mode of attachment, read-only ('ro') or
read-and-write ('rw'), default is 'ro'.
in: body
required: false
type: string
attach_status:
description: |
The volume attach status.
in: body
required: false
type: string
attached_at:
description: |
The time when attachment is attached.
in: body
required: false
type: string
attachment:
description: |
An attachment object.
in: body
required: true
type: object
attachment_id:
description: |
The ID of the attachment.
in: body
required: false
type: string
attachment_id_2:
description: |
The ID of attachment.
in: body
required: true
type: string
attachments:
description: |
Instance attachment information. If this volume
is attached to a server instance, the attachments list includes
the UUID of the attached server, an attachment UUID, the name of
the attached host, if any, the volume UUID, the device, and the
device UUID. Otherwise, this list is empty.
in: body
required: true
type: array
auth_key:
description: |
The authentication key for the volume transfer.
in: body
required: true
type: string
availability_zone:
description: |
The name of the availability zone.
in: body
required: false
type: string
availability_zone_1:
description: |
The availability zone.
in: body
required: false
type: string
availability_zone_2:
description: |
The availability zone.
in: body
required: true
type: string
availability_zone_3:
description: |
The availability zone name.
in: body
required: true
type: string
backend_id:
description: |
ID of backend to failover to. Default is ``None``.
in: body
required: false
type: string
backend_id_target:
description: |
ID of failover target backend.
in: body
required: true
type: string
backup:
description: |
A ``backup`` object.
in: body
required: true
type: object
backup_gigabytes:
description: |
The size (GB) of backups that are allowed for each project.
in: body
required: true
type: integer
backup_gigabytes_usage:
description: |
The size (GB) usage information of backup for this project, including ``in_use``,
``limit``, ``reserved`` and ``allocated`` attributes.
Note: ``allocated`` attribute is available only when nested quota is enabled.
in: body
required: true
type: object
backup_service:
description: |
The service used to perform the backup.
in: body
required: true
type: string
backup_url:
description: |
The backup encoded metadata.
in: body
required: true
type: string
backups:
description: |
A list of ``backup`` objects.
in: body
required: true
type: array
backups_number:
description: |
The number of backups that are allowed for each project.
in: body
required: true
type: integer
backups_number_usage:
description: |
The backup usage information for this project, including ``in_use``,
``limit``, ``reserved`` and ``allocated`` attributes.
Note: ``allocated`` attribute is available only when nested quota is enabled.
in: body
required: true
type: object
binary:
description: |
The binary name of the service.
in: body
required: true
type: string
binary_1:
description: |
The binary name of the service.
in: body
required: false
type: string
bootable:
description: |
Enables or disables the bootable attribute. You
can boot an instance from a bootable volume.
in: body
required: true
type: boolean
bootable_response:
description: |
Enables or disables the bootable attribute. You
can boot an instance from a bootable volume.
in: body
required: true
type: string
capabilities:
description: |
The capabilities for the back end. The value is
either ``null`` or a string value that indicates the capabilities
for each pool. For example, ``total_capacity`` or ``QoS_support``.
in: body
required: true
type: object
cgsnapshot:
description: |
A consistency group snapshot object.
in: body
required: true
type: object
cgsnapshot_id:
description: |
The UUID of the consistency group snapshot.
in: body
required: false
type: string
cgsnapshots:
description: |
A collection of ``cgsnapshot`` objects.
in: body
required: true
type: object
cinder_id:
description: |
The UUID of the snapshot in Cinder.
in: body
required: false
type: string
cipher:
description: |
The encryption algorithm or mode. For example, aes-xts-plain64. The default
value is None.
in: body
required: false
type: string
cluster:
description: |
The cluster name. Only in ``cinder-volume`` service.
in: body
required: false
type: string
min_version: 3.7
cluster_1:
description: |
The cluster name.
in: body
required: false
type: string
cluster_mutex:
description: |
The OpenStack Block Storage cluster where the resource resides. Optional
only if host field is provided.
in: body
required: false
type: string
connection_info:
description: |
The connection info used for server to connect the volume.
in: body
required: true
type: object
connector:
description: |
The ``connector`` object.
in: body
required: false
type: object
connector_1:
description: |
The ``connector`` object. The internal structure of connector depends on
the volume driver implementation. For details about the required elements
in the structure, see the documentation for the volume driver.
in: body
required: true
type: object
consistencygroup:
description: |
A consistency group.
in: body
required: true
type: object
consistencygroup-from-src:
description: |
The consistency group from source object.
in: body
required: true
type: object
consistencygroup_id:
description: |
The UUID of the consistency group.
in: body
required: true
type: string
consistencygroup_id_1:
description: |
The UUID of the consistency group.
in: body
required: false
type: string
consistencygroups:
description: |
A list of consistency groups.
in: body
required: true
type: array
consumer:
description: |
The consumer type.
in: body
required: false
type: string
consumer_1:
description: |
The consumer type.
in: body
required: true
type: string
container:
description: |
The container name or null.
in: body
required: false
type: string
container_format:
description: |
Container format for the new image. Default is bare.
in: body
required: false
type: string
control_location:
description: |
Notional service where encryption is performed. Valid values are
"front-end" or "back-end". The default value is "front-end".
in: body
required: false
type: string
create-from-src:
description: |
The create from source action.
in: body
required: true
type: object
created_at:
description: |
The date and time when the resource was created.
The date and time stamp format is `ISO 8601
<https://en.wikipedia.org/wiki/ISO_8601>`_:
::
CCYY-MM-DDThh:mm:ss±hh:mm
For example, ``2015-08-27T09:49:58-05:00``.
The ``±hh:mm`` value, if included, is the time zone as an offset
from UTC.
in: body
required: true
type: string
created_at_1:
description: |
Date and time when the volume was created.
in: body
required: true
type: string
data_timestamp:
description: |
The time when the data on the volume was first saved. If it is
a backup from volume, it will be the same as ``created_at``
for a backup. If it is a backup from a snapshot, it will be the
same as ``created_at`` for the snapshot.
in: body
required: true
type: string
delete:
description: |
The delete action.
in: body
required: true
type: object
delete-volumes:
description: |
If set to ``true``, allows deletion of a
group as well as all volumes in the group.
in: body
required: false
type: boolean
deleted:
description: |
The resource is deleted or not.
in: body
required: true
type: boolean
deleted_at:
description: |
The date and time when the resource was deleted.
The date and time stamp format is `ISO 8601
<https://en.wikipedia.org/wiki/ISO_8601>`_:
::
CCYY-MM-DDThh:mm:ss±hh:mm
For example, ``2015-08-27T09:49:58-05:00``.
The ``±hh:mm`` value, if included, is the time zone as an offset
from UTC. In the previous example, the offset value is ``-05:00``.
If the ``deleted_at`` date and time stamp is not set, its value is
``null``.
in: body
required: true
type: string
description:
description: |
The backup description or null.
in: body
required: false
type: string
description_1:
description: |
The consistency group snapshot description.
in: body
required: true
type: string
description_10:
description: |
The capabilities description.
in: body
required: true
type: string
description_11:
description: |
The consistency group description.
in: body
required: false
type: string
description_12:
description: |
The group type description.
in: body
required: false
type: string
description_13:
description: |
The group description.
in: body
required: false
type: string
description_14:
description: |
The group snapshot description.
in: body
required: false
type: string
description_15:
description: |
The volume type description.
in: body
required: false
type: string
description_2:
description: |
The description of the consistency group.
in: body
required: false
type: string
description_3:
description: |
The description of the consistency group.
in: body
required: true
type: string
description_4:
description: |
A description for the snapshot. Default is
``None``.
in: body
required: false
type: string
description_5:
description: |
The volume description.
in: body
required: false
type: string
description_6:
description: |
The consistency group description.
in: body
required: true
type: string
description_7:
description: |
The extension description.
in: body
required: true
type: string
description_8:
description: |
A description for the snapshot.
in: body
required: true
type: string
description_9:
description: |
The volume description.
in: body
required: true
type: string
detached_at:
description: |
The time when attachment is detached.
in: body
required: false
type: string
disabled:
description: |
Filter by disabled status.
in: body
required: false
type: boolean
disabled_1:
description: |
The service is disabled or not.
in: body
required: true
type: boolean
disabled_reason_body:
description: |
The reason for disabling a service.
in: body
required: true
type: string
disabled_reason_body_1:
description: |
The reason for disabling a service.
in: body
required: false
type: string
disk_format:
description: |
Disk format for the new image. Default is raw.
in: body
required: false
type: string
display_name:
description: |
The name of volume backend capabilities.
in: body
required: true
type: string
driver_version:
description: |
The driver version.
in: body
required: true
type: string
encrypted:
description: |
If true, this volume is encrypted.
in: body
required: true
type: boolean
encryption:
description: |
The encryption information.
in: body
required: true
type: object
encryption_id_body:
description: |
The UUID of the encryption.
in: body
required: true
type: string
event_id:
description: |
The id of the event to this message, this id could
eventually be translated into ``user_message``.
in: body
required: true
type: string
extra_info:
description: |
More information about the resource.
in: body
required: false
type: string
extra_specs:
description: |
A set of key and value pairs that contains the
specifications for a volume type.
in: body
required: true
type: object
extra_specs_1:
description: |
A key and value pair that contains additional
specifications that are associated with the volume type. Examples
include capabilities, capacity, compression, and so on, depending
on the storage driver in use.
in: body
required: true
type: object
fail_reason:
description: |
If the backup failed, the reason for the failure.
Otherwise, null.
in: body
required: true
type: string
force:
description: |
Indicates whether to backup, even if the volume
is attached. Default is ``false``.
in: body
required: false
type: boolean
force_1:
description: |
Indicates whether to snapshot, even if the volume
is attached. Default is ``false``.
in: body
required: false
type: boolean
force_2:
description: |
If set to ``true``, forces deletion of a
consistency group that has a registered volume.
in: body
required: false
type: boolean
force_4:
description: |
Enables or disables upload of a volume that is
attached to an instance. Default=False.
in: body
required: false
type: boolean
force_5:
description: |
Indicates whether to force deletes a volume even if
the volume is in deleting or error_deleting. Default is ``false``.
in: body
required: false
type: boolean
min_version: 3.23
free_capacity:
description: |
The amount of free capacity for the back-end
volume, in GBs. A valid value is a string, such as ``unknown``, or
an integer.
in: body
required: true
type: string
frozen:
description: |
The host is frozen or not. Only in ``cinder-volume`` service.
in: body
required: false
type: boolean
gigabytes:
description: |
The size (GB) of volumes and snapshots that are allowed for each project.
in: body
required: true
type: integer
gigabytes_for_type:
description: |
The size (GB) of volumes and snapshots that are allowed for each project
and the specifed volume type.
in: body
required: true
type: integer
gigabytes_for_type_usage:
description: |
The size (GB) usage information of volumes and snapshots for this project
and this volume type, including ``in_use``, ``limit``, ``reserved`` and
``allocated`` attributes. Note: ``allocated`` attribute is available only
when nested quota is enabled.
in: body
required: true
type: object
gigabytes_usage:
description: |
The size (GB) usage information of volumes and snapshots for this project,
including ``in_use``, ``limit``, ``reserved`` and ``allocated`` attributes.
Note: ``allocated`` attribute is available only when nested quota is enabled.
in: body
required: true
type: object
group:
description: |
A group object.
in: body
required: true
type: object
group_id_1:
description: |
The ID of the group.
in: body
required: false
type: string
group_name:
description: |
The group name.
in: body
required: true
type: string
group_replication_status:
description: |
The group replication status. Introduced with API microversion 3.38.
in: body
required: false
type: string
group_snapshot:
description: |
The group snapshot.
in: body
required: true
type: object
group_snapshot_id_1:
description: |
The ID of the group snapshot.
in: body
required: true
type: string
group_snapshots:
description: |
A collection of group snapshots.
in: body
required: true
type: array
group_specs:
description: |
A set of key and value pairs that contains the
specifications for a group type.
in: body
required: false
type: object
group_specs_2:
description: |
A set of key and value pairs that contains the
specifications for a group type.
in: body
required: true
type: object
group_type:
description: |
A ``group_type`` object.
in: body
required: true
type: object
group_type_id_2:
description: |
The group type ID.
in: body
required: true
type: string
group_types:
description: |
The list of group types.
in: body
required: true
type: array
groups:
description: |
A collections of groups.
in: body
required: true
type: array
groups_number:
description: |
The number of groups that are allowed for each project.
in: body
required: true
type: integer
groups_number_usage:
description: |
The group usage information for this project, including ``in_use``,
``limit``, ``reserved`` and ``allocated`` attributes.
Note: ``allocated`` attribute is available only when nested quota is enabled.
in: body
required: true
type: object
guaranteed_until:
description: |
The expire time of the message, this message could be
be deleted after this time.
in: body
required: false
type: string
has_dependent_backups:
description: |
If this value is ``true``, the backup depends on
other backups.
in: body
required: false
type: boolean
host:
description: |
The OpenStack Block Storage host where the
existing volume resides.
in: body
required: true
type: object
host_mutex:
description: |
The OpenStack Block Storage host where the existing resource resides.
Optional only if cluster field is provided.
in: body
required: false
type: string
host_name:
description: |
The name of the attaching host.
in: body
required: false
type: string
host_name_1:
description: |
The name of the host that hosts the storage backend.
in: body
required: true
type: string
host_name_body:
description: |
The name of the host.
in: body
required: true
type: string
host_name_body_1:
description: |
The name of the host.
in: body
required: false
type: string
host_service:
description: |
The name of the service which is running on the host.
in: body
required: true
type: string
hosts:
description: |
A OpenStack Block Storage host.
in: body
required: true
type: object
id:
description: |
The UUID of the volume transfer.
in: body
required: true
type: string
id_1:
description: |
The UUID of the backup.
in: body
required: true
type: string
id_2:
description: |
The UUID of the consistency group snapshot.
in: body
required: true
type: string
id_3:
description: |
The generated ID for the QoS specification.
in: body
required: true
type: string
id_4:
description: |
The snapshot UUID.
in: body
required: true
type: string
id_5:
description: |
The UUID of the volume.
in: body
required: true
type: string
id_6:
description: |
The UUID of the consistency group.
in: body
required: true
type: string
id_7:
description: |
The ID for the quota set.
in: body
required: true
type: integer
id_8:
description: |
The ID for the message.
in: body
required: true
type: integer
image_id:
description: |
The uuid for the new image.
in: body
required: true
type: string
image_name:
description: |
The name for the new image.
in: body
required: true
type: string
imageRef:
description: |
The UUID of the image from which you want to
create the volume. Required to create a bootable volume.
in: body
required: false
type: string
incremental:
description: |
The backup mode. A valid value is ``true`` for
incremental backup mode or ``false`` for full backup mode. Default
is ``false``.
in: body
required: false
type: boolean
instance_uuid:
description: |
The UUID of the attaching instance.
in: body
required: false
type: string
instance_uuid_1:
description: |
The UUID of the attaching instance.
in: body
required: true
type: string
is_incremental:
description: |
Indicates whether the backup mode is incremental.
If this value is ``true``, the backup mode is incremental. If this
value is ``false``, the backup mode is full.
in: body
required: false
type: boolean
is_public:
description:
Whether the volume type is publicly visible.
in: body
required: false
type: boolean
is_public_1:
description:
Whether the group is publicly visible.
in: body
required: false
type: boolean
is_up:
description: |
Filter by up/down status.
in: body
required: false
type: boolean
key:
description: |
The metadata key name for the metadata that you
want to remove.
in: body
required: true
type: string
key_size:
description: |
Size of encryption key, in bits. For example, 128 or 256. The default value
is None.
in: body
required: false
type: integer
keys:
description: |
List of Keys. For example, CryptsetupEncryptor, LuksEncryptor or
NoOpEncryptor.
in: body
required: true
type: array
levels:
description: |
The current log level that queried.
in: body
required: true
type: object
levels_1:
description: |
The log level to set, case insensitive, accepted values are ``INFO``,
``WARNING``, ``ERROR`` and ``DEBUG``.
in: body
required: true
type: string
limit_usage:
description: |
The limit data size. Visible only if you set the
``usage=true`` query parameter.
in: body
required: false
type: integer
limits:
description: |
A list of ``limit`` objects.
in: body
required: true
type: object
links:
description: |
Links for the volume transfer.
in: body
required: true
type: array
links_1:
description: |
Links for the backup.
in: body
required: true
type: array
links_2:
description: |
The QoS specification links.
in: body
required: true
type: array
links_3:
description: |
The volume links.
in: body
required: true
type: array
links_4:
description: |
List of links related to the extension.
in: body
required: true
type: array
links_5:
description: |
Links for the message.
in: body
required: false
type: array
location:
description: |
Full URL to a service or server.
format: uri
in: body
required: true
type: string
log_levels:
description: |
The list of log levels.
in: body
required: true
type: array
manageable-snapshots:
description: |
A list of manageable snapshots.
in: body
required: true
type: list
manageable-volumes:
description: |
A list of manageable volumes.
in: body
required: true
type: list
maxTotalBackupGigabytes:
description: |
The maximum total amount of backups, in gibibytes
(GiB).
in: body
required: true
type: integer
maxTotalBackups:
description: |
The maximum number of backups.
in: body
required: true
type: integer
maxTotalGroups:
description: |
The maximum number of groups.
in: body
required: true
type: integer
maxTotalSnapshots:
description: |
The maximum number of snapshots.
in: body
required: true
type: integer
maxTotalSnapshotsOptional:
description: |
The maximum number of snapshots.
in: body
required: false
type: integer
maxTotalVolumeGigabytes:
description: |
The maximum total amount of volumes, in gibibytes
(GiB).
in: body
required: true
type: integer
maxTotalVolumeGigabytesOptional:
description: |
The maximum total amount of volumes, in gibibytes (GiB).
in: body
required: true
type: integer
maxTotalVolumes:
description: |
The maximum number of volumes.
in: body
required: true
type: integer
maxTotalVolumesOptional:
description: |
The maximum number of volumes.
in: body
required: false
type: integer
message_level:
description: |
The level of the message, possible value is
only 'ERROR' now.
in: body
required: true
type: string
meta:
description: |
The metadata key and value pair for the volume.
in: body
required: true
type: object
meta_1:
description: |
The metadata key and value pair for the snapshot.
in: body
required: true
type: object
metadata:
description: |
One or more metadata key and value pairs for the
snapshot, if any.
in: body
required: true
type: object
metadata_1:
description: |
A ``metadata`` object. Contains one or more
metadata key and value pairs that are associated with the volume.
in: body
required: true
type: object
metadata_2:
description: |
One or more metadata key and value pairs that are
associated with the volume.
in: body
required: false
type: object
metadata_3:
description: |
One or more metadata key and value pairs that are
associated with the volume.
in: body
required: true
type: object
metadata_4:
description: |
One or more metadata key and value pairs to
associate with the volume.
in: body
required: false
type: string
metadata_5:
description: |
The image metadata to add to the volume as a set
of metadata key and value pairs.
in: body
required: true
type: object
metadata_6:
description: |
One or more metadata key and value pairs to
associate with the volume.
in: body
required: false
type: object
metadata_7:
description: |
One or more metadata key and value pairs for the
snapshot.
in: body
required: false
type: object
metadata_8:
description: |
The image metadata key value pairs.
in: body
required: true
type: object
metadata_9:
description: |
The backup metadata key value pairs.
in: body
required: false
type: object
min_version: 3.43
migration_policy:
description: |
Specify if the volume should be migrated when it is re-typed.
Possible values are ``on-demand`` or ``never``. If not specified, the
default is ``never``.
.. note:: If the volume is attached to a server instance and will be
migrated, then by default policy only users with the administrative role
should attempt the retype operation.
in: body
required: false
type: string
migration_status:
description: |
The volume migration status.
in: body
required: true
type: string
migration_status_1:
description: |
The volume migration status.
in: body
required: false
type: string
mountpoint:
description: |
The attaching mount point.
in: body
required: true
type: string
multiattach:
description: |
To enable this volume to attach to more than one
server, set this value to ``true``. Default is ``false``.
in: body
required: false
type: boolean
multiattach_1:
description: |
If true, this volume can attach to more than one
instance.
in: body
required: true
type: boolean
name:
description: |
The name of the Volume Transfer.
in: body
required: true
type: string
name_1:
description: |
The backup name.
in: body
required: true
type: string
name_10:
description: |
The name of the extension. For example, "Fox In
Socks."
in: body
required: true
type: string
name_11:
description: |
The name of the back-end volume.
in: body
required: true
type: string
name_12:
description: |
The name of the snapshot.
in: body
required: true
type: string
name_13:
description: |
The volume name.
in: body
required: true
type: string
name_14:
description: |
The name of the volume to which you want to
restore a backup.
in: body
required: false
type: string
name_15:
description: |
The consistency group name.
in: body
required: false
type: string
name_16:
description: |
The group type name.
in: body
required: false
type: string
name_17:
description: |
The group name.
in: body
required: false
type: string
name_18:
description: |
The group snapshot name.
in: body
required: false
type: string
name_2:
description: |
The consistency group snapshot name.
in: body
required: true
type: string
name_3:
description: |
The name of the consistency group.
in: body
required: true
type: string
name_4:
description: |
The name of the QoS specification.
in: body
required: true
type: string
name_5:
description: |
The name of the snapshot. Default is ``None``.
in: body
required: false
type: string
name_6:
description: |
The volume transfer name.
in: body
required: false
type: string
name_7:
description: |
The name of the volume type.
in: body
required: true
type: string
name_8:
description: |
The volume name.
in: body
required: false
type: string
name_9:
description: |
The consistency group name.
in: body
required: true
type: string
name_optional:
description: |
The name of the Volume Backup.
in: body
required: false
type: string
namespace:
description: |
Link associated to the extension.
in: body
required: true
type: string
namespace_1:
description: |
The storage namespace, such as
``OS::Storage::Capabilities::foo``.
in: body
required: true
type: string
new_size:
description: |
The new size of the volume, in gibibytes (GiB).
.. note:: Some volume backends require the storage to be in some multiple
value rather than incremental. For example, the EMC ScaleIO backend
requires storage in multiples of 8GB. There is a known limitation such
that a request to extend the size of a volume for these backends will be
rounded up to the nearest multiple but the actual physical size of the
storage will not be reflected back in the API for the volume size. For
example, a request to extend the size of an 8GB ScaleIO-backed volume
to 9GB will actually result in 16GB of physical storage but only 9GB will
be reflected in the API and counted for quota usage.
in: body
required: true
type: integer
new_type:
description: |
The new volume type that volume is changed with.
in: body
required: true
type: string
object_count:
description: |
The number of objects in the backup.
in: body
required: true
type: integer
os-attach:
description: |
The ``os-attach`` action.
in: body
required: true
type: object
os-backup-project-attr:project_id:
description: |
The UUID of the owning project.
in: body
required: true
type: string.
in: body
required: true
type: string
min_version: 3.18
os-detach:
description: |
The ``os-detach`` action.
in: body
required: true
type: object
os-extend:
description: |
The ``os-extend`` action.
in: body
required: true
type: object
os-extended-snapshot-attributes:progress:
description: |
A percentage value for the build progress.
in: body
required: true
type: integer
os-extended-snapshot-attributes:project_id:
description: |
The UUID of the owning project.
in: body
required: true
type: string
os-force_delete:
description: |
The ``os-force_delete`` action.
in: body
required: true
type: string
os-force_detach:
description: |
The ``os-force_detach`` action.
in: body
required: true
type: object
os-reset_status:
description: |
The ``os-reset_status`` action.
in: body
required: true
type: object
os-retype:
description: |
The ``os-retype`` action.
in: body
required: true
type: object
OS-SCH-HNT:scheduler_hints:
description: |
The dictionary of data to send to the scheduler.
in: body
required: false
type: object
os-set_bootable:
description: |
The ``os-set_bootable`` action.
in: body
required: true
type: object
os-set_image_metadata:
description: |
The ``os-set_image_metadata`` action.
in: body
required: true
type: object
os-show_image_metadata:
description: |
The ``os-show_image_metadata`` action.
in: body
require: true
type: object
os-unmanage:
description: |
The ``os-unmanage`` action. This action removes
the specified volume from Cinder management.
in: body
required: true
type: object
os-unset_image_metadata:
description: |
The ``os-unset_image_metadata`` action. This
action removes the key-value pairs from the image metadata.
in: body
required: true
type: object
os-vol-host-attr:host:
description: |
Current back-end of the volume.
in: body
required: true
type: string
os-vol-mig-status-attr:migstat:
description: |
The status of this volume migration (None means
that a migration is not currently in progress).
in: body
required: true
type: string
os-vol-mig-status-attr:name_id:
description: |
The volume ID that this volume name on the back-
end is based on.
in: body
required: true
type: string
os-vol-tenant-attr:tenant_id:
description: |
The project ID which the volume belongs to.
in: body
required: true
type: string
os-volume-replication:driver_data:
description: |
The name of the volume replication driver.
in: body
required: false
type: string
os-volume-replication:extended_status:
description: |
The volume replication status managed by the
driver of backend storage.
in: body
required: false
type: string
os-volume-replication:extended_status_1:
description: |
The status of the volume replication.
in: body
required: false
type: string
os-volume-type-access:is_public:
description: |
Make type accessible to the public.
in: body
required: false
type: boolean
os-volume_upload_image:
description: |
The ``os-volume_upload_image`` action. This
action uploads the specified volume to image service.
in: body
required: true
type: object
per_volume_gigabytes:
description: |
The size (GB) of volumes that are allowed for each volume.
in: body
required: true
type: integer
per_volume_gigabytes_usage:
description: |
The size (GB) usage information for each volume, including ``in_use``,
``limit``, ``reserved`` and ``allocated`` attributes.
Note: ``allocated`` attribute is available only when nested quota
is enabled and only ``limit`` is meaningful here.
in: body
required: true
type: object
pool_name:
description: |
The name of the storage pool.
in: body
required: true
type: string
pools:
description: |
List of storage pools.
in: body
required: true
type: array
prefix:
description: |
The prefix for the log path we are querying,
for example ``cinder.`` or ``sqlalchemy.engine``.
When not present or the empty string is passed all
log levels will be retrieved.
in: body
required: false
type: string
project:
description: |
The ID of the project. Volume Type access to be
added to this project ID.
in: body
required: true
type: string
project_id:
description: |
The UUID of the project.
in: body
required: true
type: string
project_id_1:
description: |
The Project ID having access to this volume type.
in: body
required: true
type: string
project_id_2:
description: |
The Project ID which the host resource belongs to.
In the summary resource, the value is ``(total)``.
in: body
required: true
type: string
properties:
description: |
The backend volume capabilities list, which is
consisted of cinder standard capabilities and vendor unique
properties.
in: body
required: true
type: object
protected:
description: |
Whether the new image is protected. Default=False.
in: body
required: false
type: boolean
provider:
description: |
The class that provides encryption support.
in: body
required: true
type: string
provider_optional:
description: |
The class that provides encryption support.
in: body
required: false
type: string
qos_set_id:
description: |
The QoS set ID.
in: body
required: true
type: string
qos_specs:
description: |
A ``qos_specs`` object.
in: body
required: true
type: object
QoS_support:
description: |
The quality of service (QoS) support.
in: body
required: true
type: boolean
quota_class_id:
description:
The name of the quota class set.
in: body
required: true
type: string
quota_class_set:
description: |
A ``quota_class_set`` object.
in: body
required: true
type: object
quota_set:
description: |
A ``quota_set`` object.
in: body
required: true
type: object
rate:
description: |
Rate-limit volume copy bandwidth, used to
mitigate slow down of data access from the instances.
in: body
required: true
type: array
reason_not_safe:
description: |
The reason why the resource can't be managed.
in: body
required: false
type: string
ref:
description: |
A reference to the existing volume. The internal
structure of this reference depends on the volume driver
implementation. For details about the required elements in the
structure, see the documentation for the volume driver.
in: body
required: true
type: object
ref_1:
description: |
A reference to the existing volume. The internal
structure of this reference is dependent on the implementation of
the volume driver, see the specific driver's documentation for
details of the required elements in the structure.
in: body
required: true
type: object
reference:
description: |
Some information for the resource.
in: body
required: true
type: object
remove_volumes:
description: |
One or more volume UUIDs, separated by commas, to
remove from the volume group or consistency group.
in: body
required: false
type: string
replication_status:
description: |
The volume replication status.
in: body
required: true
type: string
replication_status_1:
description: |
The volume service replication status. Only in ``cinder-volume`` service.
in: body
required: false
type: string
replication_targets:
description: |
A list of volume backends used to replicate volumes
on this backend.
in: body
required: true
type: list
replication_targets_unique_key:
description: |
Vendor specific key-values. Only returned if administrator.
in: body
type: string
request_id:
description: |
The id of the request during which the message was created.
in: body
required: true
type: string
reserved_percentage:
description: |
The percentage of the total capacity that is
reserved for the internal use by the back end.
in: body
required: true
type: integer
reset_status:
description: |
The ``reset_status`` action.
in: body
required: true
type: object
resource_1:
description: |
Resource which the filters will be applied to.
in: body
required: true
type: string
resource_filters:
description: |
The resource filter array.
in: body
required: true
type: array
resource_filters_1:
description: |
A collection of resource filters.
in: body
required: true
type: array
resource_id:
description: |
The UUID of a resource to cleanup.
in: body
required: false
type: string
resource_type:
description: |
The resource type corresponding to ``resource_uuid``.
in: body
required: false
type: string
resource_uuid:
description: |
The UUID of the resource during whose operation the
message was created.
in: body
required: false
type: string
restore:
description: |
A ``restore`` object.
in: body
required: true
type: object
revert:
description: |
The ``revert`` action.
in: body
required: true
type: object
safe_to_manage:
description: |
If the resource can be managed or not.
in: body
required: true
type: boolean
security_group_rules:
description: |
The number of rules that are allowed for each
security group.
in: body
required: false
type: integer
security_groups:
description: |
The number of security groups that are allowed
for each project.
in: body
required: true
type: integer
service_id:
description: |
UUID for the cleanup service.
in: body
required: false
type: string
service_key:
description: |
The service name. Deprecated. Keeping service key
for API compatibility.
in: body
required: true
type: string
service_state:
description: |
The state of the service. One of ``enabled`` or ``disabled``.
in: body
required: true
type: string
service_state_1:
description: |
The state of the service. One of ``up`` or ``down``.
in: body
required: true
type: string
service_status:
description: |
The status of the service. One of ``available`` or ``unavailable``.
in: body
required: true
type: string
services:
description: |
A list of service objects.
in: body
required: true
type: array
size:
description: |
The size of the volume, in gibibytes (GiB).
in: body
required: true
type: integer
skip_validation:
description: |
If set to false, the quota value can't be set lower than the in_use quota.
Default is True.
in: body
required: false
type: boolean
snapshot:
description: |
A partial representation of a snapshot used in
the creation process.
in: body
required: true
type: string
snapshot_1:
description: |
A ``snapshot`` object.
in: body
required: true
type: object
snapshot_id:
description: |
To create a volume from an existing snapshot,
specify the UUID of the volume snapshot. The volume is created in
same availability zone and with same size as the snapshot.
in: body
required: false
type: string
snapshot_id_2:
description: |
The UUID of the source volume snapshot.
in: body
required: false
type: string
snapshot_id_3:
description: |
The UUID of the source volume snapshot. The API
creates a new volume snapshot with the same size as the source
volume snapshot.
in: body
required: true
type: string
snapshot_id_4:
description: |
The UUID of the snapshot. The API
reverts the volume with this snapshot.
in: body
required: true
type: string
snapshots_number:
description: |
The number of snapshots that are allowed for each project.
in: body
required: true
type: integer
snapshots_number_for_type:
description: |
The number of snapshots that are allowed for each project and
the specified volume type.
in: body
required: true
type: integer
snapshots_number_for_type_usage:
description: |
The snapshot usage information for this project and this volume type,
including ``in_use``, ``limit``, ``reserved`` and ``allocated`` attributes.
Note: ``allocated`` attribute is available only when nested quota is enabled.
in: body
required: true
type: object
snapshots_number_usage:
description: |
The snapshot usage information for this project, including ``in_use``,
``limit``, ``reserved`` and ``allocated`` attributes.
Note: ``allocated`` attribute is available only when nested quota is enabled.
in: body
required: true
type: object
source-name:
description: |
The resource's name.
in: body
required: true
type: string
source_cgid:
description: |
The UUID of the source consistency group.
in: body
required: false
type: string
source_group_id:
description: |
The UUID of the source group.
in: body
required: true
type: string
source_reference:
description: |
The snapshot's origin volume information.
in: body
required: true
type: object
source_replica:
description: |
The UUID of the replication volume to clone. This was for legacy
replication functionality and is no longer supported.
in: body
required: false
type: string
source_volid:
description: |
The UUID of the source volume. The API creates a
new volume with the same size as the source volume.
in: body
required: false
type: string
spec_value:
description: |
The value of the group specification corresponding to the specified key.
in: body
required: true
type: string
specs:
description: |
A ``specs`` object.
in: body
required: true
type: object
specs_2:
description: |
Specification key and value pairs.
in: body
required: true
type: string
status:
description: |
The ``status`` of the consistency group snapshot.
in: body
required: false
type: string
status_1:
description: |
The status of the consistency group.
in: body
required: true
type: string
status_10:
description: |
The status for the backup.
in: body
required: true
type: string
status_2:
description: |
The status for the snapshot.
in: body
required: true
type: string
status_3:
description: |
The volume status.
in: body
required: true
type: string
status_4:
description: |
The backup status. Refer to Backup statuses table
for the possible status value.
in: body
required: true
type: string
status_7:
description: |
The ``status`` of the generic group snapshot.
in: body
required: true
type: string
status_8:
description: |
The status of the generic group.
in: body
required: true
type: string
status_9:
description: |
The status of the attachment.
in: body
required: true
type: string
storage_protocol:
description: |
The storage back end for the back-end volume. For
example, ``iSCSI`` or ``FC``.
in: body
required: true
type: string
summary_metadata:
description: |
The dictionary of lists contains all the volumes' metadata,
classified by metadata key.
in: body
required: true
type: object
min_version: 3.36
total_capacity:
description: |
The total capacity for the back-end volume, in
GBs. A valid value is a string, such as ``unknown``, or an
integer.
in: body
required: true
type: string
total_count:
description: |
Total number of volumes.
in: body
required: true
type: integer
total_size:
description: |
Total size of volumes in GB.
in: body
required: true
type: integer
totalBackupGigabytesUsed:
description: |
The total number of backups gibibytes (GiB) used.
in: body
required: true
type: integer
totalBackupsUsed:
description: |
The total number of backups used.
in: body
required: true
type: integer
totalGigabytesUsed:
description: |
The total number of gibibytes (GiB) used.
in: body
required: true
type: integer
totalSnapshotsUsed:
description: |
The total number of snapshots used.
in: body
required: true
type: integer
totalVolumesUsed:
description: |
The total number of volumes used.
in: body
required: true
type: integer
transfer:
description: |
The volume transfer object.
in: body
required: true
type: object
transfers:
description: |
List of transfer details.
in: body
required: true
type: array
updated:
description: |
The date and time stamp when the extension was
last updated.
in: body
required: true
type: string
updated_1:
description: |
The date and time stamp when the API request was
issued.
in: body
required: true
type: string
updated_at:
description: |
The date and time when the resource was updated.
The date and time stamp format is `ISO 8601
<https://en.wikipedia.org/wiki/ISO_8601>`_:
::
CCYY-MM-DDThh:mm:ss±hh:mm
For example, ``2015-08-27T09:49:58-05:00``.
The ``±hh:mm`` value, if included, is the time zone as an offset
from UTC. In the previous example, the offset value is ``-05:00``.
If the ``updated_at`` date and time stamp is not set, its value is
``null``.
in: body
required: true
type: string
user_id:
description: |
The UUID of the user.
in: body
required: true