api-ref: Make v3 enclosing objects consistent

Some request details provided information about the other
JSON value while others didn't. To make things consistent
and to make sure API consumers understand how the requests
need to be structured, this adds missing instances. It also
reorders some parameter lists to be a little more logical,
so even though we can't show the nested nature of some of
these, it at least doesn't show inner values before outer
ones.

This also corrects many errors seen while going through
the API ref. This is by no means exhaustive, and is already
somewhat out of the scope for this patch, so it is expected
that there are some (many) cases that are not addressed by
this patch. Those will be fixed with ongoing effort in
future patches.

Partial-bug: #1713517
Change-Id: I30964ba8d829778fd01174d639d44ba07e4b77a6
This commit is contained in:
Sean McGinnis 2017-08-29 16:07:03 -05:00
parent e9f09a25e6
commit fffdac20c2
35 changed files with 578 additions and 410 deletions

View File

@ -15,6 +15,7 @@ Delete attachment
Deletes an attachment. Deletes an attachment.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -36,6 +37,7 @@ Shows details for an attachment.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -74,11 +76,11 @@ List attachments with details
.. rest_method:: GET /v3/{project_id}/attachments/detail .. rest_method:: GET /v3/{project_id}/attachments/detail
Lists all attachments with details, since v3.31 if non-admin Lists all attachments with details. Since v3.31 if non-admin
users specify invalid filters in the url, API will return bad request. users specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
Request Request
@ -87,8 +89,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -124,6 +125,7 @@ specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -133,8 +135,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -166,6 +167,7 @@ Create attachment
Creates an attachment. Creates an attachment.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -175,6 +177,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- attachment: attachment
- instance_uuid: instance_uuid_1 - instance_uuid: instance_uuid_1
- connector: connector - connector: connector
- volume_uuid: volume_id_7 - volume_uuid: volume_id_7
@ -190,6 +193,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- attachment: attachment
- status: status_9 - status: status_9
- detached_at: detached_at - detached_at: detached_at
- connection_info: connection_info - connection_info: connection_info
@ -215,6 +219,7 @@ Update a reserved attachment record with connector information
and set up the appropriate connection_info from the driver. and set up the appropriate connection_info from the driver.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
Request Request
@ -224,6 +229,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- attachment_id: attachment_id_1 - attachment_id: attachment_id_1
- attachement: attachment
- connector: connector_1 - connector: connector_1
Request Example Request Example
@ -237,6 +243,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- attachment: attachment
- status: status_9 - status: status_9
- detached_at: detached_at - detached_at: detached_at
- connection_info: connection_info - connection_info: connection_info

View File

@ -15,7 +15,6 @@ Shows capabilities for a storage back end on the host.
The ``hostname`` takes the form of ``hostname@volume_backend_name``. The ``hostname`` takes the form of ``hostname@volume_backend_name``.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
------- -------

View File

@ -23,7 +23,6 @@ Lists consistency groups.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -32,8 +31,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- marker: marker - marker: marker
@ -43,6 +41,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- consistencygroups: consistencygroups
- id: id - id: id
- name: name - name: name
@ -69,16 +68,24 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- consistencygroup: consistencygroup
- description: description_6 - description: description_6
- availability_zone: availability_zone - availability_zone: availability_zone
- volume_types: volume_types_2 - volume_types: volume_types_2
- name: name_15 - name: name_15
Request Example
---------------
.. literalinclude:: ./samples/consistency-group-create-request.json
:language: javascript
Response Response
-------- --------
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- consistencygroup: consistencygroup
- status: status_1 - status: status_1
- description: description_11 - description: description_11
- availability_zone: availability_zone - availability_zone: availability_zone
@ -87,12 +94,6 @@ Response
- name: name_15 - name: name_15
- id: consistencygroup_id_1 - id: consistencygroup_id_1
Request Example
---------------
.. literalinclude:: ./samples/consistency-group-create-request.json
:language: javascript
Response Example Response Example
---------------- ----------------
@ -107,7 +108,6 @@ Show a consistency group's details
Shows details for a consistency group. Shows details for a consistency group.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
------- -------
@ -115,7 +115,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_2
Response Parameters Response Parameters
------------------- -------------------
@ -152,6 +152,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- consistencygroup-from-src: consistencygroup-from-src
- status: status_1 - status: status_1
- user_id: user_id - user_id: user_id
- description: description - description: description
@ -159,7 +161,6 @@ Request
- source_cgid: source_cgid - source_cgid: source_cgid
- project_id: project_id - project_id: project_id
- name: name - name: name
- project_id: project_id_path
Request Example Request Example
--------------- ---------------
@ -183,9 +184,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- force: force
- project_id: project_id_path - project_id: project_id_path
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id_2
- consistencygroup: consistencygroup
- force: force
Request Example Request Example
--------------- ---------------
@ -203,7 +205,6 @@ Lists consistency groups with details.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -212,8 +213,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- marker: marker - marker: marker
@ -223,6 +223,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- consistencygroups: consistencygroups
- status: status_1 - status: status_1
- description: description - description: description
- availability_zone: availability_zone - availability_zone: availability_zone
@ -253,12 +254,13 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- consistencygroup_id: consistencygroup_id_2
- consistencygroup: consistencygroup
- remove_volumes: remove_volumes - remove_volumes: remove_volumes
- description: description - description: description
- add_volumes: add_volumes - add_volumes: add_volumes
- name: name - name: name
- project_id: project_id_path
- consistencygroup_id: consistencygroup_id
Request Example Request Example
--------------- ---------------

View File

@ -11,7 +11,8 @@ Force-delete a backup
.. rest_method:: POST /v3/{project_id}/backups/{backup_id}/action .. rest_method:: POST /v3/{project_id}/backups/{backup_id}/action
Force-deletes a backup. Specify the ``os-force_delete`` action in the request body. Force-deletes a backup. Specify the ``os-force_delete`` action in the request
body.
This operations deletes the backup and any backup data. This operations deletes the backup and any backup data.
@ -19,6 +20,7 @@ The backup driver returns the ``405`` status code if it does not
support this operation. support this operation.
Normal response codes: 202 Normal response codes: 202
Error response codes: itemNotFound(404), badMethod(405) Error response codes: itemNotFound(404), badMethod(405)
Request Request
@ -26,9 +28,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- os-force_delete: os-force_delete
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id
- os-force_delete: os-force_delete
Request Example Request Example
--------------- ---------------
@ -43,9 +45,11 @@ Reset a backup's status
.. rest_method:: POST /v3/{project_id}/backups/{backup_id}/action .. rest_method:: POST /v3/{project_id}/backups/{backup_id}/action
Reset a backup's status. Specify the ``os-reset_status`` action in the request body. Reset a backup's status. Specify the ``os-reset_status`` action in the request
body.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -54,10 +58,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_10
- os-reset_status: os-reset_status
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id
- os-reset_status: os-reset_status
- status: status_10
Request Example Request Example
--------------- ---------------

View File

@ -48,6 +48,7 @@ API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -57,8 +58,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -69,6 +69,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- backups: backups
- status: status_4 - status: status_4
- object_count: object_count - object_count: object_count
- fail_reason: fail_reason - fail_reason: fail_reason
@ -81,7 +82,6 @@ Response Parameters
- has_dependent_backups: has_dependent_backups - has_dependent_backups: has_dependent_backups
- volume_id: volume_id - volume_id: volume_id
- container: container - container: container
- backups: backups
- size: size - size: size
- id: id_1 - id: id_1
- is_incremental: is_incremental - is_incremental: is_incremental
@ -105,7 +105,6 @@ Shows details for a backup.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -122,6 +121,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- backup: backup
- status: status_4 - status: status_4
- object_count: object_count - object_count: object_count
- container: container - container: container
@ -157,6 +157,7 @@ Delete a backup
Deletes a backup. Deletes a backup.
Normal response codes: 202, Normal response codes: 202,
Error response codes: Bad Request(400) Error response codes: Bad Request(400)
Request Request
@ -179,6 +180,7 @@ You must specify either the UUID or name of the volume. If you
specify both the UUID and name, the UUID takes priority. specify both the UUID and name, the UUID takes priority.
Normal response codes: 202, Normal response codes: 202,
Error response codes: Bad Request(400), Request Entity Too Large(413) Error response codes: Bad Request(400), Request Entity Too Large(413)
@ -187,11 +189,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- restore: restore
- name: name_1
- volume_id: volume_id
- project_id: project_id_path - project_id: project_id_path
- backup_id: backup_id - backup_id: backup_id
- restore: restore
- name: name_8
- volume_id: volume_id_6
Request Example Request Example
--------------- ---------------
@ -223,6 +225,7 @@ Create a backup
Creates a Block Storage backup from a volume. Creates a Block Storage backup from a volume.
Normal response codes: 202, Normal response codes: 202,
Error response codes: Bad Request(400), Internal Server Error(500) Error response codes: Bad Request(400), Internal Server Error(500)
Request Request
@ -230,15 +233,15 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- backup: backup
- volume_id: volume_id_2
- container: container - container: container
- description: description - description: description
- incremental: incremental - incremental: incremental
- volume_id: volume_id
- force: force - force: force
- backup: backup
- name: name_optional - name: name_optional
- snapshot_id: snapshot_id_2 - snapshot_id: snapshot_id_3
- project_id: project_id_path
- metadata: metadata_9 - metadata: metadata_9
Request Example Request Example
@ -265,7 +268,8 @@ Update a backup
Update a Block Storage backup. This API is available since v3.9. Update a Block Storage backup. This API is available since v3.9.
Normal response codes: 202, Normal response codes: 202
Error response codes: Bad Request(400) Error response codes: Bad Request(400)
Request Request
@ -313,6 +317,7 @@ since v3.31 if non-admin users specify invalid filters in the
url, API will return bad request. url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
Request Request
@ -321,8 +326,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- marker: marker - marker: marker

View File

@ -16,6 +16,7 @@ List replication targets
Lists replication targets for a group. Lists replication targets for a group.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -57,6 +58,7 @@ Enable group replication
Enable replication for a group. Enable replication for a group.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
Request Request
@ -81,6 +83,7 @@ Disable group replication
Disable replication for a group. Disable replication for a group.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
Request Request
@ -105,6 +108,7 @@ Failover replication
Failover a replicated group. Failover a replicated group.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
Request Request

View File

@ -15,6 +15,7 @@ Delete group snapshot
Deletes a group snapshot. Deletes a group snapshot.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -36,6 +37,7 @@ Shows details for a group snapshot.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -53,12 +55,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_7 - group_snapshot: group_snapshot
- description: description
- created_at: created_at - created_at: created_at
- group_id: group_id_1 - group_id: source_group_id
- id: id - id: group_snapshot_id_1
- name: name - name: name_18
- status: status_7
- description: description_14
Response Example Response Example
---------------- ----------------
@ -72,11 +75,12 @@ List group snapshots with details
.. rest_method:: GET /v3/{project_id}/group_snapshots/detail .. rest_method:: GET /v3/{project_id}/group_snapshots/detail
Lists all group snapshots with details, since v3.31 if non-admin Lists all group snapshots with details. Since v3.31 if non-admin
users specify invalid filters in the url, API will return bad request. users specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
Request Request
@ -97,12 +101,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_snapshots: group_snapshots
- id: group_snapshot_id_1
- name: name_18
- status: status_7 - status: status_7
- description: description - description: description_14
- created_at: created_at - created_at: created_at
- group_id: group_id_1 - group_id: group_id_1
- id: id
- name: name
Response Example Response Example
---------------- ----------------
@ -120,6 +125,7 @@ specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -141,8 +147,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: id - group_snapshots: group_snapshots
- name: name - id: group_snapshot_id_1
- name: name_18
Response Example Response Example
@ -160,6 +167,7 @@ Create group snapshot
Creates a group snapshot. Creates a group snapshot.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -168,10 +176,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- name: name
- description: description
- group_id: group_id_1
- project_id: project_id_path - project_id: project_id_path
- group_snapshot: group_snapshot
- name: name_18
- description: description_14
- group_id: group_id_1
Request Example Request Example
--------------- ---------------
@ -184,12 +193,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_snapshot: group_snapshot
- id: group_snapshot_id_1
- name: name_18
- status: status_7 - status: status_7
- description: description - description: description_14
- created_at: created_at - created_at: created_at
- group_id: group_id_1 - group_id: group_id_1
- id: id
- name: name
Response Example Response Example
---------------- ----------------
@ -206,6 +216,7 @@ Reset group snapshot status
Resets the status for a group snapshot. Specifies the ``reset_status`` action in the request body. Resets the status for a group snapshot. Specifies the ``reset_status`` action in the request body.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -214,10 +225,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- reset_status: reset_status
- status: status
- project_id: project_id - project_id: project_id
- group_snapshot_id: group_snapshot_id - group_snapshot_id: group_snapshot_id
- reset_status: reset_status
- status: status_7
Request Example Request Example
--------------- ---------------

View File

@ -13,6 +13,7 @@ this API will update the specification as well.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), forbidden(403), itemNotFound(404) Error response codes: badRequest(400), forbidden(403), itemNotFound(404)
@ -21,9 +22,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_specs: group_specs_2
- group_type_id: group_type_id_1
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1
- group_specs: group_specs_2
Request Example Request Example
--------------- ---------------
@ -57,6 +58,7 @@ List all the group specs for a group type,
Normal response codes: 200 Normal response codes: 200
Error response codes: itemNotFound(404), forbidden(403) Error response codes: itemNotFound(404), forbidden(403)
@ -65,8 +67,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type_id: group_type_id_1
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1
Response Parameters Response Parameters
@ -93,6 +95,7 @@ Show a group spec for a group type,
Normal response codes: 200 Normal response codes: 200
Error response codes: itemNotFound(404), forbidden(403) Error response codes: itemNotFound(404), forbidden(403)
@ -101,8 +104,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type_id: group_type_id_1
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1
- spec_id: spec_id - spec_id: spec_id
@ -129,6 +132,7 @@ Update a group spec for a group type,
Normal response codes: 202 Normal response codes: 202
Error response codes: itemNotFound(404), forbidden(403) Error response codes: itemNotFound(404), forbidden(403)
@ -137,8 +141,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type_id: group_type_id_1
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1
- spec_id: spec_id - spec_id: spec_id
- spec: spec_value - spec: spec_value
@ -166,6 +170,7 @@ Delete a group spec for a group type,
Normal response codes: 202 Normal response codes: 202
Error response codes: itemNotFound(404), forbidden(403) Error response codes: itemNotFound(404), forbidden(403)
@ -174,6 +179,6 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type_id: group_type_id_1
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id_1
- spec_id: spec_id - spec_id: spec_id

View File

@ -14,6 +14,7 @@ Updates a group type.
To create a generic volume group, you must specify a group type. To create a generic volume group, you must specify a group type.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400), forbidden(403), itemNotFound(404), Error response codes: badRequest(400), forbidden(403), itemNotFound(404),
conflict(409), computeFault(500) conflict(409), computeFault(500)
@ -23,9 +24,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type: group_type
- group_type_id: group_type_id
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id
- group_type: group_type
- name: name_16
- description: description_12
Request Example Request Example
--------------- ---------------
@ -39,11 +42,12 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- is_public: is_public
- group_specs: group_specs
- description: description
- group_type: group_type - group_type: group_type
- name: name - id: group_type_id_2
- is_public: is_public_1
- group_specs: group_specs
- description: description_12
- name: name_16
Response Example Response Example
---------------- ----------------
@ -61,6 +65,7 @@ Shows details for a group type.
Normal response codes: 200 Normal response codes: 200
Error response codes: itemNotFound(404) Error response codes: itemNotFound(404)
Request Request
@ -68,8 +73,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type_id: group_type_id
- project_id: project_id_path - project_id: project_id_path
- group_type_id: group_type_id
Response Parameters Response Parameters
@ -77,11 +82,12 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- is_public: is_public
- group_specs: group_specs
- description: description
- group_type: group_type - group_type: group_type
- name: name - id: group_type_id_2
- name: name_16
- is_public: is_public_1
- group_specs: group_specs
- description: description_12
Response Example Response Example
@ -99,6 +105,7 @@ Delete group type
Deletes a group type. Deletes a group type.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), forbidden(403), itemNotFound(404) Error response codes: badRequest(400), forbidden(403), itemNotFound(404)
@ -120,7 +127,6 @@ Lists group types.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -129,8 +135,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -142,9 +147,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_types: group_types - group_types: group_types
- group_specs: group_specs - id: group_type_id_2
- name: name - group_specs: group_specs_2
- group_type: group_type - name: name_16
Response Example Response Example
---------------- ----------------
@ -164,6 +169,7 @@ To create a generic volume group, you must specify a group type.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), forbidden(403), itemNotFound(404), Error response codes: badRequest(400), forbidden(403), itemNotFound(404),
conflict(409) conflict(409)
@ -173,8 +179,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group_type: group_type
- project_id: project_id_path - project_id: project_id_path
- group_type: group_type
- name: name_16
- description: description_12
- group_specs: group_specs
Request Example Request Example
--------------- ---------------
@ -188,11 +197,12 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- is_public: is_public
- group_specs: group_specs
- description: description
- group_type: group_type - group_type: group_type
- name: name - id: group_type_id_2
- is_public: is_public_1
- group_specs: group_specs
- description: description_12
- name: name_16
Response Example Response Example

View File

@ -22,11 +22,12 @@ List groups
.. rest_method:: GET /v3/{project_id}/groups .. rest_method:: GET /v3/{project_id}/groups
Lists groups, since v3.31 if non-admin users specify Lists groups. Since v3.31 if non-admin users specify
invalid filters in the url, API will return bad request. invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -36,8 +37,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -48,8 +48,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- groups: groups
- id: id - id: id
- name: name - name: group_name
Response Example Response Example
---------------- ----------------
@ -66,6 +67,7 @@ Create group
Creates a group. Creates a group.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -74,12 +76,13 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- group: group
- description: description - description: description
- availability_zone: availability_zone - availability_zone: availability_zone
- group_type: group_type - group_type: group_type
- volume_types: volume_types - volume_types: volume_types
- name: name - name: group_name
- project_id: project_id_path
Request Example Request Example
--------------- ---------------
@ -96,6 +99,7 @@ Show group details
Shows details for a group. Shows details for a group.
Normal response codes: 200 Normal response codes: 200
Error response codes: itemNotFound(404) Error response codes: itemNotFound(404)
Request Request
@ -111,6 +115,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- group: group
- status: status_8 - status: status_8
- description: description - description: description
- availability_zone: availability_zone - availability_zone: availability_zone
@ -118,7 +123,7 @@ Response Parameters
- group_type: group_type - group_type: group_type
- volume_types: volume_types - volume_types: volume_types
- id: id - id: id
- name: name - name: group_name
- replication_status: group_replication_status - replication_status: group_replication_status
Response Example Response Example
@ -136,6 +141,7 @@ Create group from source
Creates a group from source. Creates a group from source.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -144,11 +150,12 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- description: description
- group_snapshot_id: group_snapshot_id
- source_group_id: source_group_id
- name: name
- project_id: project_id_path - project_id: project_id_path
- create-from-src: create-from-src
- description: description
- group_snapshot_id: group_snapshot_id_1
- source_group_id: source_group_id
- name: group_name
Request Example Request Example
--------------- ---------------
@ -165,6 +172,7 @@ Delete group
Deletes a group. Deletes a group.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -173,9 +181,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- delete-volumes: delete-volumes
- project_id: project_id_path - project_id: project_id_path
- group_id: group_id - group_id: group_id
- delete: delete
- delete-volumes: delete-volumes
Request Example Request Example
--------------- ---------------
@ -194,6 +203,7 @@ users specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -203,8 +213,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -215,13 +224,14 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- groups: groups
- status: status_8 - status: status_8
- description: description - description: description
- availability_zone: availability_zone - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- group_type: group_type - group_type: group_type
- volume_types: volume_types - volume_types: volume_types
- id: id - id: group_id
- name: name - name: name
Response Example Response Example
@ -239,6 +249,7 @@ Update group
Updates a group. Updates a group.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -247,12 +258,13 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- group_id: group_id
- group: group
- remove_volumes: remove_volumes - remove_volumes: remove_volumes
- description: description - description: description
- add_volumes: add_volumes - add_volumes: add_volumes
- name: name - name: group_name
- project_id: project_id_path
- group_id: group_id
Request Example Request Example
--------------- ---------------
@ -269,6 +281,7 @@ Reset group status
Resets the status for a group. Specify the ``reset_status`` action in the request body. Resets the status for a group. Specify the ``reset_status`` action in the request body.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -277,10 +290,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- reset_status: reset_status
- status: status
- project_id: project_id - project_id: project_id
- group_id: group_id - group_id: group_id
- reset_status: reset_status
- status: status
Request Example Request Example
--------------- ---------------

View File

@ -16,7 +16,6 @@ List all hosts for a project
Lists all hosts summary info that is not disabled. Lists all hosts summary info that is not disabled.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
------- -------
@ -31,6 +30,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- hosts: hosts
- service-status: service_status - service-status: service_status
- service: host_service - service: host_service
- zone: availability_zone_3 - zone: availability_zone_3
@ -68,6 +68,7 @@ Response
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- host: host
- volume_count: total_count - volume_count: total_count
- total_volume_gb: totalGigabytesUsed - total_volume_gb: totalGigabytesUsed
- total_snapshot_gb: totalSnapshotsUsed - total_snapshot_gb: totalSnapshotsUsed
@ -75,7 +76,8 @@ Response
- host: host - host: host
- snapshot_count: totalSnapshotsUsed - snapshot_count: totalSnapshotsUsed
**Example Show Host Details** Response Example
----------------
.. literalinclude:: ./samples/hosts-get-response.json .. literalinclude:: ./samples/hosts-get-response.json
:language: javascript :language: javascript

View File

@ -21,7 +21,8 @@ for the item is infinite.
Normal response codes: 200 Normal response codes: 200
Error response codes:203,
Error response codes: 203
Request Request
------- -------
@ -35,19 +36,19 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- limits: limits
- rate: rate
- absolute: absolute
- totalSnapshotsUsed: totalSnapshotsUsed - totalSnapshotsUsed: totalSnapshotsUsed
- maxTotalBackups: maxTotalBackups - maxTotalBackups: maxTotalBackups
- maxTotalVolumeGigabytes: maxTotalVolumeGigabytes - maxTotalVolumeGigabytes: maxTotalVolumeGigabytes
- limits: limits
- maxTotalSnapshots: maxTotalSnapshots - maxTotalSnapshots: maxTotalSnapshots
- maxTotalBackupGigabytes: maxTotalBackupGigabytes - maxTotalBackupGigabytes: maxTotalBackupGigabytes
- totalBackupGigabytesUsed: totalBackupGigabytesUsed - totalBackupGigabytesUsed: totalBackupGigabytesUsed
- maxTotalVolumes: maxTotalVolumes - maxTotalVolumes: maxTotalVolumes
- totalVolumesUsed: totalVolumesUsed - totalVolumesUsed: totalVolumesUsed
- rate: rate
- totalBackupsUsed: totalBackupsUsed - totalBackupsUsed: totalBackupsUsed
- totalGigabytesUsed: totalGigabytesUsed - totalGigabytesUsed: totalGigabytesUsed
- absolute: absolute
Response Example Response Example
---------------- ----------------

View File

@ -14,6 +14,7 @@ Delete message
Deletes a message. Deletes a message.
Normal response codes: 202 Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -35,6 +36,7 @@ Shows details for a message.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404) Error response codes: badRequest(400), itemNotFound(404)
@ -52,6 +54,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- message: user_message
- request_id: request_id - request_id: request_id
- links: links_5 - links: links_5
- message_level: message_level - message_level: message_level
@ -80,6 +83,7 @@ specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -89,8 +93,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -100,6 +103,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- messages: user_messages
- request_id: request_id - request_id: request_id
- links: links_5 - links: links_5
- message_level: message_level - message_level: message_level

View File

@ -23,7 +23,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- cgsnapshot_id: cgsnapshot_id - cgsnapshot_id: cgsnapshot_id_1
Show consistency group snapshot detail Show consistency group snapshot detail
@ -35,7 +35,6 @@ Shows details for a consistency group snapshot.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -44,7 +43,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- cgsnapshot_id: cgsnapshot_id - cgsnapshot_id: cgsnapshot_id_1
Response Parameters Response Parameters
@ -52,12 +51,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- cgsnapshot: cgsnapshot
- status: status - status: status
- description: description - description: description
- created_at: created_at - created_at: created_at
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id
- id: id - id: id
- name: name - name: name_2
Response Example Response Example
---------------- ----------------
@ -75,7 +75,6 @@ Lists all consistency group snapshots with details.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
------- -------
@ -90,12 +89,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- cgsnapshots: cgsnapshots
- status: status - status: status
- description: description - description: description
- created_at: created_at - created_at: created_at
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id
- id: id - id: id
- name: name - name: name_2
Response Example Response Example
---------------- ----------------
@ -112,7 +112,6 @@ Lists all consistency group snapshots.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -128,8 +127,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- cgsnapshots: cgsnapshots
- id: id - id: id
- name: name - name: name_2
@ -156,8 +156,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- name: name
- project_id: project_id_path - project_id: project_id_path
- cgsnapshot: cgsnapshot
- name: name_5
- consistencygroup_id: consistencygroup_id
- description: description
Request Example Request Example
--------------- ---------------
@ -175,4 +178,4 @@ Response Parameters
- created_at: created_at - created_at: created_at
- consistencygroup_id: consistencygroup_id - consistencygroup_id: consistencygroup_id
- id: id - id: id
- name: name - name: name_2

View File

@ -72,8 +72,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- binary: binary - host: host_query
- host: host_name_body - binary: binary_query
Request Example Request Example
--------------- ---------------

View File

@ -12,11 +12,12 @@ List all back-end storage pools
.. rest_method:: GET /v3/{project_id}/scheduler-stats/get_pools .. rest_method:: GET /v3/{project_id}/scheduler-stats/get_pools
Lists all back-end storage pools, since v3.31 if non-admin users Lists all back-end storage pools. Since v3.31 if non-admin users
specify invalid filters in the url, API will return bad request. specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
Request Request
@ -32,6 +33,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- pools: pools
- updated: updated - updated: updated
- QoS_support: QoS_support - QoS_support: QoS_support
- name: name - name: name

View File

@ -21,9 +21,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- auth_key: auth_key
- transfer_id: transfer_id
- project_id: project_id_path - project_id: project_id_path
- transfer_id: transfer_id
- auth_key: auth_key
Request Example Request Example
--------------- ---------------
@ -59,9 +59,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- transfer: transfer
- name: name - name: name
- volume_id: volume_id - volume_id: volume_id
- project_id: project_id_path
Request Example Request Example
--------------- ---------------
@ -92,7 +93,6 @@ Lists volume transfers.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -130,7 +130,6 @@ Shows details for a volume transfer.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -138,8 +137,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- transfer_id: transfer_id
- project_id: project_id_path - project_id: project_id_path
- transfer_id: transfer_id
Response Parameters Response Parameters
@ -176,8 +175,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- transfer_id: transfer_id
- project_id: project_id_path - project_id: project_id_path
- transfer_id: transfer_id
List volume transfers and details List volume transfers and details
@ -189,7 +188,6 @@ Lists volume transfers, with details.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
------- -------
@ -203,6 +201,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- transfers: transfers
- created_at: created_at - created_at: created_at
- volume_id: volume_id - volume_id: volume_id
- id: id - id: id

View File

@ -41,13 +41,13 @@ cgsnapshot_id_1:
description: | description: |
The ID of the consistency group snapshot. The ID of the consistency group snapshot.
in: path in: path
required: false required: true
type: string type: string
consistencygroup_id_2: consistencygroup_id_2:
description: | description: |
The ID of the consistency group. The ID of the consistency group.
in: path in: path
required: false required: true
type: string type: string
encryption_id: encryption_id:
description: | description: |
@ -55,13 +55,6 @@ encryption_id:
in: path in: path
required: true required: true
type: string type: string
force_3:
description: |
To delete a QoS specification even if it is in-
use, set to ``true``. Default is ``false``.
in: path
required: false
type: boolean
group_id: group_id:
description: | description: |
The ID of the group. The ID of the group.
@ -72,7 +65,7 @@ group_snapshot_id:
description: | description: |
The ID of the group snapshot. The ID of the group snapshot.
in: path in: path
required: false required: true
type: string type: string
group_type_id: group_type_id:
description: | description: |
@ -114,6 +107,12 @@ key_3:
in: path in: path
required: true required: true
type: string type: string
message_id:
description: |
The UUID of the message.
in: path
required: true
type: string
project_id_path: project_id_path:
description: | description: |
The UUID of the project in a multi-tenancy cloud. The UUID of the project in a multi-tenancy cloud.
@ -138,23 +137,23 @@ quotas_project_id:
in: path in: path
required: true required: true
type: string type: string
resource:
description: |
Filter filters by resource name.
in: path
required: false
type: string
snapshot_id_path: snapshot_id_path:
description: | description: |
The UUID of the snapshot. The UUID of the snapshot.
in: path in: path
required: true required: true
type: string type: string
spec_id:
description: |
The id (key) of the group specification.
in: path
required: true
type: string
transfer_id: transfer_id:
description: | description: |
The unique identifier for a volume transfer. The unique identifier for a volume transfer.
in: path in: path
required: false required: true
type: string type: string
user_id_1: user_id_1:
description: | description: |
@ -185,7 +184,7 @@ volume_type_id:
description: | description: |
The UUID for an existing volume type. The UUID for an existing volume type.
in: path in: path
required: false required: true
type: string type: string
# variables in query # variables in query
@ -221,6 +220,13 @@ detail:
in: query in: query
required: false required: false
type: boolean 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: host_query:
description: | description: |
Filter the service list result by host name of the service. Filter the service list result by host name of the service.
@ -284,12 +290,6 @@ marker_group_snapshot:
required: false required: false
type: string type: string
min_version: 3.29 min_version: 3.29
message_id:
description: |
The UUID of the message.
in: query
required: true
type: string
metadata_query: metadata_query:
description: | description: |
Filters results by a metadata key and value pair. Filters results by a metadata key and value pair.
@ -325,6 +325,12 @@ offset_group_snapshot:
required: false required: false
type: integer type: integer
min_version: 3.29 min_version: 3.29
resource:
description: |
Filter for resource name.
in: query
required: false
type: string
sort: sort:
description: | description: |
Comma-separated list of sort keys and optional Comma-separated list of sort keys and optional
@ -381,12 +387,6 @@ sort_key_group_snapshot:
required: false required: false
type: string type: string
min_version: 3.29 min_version: 3.29
spec_id:
description: |
The id (key) of the group specification.
in: query
required: true
type: string
status_query: status_query:
description: | description: |
Filters results by a status. Default=None. Filters results by a status. Default=None.
@ -400,6 +400,12 @@ usage:
in: query in: query
required: false required: false
type: boolean type: boolean
vol_type_id_query:
description: |
A volume type ID.
in: query
required: true
type: string
# variables in body # variables in body
absolute: absolute:
@ -454,9 +460,15 @@ attached_at:
in: body in: body
required: false required: false
type: string type: string
attachment:
description: |
An attachment object.
in: body
required: true
type: object
attachment_id: attachment_id:
description: | description: |
The interface ID. The ID of the attachment.
in: body in: body
required: false required: false
type: string type: string
@ -604,12 +616,24 @@ capabilities:
in: body in: body
required: true required: true
type: object type: object
cgsnapshot:
description: |
A consistency group snapshot object.
in: body
required: true
type: object
cgsnapshot_id: cgsnapshot_id:
description: | description: |
The UUID of the consistency group snapshot. The UUID of the consistency group snapshot.
in: body in: body
required: false required: false
type: string type: string
cgsnapshots:
description: |
A collection of ``cgsnapshot`` objects.
in: body
required: true
type: object
cinder_id: cinder_id:
description: | description: |
The UUID of the snapshot in Cinder. The UUID of the snapshot in Cinder.
@ -663,6 +687,18 @@ connector_1:
in: body in: body
required: true required: true
type: object 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: consistencygroup_id:
description: | description: |
The UUID of the consistency group. The UUID of the consistency group.
@ -675,6 +711,12 @@ consistencygroup_id_1:
in: body in: body
required: false required: false
type: string type: string
consistencygroups:
description: |
A list of consistency groups.
in: body
required: true
type: array
consumer: consumer:
description: | description: |
The consumer type. The consumer type.
@ -695,7 +737,7 @@ container:
type: string type: string
container_format: container_format:
description: | description: |
Container format for the new image. Defualt is bare. Container format for the new image. Default is bare.
in: body in: body
required: false required: false
type: string type: string
@ -706,6 +748,12 @@ control_location:
in: body in: body
required: false required: false
type: string type: string
create-from-src:
description: |
The create from source action.
in: body
required: true
type: object
created_at: created_at:
description: | description: |
The date and time when the resource was created. The date and time when the resource was created.
@ -739,6 +787,12 @@ data_timestamp:
in: body in: body
required: true required: true
type: string type: string
delete:
description: |
The delete action.
in: body
required: true
type: object
delete-volumes: delete-volumes:
description: | description: |
If set to ``true``, allows deletion of a If set to ``true``, allows deletion of a
@ -1052,24 +1106,48 @@ gigabytes_usage:
in: body in: body
required: true required: true
type: object type: object
group:
description: |
A group object.
in: body
required: true
type: object
group_id_1: group_id_1:
description: | description: |
The ID of the group. The ID of the group.
in: body in: body
required: false required: false
type: string type: string
group_name:
description: |
The group name.
in: body
required: true
type: string
group_replication_status: group_replication_status:
description: | description: |
The group replication status. Introduced with API microversion 3.38. The group replication status. Introduced with API microversion 3.38.
in: body in: body
required: false required: false
type: string type: string
group_snapshot:
description: |
The group snapshot.
in: body
required: true
type: object
group_snapshot_id_1: group_snapshot_id_1:
description: | description: |
The ID of the group snapshot. The ID of the group snapshot.
in: body in: body
required: false required: true
type: string type: string
group_snapshots:
description: |
A collection of group snapshots.
in: body
required: true
type: array
group_specs: group_specs:
description: | description: |
A set of key and value pairs that contains the A set of key and value pairs that contains the
@ -1090,12 +1168,24 @@ group_type:
in: body in: body
required: true required: true
type: object type: object
group_type_id_2:
description: |
The group type ID.
in: body
required: true
type: string
group_types: group_types:
description: | description: |
The list of group types. The list of group types.
in: body in: body
required: true required: true
type: array type: array
groups:
description: |
A collections of groups.
in: body
required: true
type: array
groups_number: groups_number:
description: | description: |
The number of groups that are allowed for each project. The number of groups that are allowed for each project.
@ -1130,7 +1220,7 @@ host:
existing volume resides. existing volume resides.
in: body in: body
required: true required: true
type: string type: object
host_mutex: host_mutex:
description: | description: |
The OpenStack Block Storage host where the existing resource resides. The OpenStack Block Storage host where the existing resource resides.
@ -1162,6 +1252,12 @@ host_service:
in: body in: body
required: true required: true
type: string type: string
hosts:
description: |
A OpenStack Block Storage host.
in: body
required: true
type: object
id: id:
description: | description: |
The UUID of the volume transfer. The UUID of the volume transfer.
@ -1265,13 +1361,13 @@ is_incremental:
type: boolean type: boolean
is_public: is_public:
description: description:
Volume type which is accessible to the public. Whether the volume type is publicly visible.
in: body in: body
required: false required: false
type: boolean type: boolean
is_public_1: is_public_1:
description: description:
Group type which is accessible to the public. Whether the group is publicly visible.
in: body in: body
required: false required: false
type: boolean type: boolean
@ -1921,6 +2017,12 @@ pool_name:
in: body in: body
required: true required: true
type: string type: string
pools:
description: |
List of storage pools.
in: body
required: true
type: array
prefix: prefix:
description: | description: |
The prefix for the log path we are querying, The prefix for the log path we are querying,
@ -1975,6 +2077,12 @@ provider_optional:
in: body in: body
required: false required: false
type: string type: string
qos_set_id:
description: |
The QoS set ID.
in: body
required: true
type: string
qos_specs: qos_specs:
description: | description: |
A ``qos_specs`` object. A ``qos_specs`` object.
@ -1993,6 +2101,12 @@ quota_class_id:
in: body in: body
required: true required: true
type: string type: string
quota_class_set:
description: |
A ``quota_class_set`` object.
in: body
required: true
type: object
quota_set: quota_set:
description: | description: |
A ``quota_set`` object. A ``quota_set`` object.
@ -2020,7 +2134,7 @@ ref:
structure, see the documentation for the volume driver. structure, see the documentation for the volume driver.
in: body in: body
required: true required: true
type: string type: object
ref_1: ref_1:
description: | description: |
A reference to the existing volume. The internal A reference to the existing volume. The internal
@ -2098,6 +2212,12 @@ resource_filters:
in: body in: body
required: true required: true
type: array type: array
resource_filters_1:
description: |
A collection of resource filters.
in: body
required: true
type: array
resource_id: resource_id:
description: | description: |
The UUID of a resource to cleanup. The UUID of a resource to cleanup.
@ -2230,7 +2350,7 @@ snapshot_id_2:
description: | description: |
The UUID of the source volume snapshot. The UUID of the source volume snapshot.
in: body in: body
required: true required: false
type: string type: string
snapshot_id_3: snapshot_id_3:
description: | description: |
@ -2292,7 +2412,7 @@ source_group_id:
description: | description: |
The UUID of the source group. The UUID of the source group.
in: body in: body
required: false required: true
type: string type: string
source_reference: source_reference:
description: | description: |
@ -2485,6 +2605,18 @@ totalVolumesUsed:
in: body in: body
required: true required: true
type: integer 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: updated:
description: | description: |
The date and time stamp when the extension was The date and time stamp when the extension was
@ -2537,7 +2669,13 @@ user_message:
description: | description: |
The translated readable message corresponding to ``event_id``. The translated readable message corresponding to ``event_id``.
in: body in: body
required: false required: true
type: string
user_messages:
description: |
A collection of user messages.
in: body
required: true
type: string type: string
vendor_name: vendor_name:
description: | description: |

View File

@ -38,7 +38,6 @@ Unsets keys in a QoS specification.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -46,9 +45,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- keys: keys
- project_id: project_id_path - project_id: project_id_path
- qos_id: qos_id - qos_id: qos_id
- keys: keys
Request Example Request Example
--------------- ---------------
@ -57,14 +56,6 @@ Request Example
:language: javascript :language: javascript
Response Example
----------------
.. literalinclude:: ./samples/qos-unset-response.json
:language: javascript
Get all associations for a QoS specification Get all associations for a QoS specification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -74,7 +65,6 @@ Lists all associations for a QoS specification.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -86,6 +76,19 @@ Request
- qos_id: qos_id - qos_id: qos_id
Response
--------
.. rest_parameters:: parameters.yaml
- qos_specs: qos_specs
- specs: specs
- consumer: consumer_1
- name: name_4
- id: id_3
- links: links_2
Response Example Response Example
---------------- ----------------
@ -110,7 +113,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- qos_id: qos_id - qos_id: qos_id
- vol_type_id: vol_type_id - vol_type_id: vol_type_id_query
Disassociate QoS specification from a volume type Disassociate QoS specification from a volume type
@ -130,7 +133,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- qos_id: qos_id - qos_id: qos_id
- vol_type_id: vol_type_id - vol_type_id: vol_type_id_query
Show a QoS specification details Show a QoS specification details
@ -142,7 +145,8 @@ Shows details for a QoS specification.
Normal response codes: 200 Normal response codes: 200
Error response codes:413,405,404,403,401,400,503,
Error response codes: 413,405,404,403,401,400,503
Request Request
@ -159,12 +163,12 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- name: name
- links: links
- id: id
- qos_specs: qos_specs - qos_specs: qos_specs
- consumer: consumer
- specs: specs - specs: specs
- consumer: consumer
- name: name_4
- id: id_3
- links: links_2
Response Example Response Example
@ -183,7 +187,6 @@ Sets keys in a QoS specification.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -191,10 +194,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- qos_specs: qos_specs
- specs: specs
- project_id: project_id_path - project_id: project_id_path
- qos_id: qos_id - qos_id: qos_id
- qos_specs: qos_specs
Request Example Request Example
--------------- ---------------
@ -202,6 +204,13 @@ Request Example
.. literalinclude:: ./samples/qos-update-request.json .. literalinclude:: ./samples/qos-update-request.json
:language: javascript :language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- qos_specs: qos_specs
Response Example Response Example
---------------- ----------------
@ -227,7 +236,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- qos_id: qos_id - qos_id: qos_id
- force: force - force: force_3
Create a QoS specification Create a QoS specification
@ -247,10 +256,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- qos_specs: qos_specs
- consumer: consumer
- name: name
- project_id: project_id_path - project_id: project_id_path
- qos_specs: qos_specs
- name: name_4
Request Example Request Example
--------------- ---------------
@ -265,10 +273,10 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- name: name
- links: links
- id: id
- qos_specs: qos_specs - qos_specs: qos_specs
- name: name_4
- links: links_2
- id: id_3
- consumer: consumer - consumer: consumer
- specs: specs - specs: specs
@ -282,7 +290,8 @@ Lists quality of service (QoS) specifications.
Normal response codes: 200 Normal response codes: 200
Error response codes:300,
Error response codes: 300
Request Request
@ -291,8 +300,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- marker: marker - marker: marker
@ -302,11 +310,11 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- specs: specs
- qos_specs: qos_specs - qos_specs: qos_specs
- specs: specs
- consumer: consumer - consumer: consumer
- id: id - id: id_3
- name: name - name: name_4
Response Example Response Example

View File

@ -16,6 +16,7 @@ Shows quota class set for a project. If no specific value for the quota class
resource exists, then the default value will be reported. resource exists, then the default value will be reported.
Normal response codes: 200 Normal response codes: 200
Error response codes: 403, 404 Error response codes: 403, 404
@ -33,6 +34,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- quota_class_set: quota_class_set
- backup_gigabytes: maxTotalBackupGigabytes - backup_gigabytes: maxTotalBackupGigabytes
- backups: maxTotalBackups - backups: maxTotalBackups
- gigabytes: maxTotalVolumeGigabytes - gigabytes: maxTotalVolumeGigabytes
@ -58,6 +60,7 @@ Updates quota class set for a tenant. If the ``quota_class_name`` key does not
exist, then the API will create one. exist, then the API will create one.
Normal response codes: 200 Normal response codes: 200
Error response codes: 400, 403, 404 Error response codes: 400, 403, 404
@ -85,6 +88,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- quota_class_set: quota_class_set
- backup_gigabytes: maxTotalBackupGigabytes - backup_gigabytes: maxTotalBackupGigabytes
- backups: maxTotalBackups - backups: maxTotalBackups
- gigabytes: maxTotalVolumeGigabytes - gigabytes: maxTotalVolumeGigabytes

View File

@ -17,7 +17,6 @@ Shows quotas for a project.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -25,8 +24,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: quotas_project_id
- admin_project_id: admin_project_id - admin_project_id: admin_project_id
- project_id: quotas_project_id
- usage: usage - usage: usage
@ -36,7 +35,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- quota_set: quota_set - quota_set: quota_set
- id: project_id - id: qos_set_id
- volumes: volumes_number - volumes: volumes_number
- volumes_{volume_type}: volumes_number_for_type - volumes_{volume_type}: volumes_number_for_type
- snapshots: snapshots_number - snapshots: snapshots_number
@ -64,7 +63,6 @@ Shows quota usage for a project.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -83,7 +81,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- quota_set: quota_set - quota_set: quota_set
- id: project_id - id: qos_set_id
- volumes: volumes_number_usage - volumes: volumes_number_usage
- volumes_{volume_type}: volumes_number_for_type_usage - volumes_{volume_type}: volumes_number_for_type_usage
- snapshots: snapshots_number_usage - snapshots: snapshots_number_usage
@ -112,7 +110,6 @@ Updates quotas for a project.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -174,7 +171,6 @@ Deletes quotas for a project so the quotas revert to default values.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -197,7 +193,6 @@ Gets default quotas for a project.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -215,7 +210,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- quota_set: quota_set - quota_set: quota_set
- id: project_id - id: qos_set_id
- volumes: volumes_number - volumes: volumes_number
- volumes_{volume_type}: volumes_number_for_type - volumes_{volume_type}: volumes_number_for_type
- snapshots: snapshots_number - snapshots: snapshots_number

View File

@ -15,7 +15,6 @@ List resource filters
List filters. List filters.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -31,6 +30,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- resource_filters: resource_filters_1
- filters: resource_filters - filters: resource_filters
- resource: resource_1 - resource: resource_1

View File

@ -3,8 +3,6 @@
"consistencygroup_id": "6f519a48-3183-46cf-a32f-41815f814546", "consistencygroup_id": "6f519a48-3183-46cf-a32f-41815f814546",
"name": "firstcg", "name": "firstcg",
"description": "first consistency group", "description": "first consistency group",
"user_id": "6f519a48-3183-46cf-a32f-41815f814444",
"project_id": "6f519a48-3183-46cf-a32f-41815f815555",
"status": "creating" "status": "creating"
} }
} }

View File

@ -3,9 +3,6 @@
"name": "first_group", "name": "first_group",
"description": "first group", "description": "first group",
"group_snapshot_id": "6f519a48-3183-46cf-a32f-41815f813986", "group_snapshot_id": "6f519a48-3183-46cf-a32f-41815f813986",
"source_group_id": None, "source_group_id": None
"user_id": "6f519a48-3183-46cf-a32f-41815f815555",
"project_id": "6f519a48-3183-46cf-a32f-41815f814444",
"status": "creating"
} }
} }

View File

@ -1,7 +1,5 @@
{ {
"qos_specs": { "qos_specs": {
"availability": "100",
"name": "reliability-spec", "name": "reliability-spec",
"numberOfFailures": "0"
} }
} }

View File

@ -1,6 +1,9 @@
{ {
"volume": { "volume": {
"name": "vol-003", "name": "vol-003",
"description": "This is yet, another volume." "description": "This is yet, another volume.",
"metadata": {
"name": "metadata0"
}
} }
} }

View File

@ -12,7 +12,8 @@ Manage an existing snapshot
.. rest_method:: POST /v3/{project_id}/manageable_snapshots .. rest_method:: POST /v3/{project_id}/manageable_snapshots
Creates a snapshot by using existing storage rather than allocating new storage. Creates a snapshot by using existing storage rather than allocating new
storage.
The caller must specify a reference to an existing storage volume The caller must specify a reference to an existing storage volume
in the ref parameter in the request. Although each storage driver in the ref parameter in the request. Although each storage driver
@ -32,12 +33,13 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- snapshot: snapshot_1
- description: description - description: description
- name: name - metadata: metadata_7
- name: name_5
- ref: ref - ref: ref
- volume_id: volume_id - volume_id: volume_id
- metadata: metadata
- project_id: project_id_path
Request Example Request Example
--------------- ---------------
@ -63,12 +65,12 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort: sort - sort: sort
- offset: offset - offset: offset
- limit: limit - limit: limit
- marker: marker - marker: marker
- project_id: project_id_path - host: host_query
- host: hostname
Response Response
@ -108,12 +110,12 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort: sort - sort: sort
- offset: offset - offset: offset
- limit: limit - limit: limit
- marker: marker - marker: marker
- project_id: project_id_path - host: host_query
- host: hostname
Response Response

View File

@ -12,7 +12,8 @@ Manage an existing volume
.. rest_method:: POST /v3/{project_id}/manageable_volumes .. rest_method:: POST /v3/{project_id}/manageable_volumes
Creates a Block Storage volume by using existing storage rather than allocating new storage. Creates a Block Storage volume by using existing storage rather than allocating
new storage.
The caller must specify a reference to an existing storage volume The caller must specify a reference to an existing storage volume
in the ref parameter in the request. Although each storage driver in the ref parameter in the request. Although each storage driver
@ -35,17 +36,17 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- volume: volume
- description: description - description: description
- availability_zone: availability_zone - availability_zone: availability_zone
- bootable: bootable - bootable: bootable
- volume_type: volume_type - volume_type: volume_type
- name: name - name: volume_name
- volume: volume
- host: host_mutex - host: host_mutex
- cluster: cluster_mutex - cluster: cluster_mutex
- ref: ref - ref: ref
- metadata: metadata - metadata: metadata
- project_id: project_id_path
Request Example Request Example
--------------- ---------------
@ -73,11 +74,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort: sort - sort: sort
- offset: offset - offset: offset
- limit: limit - limit: limit
- marker: marker - marker: marker
- project_id: project_id_path
- host: hostname - host: hostname
@ -117,12 +118,12 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort: sort - sort: sort
- offset: offset - offset: offset
- limit: limit - limit: limit
- marker: marker - marker: marker
- project_id: project_id_path - host: host_query
- host: hostname
Response Response

View File

@ -74,7 +74,6 @@ Lists project IDs that have access to private volume type.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request

View File

@ -15,6 +15,7 @@ Lists Block Storage API extensions.
Normal response codes: 200 Normal response codes: 200
Error response codes:300, Error response codes:300,

View File

@ -45,6 +45,7 @@ return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -54,8 +55,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -90,7 +90,8 @@ Create a snapshot
.. rest_method:: POST /v3/{project_id}/snapshots .. rest_method:: POST /v3/{project_id}/snapshots
Creates a volume snapshot, which is a point-in-time, complete copy of a volume. You can create a volume from a snapshot. Creates a volume snapshot, which is a point-in-time, complete copy of a volume.
You can create a volume from a snapshot.
Normal response codes: 202 Normal response codes: 202
@ -100,12 +101,12 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- snapshot: snapshot
- volume_id: volume_id
- force: force
- description: description
- name: name_12
- project_id: project_id_path - project_id: project_id_path
- snapshot: snapshot_1
- volume_id: volume_id
- name: name_12
- description: description
- force: force
- metadata: metadata_7 - metadata: metadata_7
Request Example Request Example
@ -123,7 +124,7 @@ Response Parameters
- description: description - description: description
- created_at: created_at - created_at: created_at
- name: name_12 - name: name_12
- snapshot: snapshot - snapshot: snapshot_1
- user_id: user_id_2 - user_id: user_id_2
- volume_id: volume_id - volume_id: volume_id
- metadata: metadata - metadata: metadata
@ -149,6 +150,7 @@ specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -158,8 +160,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -196,7 +197,6 @@ Shows metadata for a snapshot.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -218,7 +218,7 @@ Response Parameters
- description: description - description: description
- created_at: created_at - created_at: created_at
- name: name - name: name
- snapshot: snapshot - snapshot: snapshot_1
- volume_id: volume_id - volume_id: volume_id
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id - os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
- size: size - size: size
@ -244,7 +244,6 @@ are not in the request.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -252,9 +251,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- metadata: metadata
- project_id: project_id_path - project_id: project_id_path
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
- metadata: metadata
Request Example Request Example
--------------- ---------------
@ -262,6 +261,12 @@ Request Example
.. literalinclude:: ./samples/snapshot-metadata-create-request.json .. literalinclude:: ./samples/snapshot-metadata-create-request.json
:language: javascript :language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- metadata: metadata
Response Example Response Example
---------------- ----------------
@ -278,7 +283,6 @@ Replaces all the snapshot's metadata with the key-value pairs in the request.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -286,9 +290,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- metadata: metadata
- project_id: project_id_path - project_id: project_id_path
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
- metadata: metadata
Request Example Request Example
--------------- ---------------
@ -297,6 +301,13 @@ Request Example
:language: javascript :language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- metadata: metadata
Response Example Response Example
---------------- ----------------
@ -313,7 +324,6 @@ Shows details for a snapshot.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -335,7 +345,7 @@ Response Parameters
- description: description - description: description
- created_at: created_at - created_at: created_at
- name: name - name: name
- snapshot: snapshot - snapshot: snapshot_1
- user_id: user_id_2 - user_id: user_id_2
- volume_id: volume_id - volume_id: volume_id
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id - os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
@ -359,7 +369,6 @@ Updates a snapshot.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -367,11 +376,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- snapshot: snapshot
- description: description
- name: name
- project_id: project_id_path - project_id: project_id_path
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
- snapshot: snapshot_1
- description: description
- name: name
Request Example Request Example
--------------- ---------------
@ -390,12 +399,12 @@ Response Parameters
- description: description - description: description
- created_at: created_at - created_at: created_at
- name: name - name: name
- snapshot: snapshot - snapshot: snapshot_1
- user_id: user_id_2
- volume_id: volume_id
- metadata: metadata
- id: id - id: id
- size: size - size: size
- volume_id: volume_id
- user_id: user_id_2
- metadata: metadata
Response Example Response Example
---------------- ----------------
@ -423,8 +432,6 @@ Request
- snapshot_id: snapshot_id_path - snapshot_id: snapshot_id_path
Show a snapshot's metadata for a specific key Show a snapshot's metadata for a specific key
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -452,8 +459,6 @@ Response Parameters
- meta: meta_1 - meta: meta_1
Response Example Response Example
---------------- ----------------

View File

@ -26,7 +26,6 @@ guide/blockstorage_multi_backend.html>`_.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -34,9 +33,13 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type
- volume_type_id: volume_type_id
- project_id: project_id_path - project_id: project_id_path
- volume_type_id: volume_type_id
- volume_type: volume_type_1
- name: name_7
- description: description_15
- is_public: is_public
- extra_specs: extra_specs
Request Example Request Example
--------------- ---------------
@ -51,11 +54,11 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type_1
- is_public: is_public - is_public: is_public
- extra_specs: extra_specs - extra_specs: extra_specs
- description: description - description: description_15
- volume_type: volume_type - name: name_7
- name: name
Response Example Response Example
---------------- ----------------
@ -73,7 +76,6 @@ Updates the extra specifications that are assigned to a volume type.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -81,10 +83,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- extra_specs: extra_specs
- volume_type: volume_type
- volume_type_id: volume_type_id
- project_id: project_id_path - project_id: project_id_path
- volume_type_id: volume_type_id
- volume_type: volume_type_1
- extra_specs: extra_specs
Request Example Request Example
--------------- ---------------
@ -99,11 +101,11 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type_1
- is_public: is_public - is_public: is_public
- extra_specs: extra_specs - extra_specs: extra_specs
- description: description - description: description_15
- volume_type: volume_type - name: name_7
- name: name
Response Example Response Example
@ -122,7 +124,6 @@ Shows details for a volume type.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
------- -------
@ -138,11 +139,11 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type_1
- is_public: is_public - is_public: is_public
- extra_specs: extra_specs - extra_specs: extra_specs
- description: description - description: description_15
- volume_type: volume_type - name: name_7
- name: name
Response Example Response Example
@ -180,7 +181,6 @@ Lists volume types.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -189,8 +189,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -203,8 +202,7 @@ Response Parameters
- volume_types: volume_types - volume_types: volume_types
- extra_specs: extra_specs - extra_specs: extra_specs
- name: name - name: name_7
- volume_type: volume_type
Response Example Response Example
---------------- ----------------
@ -235,7 +233,6 @@ guide/blockstorage_multi_backend.html>`_.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -243,7 +240,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type - volume_type: volume_type_1
- project_id: project_id_path - project_id: project_id_path
- name: name_7 - name: name_7
- is_public: is_public - is_public: is_public
@ -261,12 +258,12 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type: volume_type_1
- is_public: is_public - is_public: is_public
- extra_specs: extra_specs - extra_specs: extra_specs
- description: description - description: description_15
- volume_type: volume_type - name: name_7
- name: name - id: volume_type_id_body
- id: id
- os-volume-type-access:is_public: os-volume-type-access:is_public - os-volume-type-access:is_public: os-volume-type-access:is_public
Response Example Response Example
@ -285,7 +282,6 @@ Show an encryption type.
To show an encryption type for an existing volume type. To show an encryption type for an existing volume type.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -302,9 +298,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type_id: volume_type_id_body
- encryption_id: encryption_id
- encryption: encryption - encryption: encryption
- volume_type_id: volume_type_id_body
- encryption_id: encryption_id_body
- key_size: key_size - key_size: key_size
- provider: provider - provider: provider
- control_location: control_location - control_location: control_location
@ -331,7 +327,6 @@ Delete an encryption type.
To delete an encryption type for an existing volume type. To delete an encryption type for an existing volume type.
Normal response codes: 202 Normal response codes: 202
Error response codes:
Request Request
@ -354,7 +349,6 @@ Creates an encryption type.
To create an encryption type for an existing volume type. To create an encryption type for an existing volume type.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -382,9 +376,9 @@ Response Parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume_type_id: volume_type_id_body
- encryption_id: encryption_id
- encryption: encryption - encryption: encryption
- volume_type_id: volume_type_id_body
- encryption_id: encryption_id_body
- key_size: key_size - key_size: key_size
- provider: provider - provider: provider
- control_location: control_location - control_location: control_location
@ -407,7 +401,6 @@ Update an encryption type.
To update an encryption type for an existing volume type. To update an encryption type for an existing volume type.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request

View File

@ -16,6 +16,7 @@ Shows details for Block Storage API v3.
Normal response codes: 200 Normal response codes: 200
Error response codes:203, Error response codes:203,

View File

@ -60,10 +60,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- os-extend: os-extend
- new_size: new_size
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-extend: os-extend
- new_size: new_size
Request Example Request Example
--------------- ---------------
@ -72,11 +72,6 @@ Request Example
:language: javascript :language: javascript
Reset a volume's statuses Reset a volume's statuses
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
@ -93,12 +88,12 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_3
- migration_status: migration_status
- os-reset_status: os-reset_status
- attach_status: attach_status
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-reset_status: os-reset_status
- status: status_3
- migration_status: migration_status_1
- attach_status: attach_status
Request Example Request Example
--------------- ---------------
@ -115,6 +110,7 @@ Revert volume to snapshot
Revert a volume to its latest snapshot, this API only support reverting a detached volume. Revert a volume to its latest snapshot, this API only support reverting a detached volume.
Normal response codes: 202 Normal response codes: 202
Error response codes: 400, 404 Error response codes: 400, 404
Request Request
@ -149,10 +145,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- os-set_image_metadata: os-set_image_metadata
- metadata: metadata
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-set_image_metadata: os-set_image_metadata
- metadata: metadata
Request Example Request Example
--------------- ---------------
@ -161,11 +157,6 @@ Request Example
:language: javascript :language: javascript
Remove image metadata from a volume Remove image metadata from a volume
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -181,10 +172,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- os-unset_image_metadata: os-unset_image_metadata
- key: key
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-unset_image_metadata: os-unset_image_metadata
- key: key
Request Example Request Example
--------------- ---------------
@ -256,12 +247,12 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- volume_id: volume_id_path
- os-attach: os-attach
- instance_uuid: instance_uuid - instance_uuid: instance_uuid
- mountpoint: mountpoint - mountpoint: mountpoint
- host_name: host_name - host_name: host_name
- os-attach: os-attach
- project_id: project_id_path
- volume_id: volume_id_path
Request Example Request Example
--------------- ---------------
@ -271,10 +262,6 @@ Request Example
Detach volume from server Detach volume from server
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -294,10 +281,10 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- attachment_id: attachment_id
- os-detach: os-detach
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-detach: os-detach
- attachment_id: attachment_id
Request Example Request Example
--------------- ---------------
@ -306,17 +293,14 @@ Request Example
:language: javascript :language: javascript
Unmanage a volume Unmanage a volume
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action
Removes a volume from Block Storage management without removing the back-end storage object that is associated with it. Specify the ``os-unmanage`` action in the request body. Removes a volume from Block Storage management without removing the back-end
storage object that is associated with it. Specify the ``os-unmanage`` action
in the request body.
Preconditions Preconditions
@ -330,9 +314,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- os-unmanage: os-unmanage
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-unmanage: os-unmanage
Request Example Request Example
--------------- ---------------
@ -341,11 +325,6 @@ Request Example
:language: javascript :language: javascript
Force detach a volume Force detach a volume
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
@ -364,11 +343,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- connector: connector
- attachment_id: attachment_id
- os-force_detach: os-force_detach
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-force_detach: os-force_detach
- attachment_id: attachment_id
- connector: connector
Request Example Request Example
--------------- ---------------
@ -377,11 +356,6 @@ Request Example
:language: javascript :language: javascript
Retype a volume Retype a volume
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@ -404,11 +378,11 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- volume_id: volume_id_path
- os-retype: os-retype
- new_type: new_type - new_type: new_type
- migration_policy: migration_policy - migration_policy: migration_policy
- os-retype: os-retype
- volume_id: volume_id_path
- project_id: project_id_path
Request Example Request Example
--------------- ---------------
@ -417,11 +391,6 @@ Request Example
:language: javascript :language: javascript
Force delete a volume Force delete a volume
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
@ -439,9 +408,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- os-force_delete: os-force_delete
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- os-force_delete: os-force_delete
Request Example Request Example
--------------- ---------------
@ -450,17 +419,13 @@ Request Example
:language: javascript :language: javascript
Update a volume's bootable status Update a volume's bootable status
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action
Update the bootable status for a volume, mark it as a bootable volume. Specify the ``os-set_bootable`` action in the request body. Update the bootable status for a volume, mark it as a bootable volume. Specify
the ``os-set_bootable`` action in the request body.
Normal response codes: 200 Normal response codes: 200
@ -482,10 +447,6 @@ Request Example
:language: javascript :language: javascript
Upload volume to image Upload volume to image
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -72,6 +72,7 @@ return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -81,8 +82,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -177,21 +177,20 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path
- volume: volume
- size: size - size: size
- description: description
- imageRef: imageRef
- multiattach: multiattach
- availability_zone: availability_zone - availability_zone: availability_zone
- source_volid: source_volid - source_volid: source_volid
- name: name_13 - description: description
- volume: volume - multiattach: multiattach
- consistencygroup_id: consistencygroup_id
- volume_type: volume_type
- snapshot_id: snapshot_id - snapshot_id: snapshot_id
- OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints - name: name_13
- source_replica: source_replica - imageRef: imageRef
- volume_type: volume_type
- metadata: metadata - metadata: metadata
- project_id: project_id_path - consistencygroup_id: consistencygroup_id
- OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints
Request Example Request Example
--------------- ---------------
@ -247,6 +246,7 @@ filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: badRequest(400) Error response codes: badRequest(400)
@ -256,8 +256,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- project_id: project_id_path - project_id: project_id_path
- sort_key: sort_key - sort: sort
- sort_dir: sort_dir
- limit: limit - limit: limit
- offset: offset - offset: offset
- marker: marker - marker: marker
@ -297,7 +296,6 @@ Preconditions
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -363,7 +361,6 @@ Updates a volume.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -371,12 +368,12 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- volume: volume
- description: description
- name: name_13
- metadata: metadata
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- volume: volume
- description: description
- name: name_8
- metadata: metadata
Request Example Request Example
--------------- ---------------
@ -491,9 +488,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- metadata: metadata_3
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- metadata: metadata_3
Request Example Request Example
--------------- ---------------
@ -529,7 +526,6 @@ Shows metadata for a volume.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -568,7 +564,6 @@ Replaces all the volume's metadata with the key-value pairs in the request.
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request
@ -576,9 +571,9 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- metadata: metadata_3
- project_id: project_id_path - project_id: project_id_path
- volume_id: volume_id_path - volume_id: volume_id_path
- metadata: metadata_3
Request Example Request Example
--------------- ---------------
@ -710,7 +705,6 @@ Display volumes summary with total number of volumes and total size in GB
Normal response codes: 200 Normal response codes: 200
Error response codes:
Request Request