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
parent
e9f09a25e6
commit
fffdac20c2
@ -15,6 +15,7 @@ Delete attachment
|
||||
Deletes an attachment.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -36,6 +37,7 @@ Shows details for an attachment.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -74,11 +76,11 @@ List attachments with details
|
||||
|
||||
.. 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.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
Request
|
||||
@ -87,8 +89,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -124,6 +125,7 @@ specify invalid filters in the url, API will return bad request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -133,8 +135,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -166,6 +167,7 @@ Create attachment
|
||||
Creates an attachment.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -175,6 +177,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- attachment: attachment
|
||||
- instance_uuid: instance_uuid_1
|
||||
- connector: connector
|
||||
- volume_uuid: volume_id_7
|
||||
@ -190,6 +193,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- attachment: attachment
|
||||
- status: status_9
|
||||
- detached_at: detached_at
|
||||
- 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.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
Request
|
||||
@ -224,6 +229,7 @@ Request
|
||||
|
||||
- project_id: project_id_path
|
||||
- attachment_id: attachment_id_1
|
||||
- attachement: attachment
|
||||
- connector: connector_1
|
||||
|
||||
Request Example
|
||||
@ -237,6 +243,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- attachment: attachment
|
||||
- status: status_9
|
||||
- detached_at: detached_at
|
||||
- connection_info: connection_info
|
||||
|
||||
@ -15,7 +15,6 @@ Shows capabilities for a storage back end on the host.
|
||||
The ``hostname`` takes the form of ``hostname@volume_backend_name``.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
@ -23,7 +23,6 @@ Lists consistency groups.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -32,8 +31,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
|
||||
@ -43,6 +41,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- consistencygroups: consistencygroups
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
@ -69,16 +68,24 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- consistencygroup: consistencygroup
|
||||
- description: description_6
|
||||
- availability_zone: availability_zone
|
||||
- volume_types: volume_types_2
|
||||
- name: name_15
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ./samples/consistency-group-create-request.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- consistencygroup: consistencygroup
|
||||
- status: status_1
|
||||
- description: description_11
|
||||
- availability_zone: availability_zone
|
||||
@ -87,12 +94,6 @@ Response
|
||||
- name: name_15
|
||||
- id: consistencygroup_id_1
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: ./samples/consistency-group-create-request.json
|
||||
:language: javascript
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
@ -107,7 +108,6 @@ Show a consistency group's details
|
||||
Shows details for a consistency group.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -115,7 +115,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- consistencygroup_id: consistencygroup_id
|
||||
- consistencygroup_id: consistencygroup_id_2
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
@ -152,6 +152,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- consistencygroup-from-src: consistencygroup-from-src
|
||||
- status: status_1
|
||||
- user_id: user_id
|
||||
- description: description
|
||||
@ -159,7 +161,6 @@ Request
|
||||
- source_cgid: source_cgid
|
||||
- project_id: project_id
|
||||
- name: name
|
||||
- project_id: project_id_path
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -183,9 +184,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- force: force
|
||||
- project_id: project_id_path
|
||||
- consistencygroup_id: consistencygroup_id
|
||||
- consistencygroup_id: consistencygroup_id_2
|
||||
- consistencygroup: consistencygroup
|
||||
- force: force
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -203,7 +205,6 @@ Lists consistency groups with details.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -212,8 +213,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
|
||||
@ -223,6 +223,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- consistencygroups: consistencygroups
|
||||
- status: status_1
|
||||
- description: description
|
||||
- availability_zone: availability_zone
|
||||
@ -253,12 +254,13 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- consistencygroup_id: consistencygroup_id_2
|
||||
- consistencygroup: consistencygroup
|
||||
- remove_volumes: remove_volumes
|
||||
- description: description
|
||||
- add_volumes: add_volumes
|
||||
- name: name
|
||||
- project_id: project_id_path
|
||||
- consistencygroup_id: consistencygroup_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
@ -11,7 +11,8 @@ Force-delete a backup
|
||||
|
||||
.. 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.
|
||||
|
||||
@ -19,6 +20,7 @@ The backup driver returns the ``405`` status code if it does not
|
||||
support this operation.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: itemNotFound(404), badMethod(405)
|
||||
|
||||
Request
|
||||
@ -26,9 +28,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- os-force_delete: os-force_delete
|
||||
- project_id: project_id_path
|
||||
- backup_id: backup_id
|
||||
- os-force_delete: os-force_delete
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -43,9 +45,11 @@ Reset a backup's status
|
||||
|
||||
.. 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
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -54,10 +58,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status_10
|
||||
- os-reset_status: os-reset_status
|
||||
- project_id: project_id_path
|
||||
- backup_id: backup_id
|
||||
- os-reset_status: os-reset_status
|
||||
- status: status_10
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
@ -48,6 +48,7 @@ API will return bad request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -57,8 +58,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -69,6 +69,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- backups: backups
|
||||
- status: status_4
|
||||
- object_count: object_count
|
||||
- fail_reason: fail_reason
|
||||
@ -81,7 +82,6 @@ Response Parameters
|
||||
- has_dependent_backups: has_dependent_backups
|
||||
- volume_id: volume_id
|
||||
- container: container
|
||||
- backups: backups
|
||||
- size: size
|
||||
- id: id_1
|
||||
- is_incremental: is_incremental
|
||||
@ -105,7 +105,6 @@ Shows details for a backup.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -122,6 +121,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- backup: backup
|
||||
- status: status_4
|
||||
- object_count: object_count
|
||||
- container: container
|
||||
@ -157,6 +157,7 @@ Delete a backup
|
||||
Deletes a backup.
|
||||
|
||||
Normal response codes: 202,
|
||||
|
||||
Error response codes: Bad Request(400)
|
||||
|
||||
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.
|
||||
|
||||
Normal response codes: 202,
|
||||
|
||||
Error response codes: Bad Request(400), Request Entity Too Large(413)
|
||||
|
||||
|
||||
@ -187,11 +189,11 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- restore: restore
|
||||
- name: name_1
|
||||
- volume_id: volume_id
|
||||
- project_id: project_id_path
|
||||
- backup_id: backup_id
|
||||
- restore: restore
|
||||
- name: name_8
|
||||
- volume_id: volume_id_6
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -223,6 +225,7 @@ Create a backup
|
||||
Creates a Block Storage backup from a volume.
|
||||
|
||||
Normal response codes: 202,
|
||||
|
||||
Error response codes: Bad Request(400), Internal Server Error(500)
|
||||
|
||||
Request
|
||||
@ -230,15 +233,15 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- backup: backup
|
||||
- volume_id: volume_id_2
|
||||
- container: container
|
||||
- description: description
|
||||
- incremental: incremental
|
||||
- volume_id: volume_id
|
||||
- force: force
|
||||
- backup: backup
|
||||
- name: name_optional
|
||||
- snapshot_id: snapshot_id_2
|
||||
- project_id: project_id_path
|
||||
- snapshot_id: snapshot_id_3
|
||||
- metadata: metadata_9
|
||||
|
||||
Request Example
|
||||
@ -265,7 +268,8 @@ Update a backup
|
||||
|
||||
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)
|
||||
|
||||
Request
|
||||
@ -313,6 +317,7 @@ since v3.31 if non-admin users specify invalid filters in the
|
||||
url, API will return bad request.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
Request
|
||||
@ -321,8 +326,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@ List replication targets
|
||||
Lists replication targets for a group.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -57,6 +58,7 @@ Enable group replication
|
||||
Enable replication for a group.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
Request
|
||||
@ -81,6 +83,7 @@ Disable group replication
|
||||
Disable replication for a group.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
Request
|
||||
@ -105,6 +108,7 @@ Failover replication
|
||||
Failover a replicated group.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
Request
|
||||
|
||||
@ -15,6 +15,7 @@ Delete group snapshot
|
||||
Deletes a group snapshot.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -36,6 +37,7 @@ Shows details for a group snapshot.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -53,12 +55,13 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- status: status_7
|
||||
- description: description
|
||||
- group_snapshot: group_snapshot
|
||||
- created_at: created_at
|
||||
- group_id: group_id_1
|
||||
- id: id
|
||||
- name: name
|
||||
- group_id: source_group_id
|
||||
- id: group_snapshot_id_1
|
||||
- name: name_18
|
||||
- status: status_7
|
||||
- description: description_14
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -72,11 +75,12 @@ List group snapshots with details
|
||||
|
||||
.. 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.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
Request
|
||||
@ -97,12 +101,13 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_snapshots: group_snapshots
|
||||
- id: group_snapshot_id_1
|
||||
- name: name_18
|
||||
- status: status_7
|
||||
- description: description
|
||||
- description: description_14
|
||||
- created_at: created_at
|
||||
- group_id: group_id_1
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -120,6 +125,7 @@ specify invalid filters in the url, API will return bad request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -141,8 +147,9 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- id: id
|
||||
- name: name
|
||||
- group_snapshots: group_snapshots
|
||||
- id: group_snapshot_id_1
|
||||
- name: name_18
|
||||
|
||||
|
||||
Response Example
|
||||
@ -160,6 +167,7 @@ Create group snapshot
|
||||
Creates a group snapshot.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -168,10 +176,11 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- description: description
|
||||
- group_id: group_id_1
|
||||
- project_id: project_id_path
|
||||
- group_snapshot: group_snapshot
|
||||
- name: name_18
|
||||
- description: description_14
|
||||
- group_id: group_id_1
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -184,12 +193,13 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_snapshot: group_snapshot
|
||||
- id: group_snapshot_id_1
|
||||
- name: name_18
|
||||
- status: status_7
|
||||
- description: description
|
||||
- description: description_14
|
||||
- created_at: created_at
|
||||
- group_id: group_id_1
|
||||
- id: id
|
||||
- name: name
|
||||
|
||||
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.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -214,10 +225,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- reset_status: reset_status
|
||||
- status: status
|
||||
- project_id: project_id
|
||||
- group_snapshot_id: group_snapshot_id
|
||||
- reset_status: reset_status
|
||||
- status: status_7
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
@ -13,6 +13,7 @@ this API will update the specification as well.
|
||||
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), forbidden(403), itemNotFound(404)
|
||||
|
||||
|
||||
@ -21,9 +22,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_specs: group_specs_2
|
||||
- group_type_id: group_type_id_1
|
||||
- project_id: project_id_path
|
||||
- group_type_id: group_type_id_1
|
||||
- group_specs: group_specs_2
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -57,6 +58,7 @@ List all the group specs for a group type,
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: itemNotFound(404), forbidden(403)
|
||||
|
||||
|
||||
@ -65,8 +67,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_type_id: group_type_id_1
|
||||
- project_id: project_id_path
|
||||
- group_type_id: group_type_id_1
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -93,6 +95,7 @@ Show a group spec for a group type,
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: itemNotFound(404), forbidden(403)
|
||||
|
||||
|
||||
@ -101,8 +104,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_type_id: group_type_id_1
|
||||
- project_id: project_id_path
|
||||
- group_type_id: group_type_id_1
|
||||
- spec_id: spec_id
|
||||
|
||||
|
||||
@ -129,6 +132,7 @@ Update a group spec for a group type,
|
||||
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: itemNotFound(404), forbidden(403)
|
||||
|
||||
|
||||
@ -137,8 +141,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_type_id: group_type_id_1
|
||||
- project_id: project_id_path
|
||||
- group_type_id: group_type_id_1
|
||||
- spec_id: spec_id
|
||||
- spec: spec_value
|
||||
|
||||
@ -166,6 +170,7 @@ Delete a group spec for a group type,
|
||||
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: itemNotFound(404), forbidden(403)
|
||||
|
||||
|
||||
@ -174,6 +179,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_type_id: group_type_id_1
|
||||
- project_id: project_id_path
|
||||
- group_type_id: group_type_id_1
|
||||
- spec_id: spec_id
|
||||
|
||||
@ -14,6 +14,7 @@ Updates a group type.
|
||||
To create a generic volume group, you must specify a group type.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400), forbidden(403), itemNotFound(404),
|
||||
conflict(409), computeFault(500)
|
||||
|
||||
@ -23,9 +24,11 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_type: group_type
|
||||
- group_type_id: group_type_id
|
||||
- project_id: project_id_path
|
||||
- group_type_id: group_type_id
|
||||
- group_type: group_type
|
||||
- name: name_16
|
||||
- description: description_12
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -39,11 +42,12 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- is_public: is_public
|
||||
- group_specs: group_specs
|
||||
- description: description
|
||||
- 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
|
||||
----------------
|
||||
@ -61,6 +65,7 @@ Shows details for a group type.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: itemNotFound(404)
|
||||
|
||||
Request
|
||||
@ -68,8 +73,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_type_id: group_type_id
|
||||
- project_id: project_id_path
|
||||
- group_type_id: group_type_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -77,11 +82,12 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- is_public: is_public
|
||||
- group_specs: group_specs
|
||||
- description: description
|
||||
- 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
|
||||
@ -99,6 +105,7 @@ Delete group type
|
||||
Deletes a group type.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), forbidden(403), itemNotFound(404)
|
||||
|
||||
|
||||
@ -120,7 +127,6 @@ Lists group types.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -129,8 +135,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -142,9 +147,9 @@ Response Parameters
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_types: group_types
|
||||
- group_specs: group_specs
|
||||
- name: name
|
||||
- group_type: group_type
|
||||
- id: group_type_id_2
|
||||
- group_specs: group_specs_2
|
||||
- name: name_16
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -164,6 +169,7 @@ To create a generic volume group, you must specify a group type.
|
||||
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), forbidden(403), itemNotFound(404),
|
||||
conflict(409)
|
||||
|
||||
@ -173,8 +179,11 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group_type: group_type
|
||||
- project_id: project_id_path
|
||||
- group_type: group_type
|
||||
- name: name_16
|
||||
- description: description_12
|
||||
- group_specs: group_specs
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -188,11 +197,12 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- is_public: is_public
|
||||
- group_specs: group_specs
|
||||
- description: description
|
||||
- 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
|
||||
|
||||
@ -22,11 +22,12 @@ List 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.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -36,8 +37,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -48,8 +48,9 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- groups: groups
|
||||
- id: id
|
||||
- name: name
|
||||
- name: group_name
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -66,6 +67,7 @@ Create group
|
||||
Creates a group.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -74,12 +76,13 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- group: group
|
||||
- description: description
|
||||
- availability_zone: availability_zone
|
||||
- group_type: group_type
|
||||
- volume_types: volume_types
|
||||
- name: name
|
||||
- project_id: project_id_path
|
||||
- name: group_name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -96,6 +99,7 @@ Show group details
|
||||
Shows details for a group.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: itemNotFound(404)
|
||||
|
||||
Request
|
||||
@ -111,6 +115,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- group: group
|
||||
- status: status_8
|
||||
- description: description
|
||||
- availability_zone: availability_zone
|
||||
@ -118,7 +123,7 @@ Response Parameters
|
||||
- group_type: group_type
|
||||
- volume_types: volume_types
|
||||
- id: id
|
||||
- name: name
|
||||
- name: group_name
|
||||
- replication_status: group_replication_status
|
||||
|
||||
Response Example
|
||||
@ -136,6 +141,7 @@ Create group from source
|
||||
Creates a group from source.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -144,11 +150,12 @@ Request
|
||||
|
||||
.. 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
|
||||
- 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
|
||||
---------------
|
||||
@ -165,6 +172,7 @@ Delete group
|
||||
Deletes a group.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -173,9 +181,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- delete-volumes: delete-volumes
|
||||
- project_id: project_id_path
|
||||
- group_id: group_id
|
||||
- delete: delete
|
||||
- delete-volumes: delete-volumes
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -194,6 +203,7 @@ users specify invalid filters in the url, API will return bad request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -203,8 +213,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -215,13 +224,14 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- groups: groups
|
||||
- status: status_8
|
||||
- description: description
|
||||
- availability_zone: availability_zone
|
||||
- created_at: created_at
|
||||
- group_type: group_type
|
||||
- volume_types: volume_types
|
||||
- id: id
|
||||
- id: group_id
|
||||
- name: name
|
||||
|
||||
Response Example
|
||||
@ -239,6 +249,7 @@ Update group
|
||||
Updates a group.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -247,12 +258,13 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- group_id: group_id
|
||||
- group: group
|
||||
- remove_volumes: remove_volumes
|
||||
- description: description
|
||||
- add_volumes: add_volumes
|
||||
- name: name
|
||||
- project_id: project_id_path
|
||||
- group_id: group_id
|
||||
- name: group_name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -269,6 +281,7 @@ Reset group status
|
||||
Resets the status for a group. Specify the ``reset_status`` action in the request body.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -277,10 +290,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- reset_status: reset_status
|
||||
- status: status
|
||||
- project_id: project_id
|
||||
- group_id: group_id
|
||||
- reset_status: reset_status
|
||||
- status: status
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
@ -16,7 +16,6 @@ List all hosts for a project
|
||||
Lists all hosts summary info that is not disabled.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -31,6 +30,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- hosts: hosts
|
||||
- service-status: service_status
|
||||
- service: host_service
|
||||
- zone: availability_zone_3
|
||||
@ -68,6 +68,7 @@ Response
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- host: host
|
||||
- volume_count: total_count
|
||||
- total_volume_gb: totalGigabytesUsed
|
||||
- total_snapshot_gb: totalSnapshotsUsed
|
||||
@ -75,7 +76,8 @@ Response
|
||||
- host: host
|
||||
- snapshot_count: totalSnapshotsUsed
|
||||
|
||||
**Example Show Host Details**
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ./samples/hosts-get-response.json
|
||||
:language: javascript
|
||||
|
||||
@ -21,7 +21,8 @@ for the item is infinite.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:203,
|
||||
|
||||
Error response codes: 203
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -35,19 +36,19 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- limits: limits
|
||||
- rate: rate
|
||||
- absolute: absolute
|
||||
- totalSnapshotsUsed: totalSnapshotsUsed
|
||||
- maxTotalBackups: maxTotalBackups
|
||||
- maxTotalVolumeGigabytes: maxTotalVolumeGigabytes
|
||||
- limits: limits
|
||||
- maxTotalSnapshots: maxTotalSnapshots
|
||||
- maxTotalBackupGigabytes: maxTotalBackupGigabytes
|
||||
- totalBackupGigabytesUsed: totalBackupGigabytesUsed
|
||||
- maxTotalVolumes: maxTotalVolumes
|
||||
- totalVolumesUsed: totalVolumesUsed
|
||||
- rate: rate
|
||||
- totalBackupsUsed: totalBackupsUsed
|
||||
- totalGigabytesUsed: totalGigabytesUsed
|
||||
- absolute: absolute
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
@ -14,6 +14,7 @@ Delete message
|
||||
Deletes a message.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -35,6 +36,7 @@ Shows details for a message.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400), itemNotFound(404)
|
||||
|
||||
|
||||
@ -52,6 +54,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- message: user_message
|
||||
- request_id: request_id
|
||||
- links: links_5
|
||||
- message_level: message_level
|
||||
@ -80,6 +83,7 @@ specify invalid filters in the url, API will return bad request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -89,8 +93,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -100,6 +103,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- messages: user_messages
|
||||
- request_id: request_id
|
||||
- links: links_5
|
||||
- message_level: message_level
|
||||
|
||||
@ -23,7 +23,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- cgsnapshot_id: cgsnapshot_id
|
||||
- cgsnapshot_id: cgsnapshot_id_1
|
||||
|
||||
|
||||
Show consistency group snapshot detail
|
||||
@ -35,7 +35,6 @@ Shows details for a consistency group snapshot.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -44,7 +43,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- cgsnapshot_id: cgsnapshot_id
|
||||
- cgsnapshot_id: cgsnapshot_id_1
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -52,12 +51,13 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- cgsnapshot: cgsnapshot
|
||||
- status: status
|
||||
- description: description
|
||||
- created_at: created_at
|
||||
- consistencygroup_id: consistencygroup_id
|
||||
- id: id
|
||||
- name: name
|
||||
- name: name_2
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -75,7 +75,6 @@ Lists all consistency group snapshots with details.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -90,12 +89,13 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- cgsnapshots: cgsnapshots
|
||||
- status: status
|
||||
- description: description
|
||||
- created_at: created_at
|
||||
- consistencygroup_id: consistencygroup_id
|
||||
- id: id
|
||||
- name: name
|
||||
- name: name_2
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -112,7 +112,6 @@ Lists all consistency group snapshots.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -128,8 +127,9 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- cgsnapshots: cgsnapshots
|
||||
- id: id
|
||||
- name: name
|
||||
- name: name_2
|
||||
|
||||
|
||||
|
||||
@ -156,8 +156,11 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- project_id: project_id_path
|
||||
- cgsnapshot: cgsnapshot
|
||||
- name: name_5
|
||||
- consistencygroup_id: consistencygroup_id
|
||||
- description: description
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -175,4 +178,4 @@ Response Parameters
|
||||
- created_at: created_at
|
||||
- consistencygroup_id: consistencygroup_id
|
||||
- id: id
|
||||
- name: name
|
||||
- name: name_2
|
||||
|
||||
@ -72,8 +72,8 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- binary: binary
|
||||
- host: host_name_body
|
||||
- host: host_query
|
||||
- binary: binary_query
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
@ -12,11 +12,12 @@ List all back-end storage 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.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
Request
|
||||
@ -32,6 +33,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- pools: pools
|
||||
- updated: updated
|
||||
- QoS_support: QoS_support
|
||||
- name: name
|
||||
|
||||
@ -21,9 +21,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- auth_key: auth_key
|
||||
- transfer_id: transfer_id
|
||||
- project_id: project_id_path
|
||||
- transfer_id: transfer_id
|
||||
- auth_key: auth_key
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -59,9 +59,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- transfer: transfer
|
||||
- name: name
|
||||
- volume_id: volume_id
|
||||
- project_id: project_id_path
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -92,7 +93,6 @@ Lists volume transfers.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -130,7 +130,6 @@ Shows details for a volume transfer.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -138,8 +137,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- transfer_id: transfer_id
|
||||
- project_id: project_id_path
|
||||
- transfer_id: transfer_id
|
||||
|
||||
|
||||
Response Parameters
|
||||
@ -176,8 +175,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- transfer_id: transfer_id
|
||||
- project_id: project_id_path
|
||||
- transfer_id: transfer_id
|
||||
|
||||
|
||||
List volume transfers and details
|
||||
@ -189,7 +188,6 @@ Lists volume transfers, with details.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -203,6 +201,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- transfers: transfers
|
||||
- created_at: created_at
|
||||
- volume_id: volume_id
|
||||
- id: id
|
||||
|
||||
@ -41,13 +41,13 @@ cgsnapshot_id_1:
|
||||
description: |
|
||||
The ID of the consistency group snapshot.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
consistencygroup_id_2:
|
||||
description: |
|
||||
The ID of the consistency group.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
encryption_id:
|
||||
description: |
|
||||
@ -55,13 +55,6 @@ encryption_id:
|
||||
in: path
|
||||
required: true
|
||||
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:
|
||||
description: |
|
||||
The ID of the group.
|
||||
@ -72,7 +65,7 @@ group_snapshot_id:
|
||||
description: |
|
||||
The ID of the group snapshot.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
group_type_id:
|
||||
description: |
|
||||
@ -114,6 +107,12 @@ key_3:
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
message_id:
|
||||
description: |
|
||||
The UUID of the message.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
project_id_path:
|
||||
description: |
|
||||
The UUID of the project in a multi-tenancy cloud.
|
||||
@ -138,23 +137,23 @@ quotas_project_id:
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
resource:
|
||||
description: |
|
||||
Filter filters by resource name.
|
||||
in: path
|
||||
required: false
|
||||
type: string
|
||||
snapshot_id_path:
|
||||
description: |
|
||||
The UUID of the snapshot.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
spec_id:
|
||||
description: |
|
||||
The id (key) of the group specification.
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
transfer_id:
|
||||
description: |
|
||||
The unique identifier for a volume transfer.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
user_id_1:
|
||||
description: |
|
||||
@ -185,7 +184,7 @@ volume_type_id:
|
||||
description: |
|
||||
The UUID for an existing volume type.
|
||||
in: path
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
|
||||
# variables in query
|
||||
@ -221,6 +220,13 @@ detail:
|
||||
in: query
|
||||
required: false
|
||||
type: boolean
|
||||
force_3:
|
||||
description: |
|
||||
To delete a QoS specification even if it is in-
|
||||
use, set to ``true``. Default is ``false``.
|
||||
in: query
|
||||
required: false
|
||||
type: boolean
|
||||
host_query:
|
||||
description: |
|
||||
Filter the service list result by host name of the service.
|
||||
@ -284,12 +290,6 @@ marker_group_snapshot:
|
||||
required: false
|
||||
type: string
|
||||
min_version: 3.29
|
||||
message_id:
|
||||
description: |
|
||||
The UUID of the message.
|
||||
in: query
|
||||
required: true
|
||||
type: string
|
||||
metadata_query:
|
||||
description: |
|
||||
Filters results by a metadata key and value pair.
|
||||
@ -325,6 +325,12 @@ offset_group_snapshot:
|
||||
required: false
|
||||
type: integer
|
||||
min_version: 3.29
|
||||
resource:
|
||||
description: |
|
||||
Filter for resource name.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
sort:
|
||||
description: |
|
||||
Comma-separated list of sort keys and optional
|
||||
@ -381,12 +387,6 @@ sort_key_group_snapshot:
|
||||
required: false
|
||||
type: string
|
||||
min_version: 3.29
|
||||
spec_id:
|
||||
description: |
|
||||
The id (key) of the group specification.
|
||||
in: query
|
||||
required: true
|
||||
type: string
|
||||
status_query:
|
||||
description: |
|
||||
Filters results by a status. Default=None.
|
||||
@ -400,6 +400,12 @@ usage:
|
||||
in: query
|
||||
required: false
|
||||
type: boolean
|
||||
vol_type_id_query:
|
||||
description: |
|
||||
A volume type ID.
|
||||
in: query
|
||||
required: true
|
||||
type: string
|
||||
|
||||
# variables in body
|
||||
absolute:
|
||||
@ -454,9 +460,15 @@ attached_at:
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
attachment:
|
||||
description: |
|
||||
An attachment object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
attachment_id:
|
||||
description: |
|
||||
The interface ID.
|
||||
The ID of the attachment.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
@ -604,12 +616,24 @@ capabilities:
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
cgsnapshot:
|
||||
description: |
|
||||
A consistency group snapshot object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
cgsnapshot_id:
|
||||
description: |
|
||||
The UUID of the consistency group snapshot.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
cgsnapshots:
|
||||
description: |
|
||||
A collection of ``cgsnapshot`` objects.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
cinder_id:
|
||||
description: |
|
||||
The UUID of the snapshot in Cinder.
|
||||
@ -663,6 +687,18 @@ connector_1:
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
consistencygroup:
|
||||
description: |
|
||||
A consistency group.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
consistencygroup-from-src:
|
||||
description: |
|
||||
The consistency group from source object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
consistencygroup_id:
|
||||
description: |
|
||||
The UUID of the consistency group.
|
||||
@ -675,6 +711,12 @@ consistencygroup_id_1:
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
consistencygroups:
|
||||
description: |
|
||||
A list of consistency groups.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
consumer:
|
||||
description: |
|
||||
The consumer type.
|
||||
@ -695,7 +737,7 @@ container:
|
||||
type: string
|
||||
container_format:
|
||||
description: |
|
||||
Container format for the new image. Defualt is bare.
|
||||
Container format for the new image. Default is bare.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
@ -706,6 +748,12 @@ control_location:
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
create-from-src:
|
||||
description: |
|
||||
The create from source action.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
created_at:
|
||||
description: |
|
||||
The date and time when the resource was created.
|
||||
@ -739,6 +787,12 @@ data_timestamp:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
delete:
|
||||
description: |
|
||||
The delete action.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
delete-volumes:
|
||||
description: |
|
||||
If set to ``true``, allows deletion of a
|
||||
@ -1052,24 +1106,48 @@ gigabytes_usage:
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
group:
|
||||
description: |
|
||||
A group object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
group_id_1:
|
||||
description: |
|
||||
The ID of the group.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
group_name:
|
||||
description: |
|
||||
The group name.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
group_replication_status:
|
||||
description: |
|
||||
The group replication status. Introduced with API microversion 3.38.
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
group_snapshot:
|
||||
description: |
|
||||
The group snapshot.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
group_snapshot_id_1:
|
||||
description: |
|
||||
The ID of the group snapshot.
|
||||
in: body
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
group_snapshots:
|
||||
description: |
|
||||
A collection of group snapshots.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
group_specs:
|
||||
description: |
|
||||
A set of key and value pairs that contains the
|
||||
@ -1090,12 +1168,24 @@ group_type:
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
group_type_id_2:
|
||||
description: |
|
||||
The group type ID.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
group_types:
|
||||
description: |
|
||||
The list of group types.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
groups:
|
||||
description: |
|
||||
A collections of groups.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
groups_number:
|
||||
description: |
|
||||
The number of groups that are allowed for each project.
|
||||
@ -1130,7 +1220,7 @@ host:
|
||||
existing volume resides.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
type: object
|
||||
host_mutex:
|
||||
description: |
|
||||
The OpenStack Block Storage host where the existing resource resides.
|
||||
@ -1162,6 +1252,12 @@ host_service:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
hosts:
|
||||
description: |
|
||||
A OpenStack Block Storage host.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
id:
|
||||
description: |
|
||||
The UUID of the volume transfer.
|
||||
@ -1265,13 +1361,13 @@ is_incremental:
|
||||
type: boolean
|
||||
is_public:
|
||||
description:
|
||||
Volume type which is accessible to the public.
|
||||
Whether the volume type is publicly visible.
|
||||
in: body
|
||||
required: false
|
||||
type: boolean
|
||||
is_public_1:
|
||||
description:
|
||||
Group type which is accessible to the public.
|
||||
Whether the group is publicly visible.
|
||||
in: body
|
||||
required: false
|
||||
type: boolean
|
||||
@ -1921,6 +2017,12 @@ pool_name:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
pools:
|
||||
description: |
|
||||
List of storage pools.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
prefix:
|
||||
description: |
|
||||
The prefix for the log path we are querying,
|
||||
@ -1975,6 +2077,12 @@ provider_optional:
|
||||
in: body
|
||||
required: false
|
||||
type: string
|
||||
qos_set_id:
|
||||
description: |
|
||||
The QoS set ID.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
qos_specs:
|
||||
description: |
|
||||
A ``qos_specs`` object.
|
||||
@ -1993,6 +2101,12 @@ quota_class_id:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
quota_class_set:
|
||||
description: |
|
||||
A ``quota_class_set`` object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
quota_set:
|
||||
description: |
|
||||
A ``quota_set`` object.
|
||||
@ -2020,7 +2134,7 @@ ref:
|
||||
structure, see the documentation for the volume driver.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
type: object
|
||||
ref_1:
|
||||
description: |
|
||||
A reference to the existing volume. The internal
|
||||
@ -2098,6 +2212,12 @@ resource_filters:
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
resource_filters_1:
|
||||
description: |
|
||||
A collection of resource filters.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
resource_id:
|
||||
description: |
|
||||
The UUID of a resource to cleanup.
|
||||
@ -2230,7 +2350,7 @@ snapshot_id_2:
|
||||
description: |
|
||||
The UUID of the source volume snapshot.
|
||||
in: body
|
||||
required: true
|
||||
required: false
|
||||
type: string
|
||||
snapshot_id_3:
|
||||
description: |
|
||||
@ -2292,7 +2412,7 @@ source_group_id:
|
||||
description: |
|
||||
The UUID of the source group.
|
||||
in: body
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
source_reference:
|
||||
description: |
|
||||
@ -2485,6 +2605,18 @@ totalVolumesUsed:
|
||||
in: body
|
||||
required: true
|
||||
type: integer
|
||||
transfer:
|
||||
description: |
|
||||
The volume transfer object.
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
transfers:
|
||||
description: |
|
||||
List of transfer details.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
updated:
|
||||
description: |
|
||||
The date and time stamp when the extension was
|
||||
@ -2537,7 +2669,13 @@ user_message:
|
||||
description: |
|
||||
The translated readable message corresponding to ``event_id``.
|
||||
in: body
|
||||
required: false
|
||||
required: true
|
||||
type: string
|
||||
user_messages:
|
||||
description: |
|
||||
A collection of user messages.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
vendor_name:
|
||||
description: |
|
||||
|
||||
@ -38,7 +38,6 @@ Unsets keys in a QoS specification.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -46,9 +45,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- keys: keys
|
||||
- project_id: project_id_path
|
||||
- qos_id: qos_id
|
||||
- keys: keys
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -57,14 +56,6 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ./samples/qos-unset-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Get all associations for a QoS specification
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -74,7 +65,6 @@ Lists all associations for a QoS specification.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -86,6 +76,19 @@ Request
|
||||
- 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
|
||||
----------------
|
||||
|
||||
@ -110,7 +113,7 @@ Request
|
||||
|
||||
- project_id: project_id_path
|
||||
- qos_id: qos_id
|
||||
- vol_type_id: vol_type_id
|
||||
- vol_type_id: vol_type_id_query
|
||||
|
||||
|
||||
Disassociate QoS specification from a volume type
|
||||
@ -130,7 +133,7 @@ Request
|
||||
|
||||
- project_id: project_id_path
|
||||
- qos_id: qos_id
|
||||
- vol_type_id: vol_type_id
|
||||
- vol_type_id: vol_type_id_query
|
||||
|
||||
|
||||
Show a QoS specification details
|
||||
@ -142,7 +145,8 @@ Shows details for a QoS specification.
|
||||
|
||||
|
||||
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
|
||||
@ -159,12 +163,12 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- links: links
|
||||
- id: id
|
||||
- qos_specs: qos_specs
|
||||
- consumer: consumer
|
||||
- specs: specs
|
||||
- consumer: consumer
|
||||
- name: name_4
|
||||
- id: id_3
|
||||
- links: links_2
|
||||
|
||||
|
||||
Response Example
|
||||
@ -183,7 +187,6 @@ Sets keys in a QoS specification.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -191,10 +194,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- qos_specs: qos_specs
|
||||
- specs: specs
|
||||
- project_id: project_id_path
|
||||
- qos_id: qos_id
|
||||
- qos_specs: qos_specs
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -202,6 +204,13 @@ Request Example
|
||||
.. literalinclude:: ./samples/qos-update-request.json
|
||||
:language: javascript
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- qos_specs: qos_specs
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -227,7 +236,7 @@ Request
|
||||
|
||||
- project_id: project_id_path
|
||||
- qos_id: qos_id
|
||||
- force: force
|
||||
- force: force_3
|
||||
|
||||
|
||||
Create a QoS specification
|
||||
@ -247,10 +256,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- qos_specs: qos_specs
|
||||
- consumer: consumer
|
||||
- name: name
|
||||
- project_id: project_id_path
|
||||
- qos_specs: qos_specs
|
||||
- name: name_4
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -265,10 +273,10 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- name: name
|
||||
- links: links
|
||||
- id: id
|
||||
- qos_specs: qos_specs
|
||||
- name: name_4
|
||||
- links: links_2
|
||||
- id: id_3
|
||||
- consumer: consumer
|
||||
- specs: specs
|
||||
|
||||
@ -282,7 +290,8 @@ Lists quality of service (QoS) specifications.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:300,
|
||||
|
||||
Error response codes: 300
|
||||
|
||||
|
||||
Request
|
||||
@ -291,8 +300,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
|
||||
@ -302,11 +310,11 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- specs: specs
|
||||
- qos_specs: qos_specs
|
||||
- specs: specs
|
||||
- consumer: consumer
|
||||
- id: id
|
||||
- name: name
|
||||
- id: id_3
|
||||
- name: name_4
|
||||
|
||||
|
||||
Response Example
|
||||
|
||||
@ -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.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: 403, 404
|
||||
|
||||
|
||||
@ -33,6 +34,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- quota_class_set: quota_class_set
|
||||
- backup_gigabytes: maxTotalBackupGigabytes
|
||||
- backups: maxTotalBackups
|
||||
- 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.
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: 400, 403, 404
|
||||
|
||||
|
||||
@ -85,6 +88,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- quota_class_set: quota_class_set
|
||||
- backup_gigabytes: maxTotalBackupGigabytes
|
||||
- backups: maxTotalBackups
|
||||
- gigabytes: maxTotalVolumeGigabytes
|
||||
|
||||
@ -17,7 +17,6 @@ Shows quotas for a project.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -25,8 +24,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: quotas_project_id
|
||||
- admin_project_id: admin_project_id
|
||||
- project_id: quotas_project_id
|
||||
- usage: usage
|
||||
|
||||
|
||||
@ -36,7 +35,7 @@ Response Parameters
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- quota_set: quota_set
|
||||
- id: project_id
|
||||
- id: qos_set_id
|
||||
- volumes: volumes_number
|
||||
- volumes_{volume_type}: volumes_number_for_type
|
||||
- snapshots: snapshots_number
|
||||
@ -64,7 +63,6 @@ Shows quota usage for a project.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -83,7 +81,7 @@ Response Parameters
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- quota_set: quota_set
|
||||
- id: project_id
|
||||
- id: qos_set_id
|
||||
- volumes: volumes_number_usage
|
||||
- volumes_{volume_type}: volumes_number_for_type_usage
|
||||
- snapshots: snapshots_number_usage
|
||||
@ -112,7 +110,6 @@ Updates quotas for a project.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -174,7 +171,6 @@ Deletes quotas for a project so the quotas revert to default values.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -197,7 +193,6 @@ Gets default quotas for a project.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -215,7 +210,7 @@ Response Parameters
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- quota_set: quota_set
|
||||
- id: project_id
|
||||
- id: qos_set_id
|
||||
- volumes: volumes_number
|
||||
- volumes_{volume_type}: volumes_number_for_type
|
||||
- snapshots: snapshots_number
|
||||
|
||||
@ -15,7 +15,6 @@ List resource filters
|
||||
List filters.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -31,6 +30,7 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- resource_filters: resource_filters_1
|
||||
- filters: resource_filters
|
||||
- resource: resource_1
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@
|
||||
"consistencygroup_id": "6f519a48-3183-46cf-a32f-41815f814546",
|
||||
"name": "firstcg",
|
||||
"description": "first consistency group",
|
||||
"user_id": "6f519a48-3183-46cf-a32f-41815f814444",
|
||||
"project_id": "6f519a48-3183-46cf-a32f-41815f815555",
|
||||
"status": "creating"
|
||||
}
|
||||
}
|
||||
|
||||
@ -3,9 +3,6 @@
|
||||
"name": "first_group",
|
||||
"description": "first group",
|
||||
"group_snapshot_id": "6f519a48-3183-46cf-a32f-41815f813986",
|
||||
"source_group_id": None,
|
||||
"user_id": "6f519a48-3183-46cf-a32f-41815f815555",
|
||||
"project_id": "6f519a48-3183-46cf-a32f-41815f814444",
|
||||
"status": "creating"
|
||||
"source_group_id": None
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,7 +1,5 @@
|
||||
{
|
||||
"qos_specs": {
|
||||
"availability": "100",
|
||||
"name": "reliability-spec",
|
||||
"numberOfFailures": "0"
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,6 +1,9 @@
|
||||
{
|
||||
"volume": {
|
||||
"name": "vol-003",
|
||||
"description": "This is yet, another volume."
|
||||
"description": "This is yet, another volume.",
|
||||
"metadata": {
|
||||
"name": "metadata0"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -12,7 +12,8 @@ Manage an existing snapshot
|
||||
|
||||
.. 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
|
||||
in the ref parameter in the request. Although each storage driver
|
||||
@ -32,12 +33,13 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- snapshot: snapshot_1
|
||||
- description: description
|
||||
- name: name
|
||||
- metadata: metadata_7
|
||||
- name: name_5
|
||||
- ref: ref
|
||||
- volume_id: volume_id
|
||||
- metadata: metadata
|
||||
- project_id: project_id_path
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -63,12 +65,12 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort: sort
|
||||
- offset: offset
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- project_id: project_id_path
|
||||
- host: hostname
|
||||
- host: host_query
|
||||
|
||||
|
||||
Response
|
||||
@ -108,12 +110,12 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort: sort
|
||||
- offset: offset
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- project_id: project_id_path
|
||||
- host: hostname
|
||||
- host: host_query
|
||||
|
||||
|
||||
Response
|
||||
|
||||
@ -12,7 +12,8 @@ Manage an existing volume
|
||||
|
||||
.. 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
|
||||
in the ref parameter in the request. Although each storage driver
|
||||
@ -35,17 +36,17 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- volume: volume
|
||||
- description: description
|
||||
- availability_zone: availability_zone
|
||||
- bootable: bootable
|
||||
- volume_type: volume_type
|
||||
- name: name
|
||||
- volume: volume
|
||||
- name: volume_name
|
||||
- host: host_mutex
|
||||
- cluster: cluster_mutex
|
||||
- ref: ref
|
||||
- metadata: metadata
|
||||
- project_id: project_id_path
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -73,11 +74,11 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort: sort
|
||||
- offset: offset
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- project_id: project_id_path
|
||||
- host: hostname
|
||||
|
||||
|
||||
@ -117,12 +118,12 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort: sort
|
||||
- offset: offset
|
||||
- limit: limit
|
||||
- marker: marker
|
||||
- project_id: project_id_path
|
||||
- host: hostname
|
||||
- host: host_query
|
||||
|
||||
|
||||
Response
|
||||
|
||||
@ -74,7 +74,6 @@ Lists project IDs that have access to private volume type.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
|
||||
@ -15,6 +15,7 @@ Lists Block Storage API extensions.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes:300,
|
||||
|
||||
|
||||
|
||||
@ -45,6 +45,7 @@ return bad request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -54,8 +55,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -90,7 +90,8 @@ Create a snapshot
|
||||
|
||||
.. 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
|
||||
|
||||
@ -100,12 +101,12 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- snapshot: snapshot
|
||||
- volume_id: volume_id
|
||||
- force: force
|
||||
- description: description
|
||||
- name: name_12
|
||||
- project_id: project_id_path
|
||||
- snapshot: snapshot_1
|
||||
- volume_id: volume_id
|
||||
- name: name_12
|
||||
- description: description
|
||||
- force: force
|
||||
- metadata: metadata_7
|
||||
|
||||
Request Example
|
||||
@ -123,7 +124,7 @@ Response Parameters
|
||||
- description: description
|
||||
- created_at: created_at
|
||||
- name: name_12
|
||||
- snapshot: snapshot
|
||||
- snapshot: snapshot_1
|
||||
- user_id: user_id_2
|
||||
- volume_id: volume_id
|
||||
- metadata: metadata
|
||||
@ -149,6 +150,7 @@ specify invalid filters in the url, API will return bad request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -158,8 +160,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -196,7 +197,6 @@ Shows metadata for a snapshot.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -218,7 +218,7 @@ Response Parameters
|
||||
- description: description
|
||||
- created_at: created_at
|
||||
- name: name
|
||||
- snapshot: snapshot
|
||||
- snapshot: snapshot_1
|
||||
- volume_id: volume_id
|
||||
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
|
||||
- size: size
|
||||
@ -244,7 +244,6 @@ are not in the request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -252,9 +251,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- metadata: metadata
|
||||
- project_id: project_id_path
|
||||
- snapshot_id: snapshot_id_path
|
||||
- metadata: metadata
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -262,6 +261,12 @@ Request Example
|
||||
.. literalinclude:: ./samples/snapshot-metadata-create-request.json
|
||||
:language: javascript
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- metadata: metadata
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -278,7 +283,6 @@ Replaces all the snapshot's metadata with the key-value pairs in the request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -286,9 +290,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- metadata: metadata
|
||||
- project_id: project_id_path
|
||||
- snapshot_id: snapshot_id_path
|
||||
- metadata: metadata
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -297,6 +301,13 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- metadata: metadata
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
@ -313,7 +324,6 @@ Shows details for a snapshot.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -335,7 +345,7 @@ Response Parameters
|
||||
- description: description
|
||||
- created_at: created_at
|
||||
- name: name
|
||||
- snapshot: snapshot
|
||||
- snapshot: snapshot_1
|
||||
- user_id: user_id_2
|
||||
- volume_id: volume_id
|
||||
- os-extended-snapshot-attributes:project_id: os-extended-snapshot-attributes:project_id
|
||||
@ -359,7 +369,6 @@ Updates a snapshot.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -367,11 +376,11 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- snapshot: snapshot
|
||||
- description: description
|
||||
- name: name
|
||||
- project_id: project_id_path
|
||||
- snapshot_id: snapshot_id_path
|
||||
- snapshot: snapshot_1
|
||||
- description: description
|
||||
- name: name
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -390,12 +399,12 @@ Response Parameters
|
||||
- description: description
|
||||
- created_at: created_at
|
||||
- name: name
|
||||
- snapshot: snapshot
|
||||
- user_id: user_id_2
|
||||
- volume_id: volume_id
|
||||
- metadata: metadata
|
||||
- snapshot: snapshot_1
|
||||
- id: id
|
||||
- size: size
|
||||
- volume_id: volume_id
|
||||
- user_id: user_id_2
|
||||
- metadata: metadata
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -423,8 +432,6 @@ Request
|
||||
- snapshot_id: snapshot_id_path
|
||||
|
||||
|
||||
|
||||
|
||||
Show a snapshot's metadata for a specific key
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -452,8 +459,6 @@ Response Parameters
|
||||
|
||||
- meta: meta_1
|
||||
|
||||
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
|
||||
@ -26,7 +26,6 @@ guide/blockstorage_multi_backend.html>`_.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -34,9 +33,13 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume_type: volume_type
|
||||
- volume_type_id: volume_type_id
|
||||
- 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
|
||||
---------------
|
||||
@ -51,11 +54,11 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume_type: volume_type_1
|
||||
- is_public: is_public
|
||||
- extra_specs: extra_specs
|
||||
- description: description
|
||||
- volume_type: volume_type
|
||||
- name: name
|
||||
- description: description_15
|
||||
- name: name_7
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -73,7 +76,6 @@ Updates the extra specifications that are assigned to a volume type.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -81,10 +83,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- extra_specs: extra_specs
|
||||
- volume_type: volume_type
|
||||
- volume_type_id: volume_type_id
|
||||
- project_id: project_id_path
|
||||
- volume_type_id: volume_type_id
|
||||
- volume_type: volume_type_1
|
||||
- extra_specs: extra_specs
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -99,11 +101,11 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume_type: volume_type_1
|
||||
- is_public: is_public
|
||||
- extra_specs: extra_specs
|
||||
- description: description
|
||||
- volume_type: volume_type
|
||||
- name: name
|
||||
- description: description_15
|
||||
- name: name_7
|
||||
|
||||
|
||||
Response Example
|
||||
@ -122,7 +124,6 @@ Shows details for a volume type.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -138,11 +139,11 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume_type: volume_type_1
|
||||
- is_public: is_public
|
||||
- extra_specs: extra_specs
|
||||
- description: description
|
||||
- volume_type: volume_type
|
||||
- name: name
|
||||
- description: description_15
|
||||
- name: name_7
|
||||
|
||||
|
||||
Response Example
|
||||
@ -180,7 +181,6 @@ Lists volume types.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -189,8 +189,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -203,8 +202,7 @@ Response Parameters
|
||||
|
||||
- volume_types: volume_types
|
||||
- extra_specs: extra_specs
|
||||
- name: name
|
||||
- volume_type: volume_type
|
||||
- name: name_7
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
@ -235,7 +233,6 @@ guide/blockstorage_multi_backend.html>`_.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -243,7 +240,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume_type: volume_type
|
||||
- volume_type: volume_type_1
|
||||
- project_id: project_id_path
|
||||
- name: name_7
|
||||
- is_public: is_public
|
||||
@ -261,12 +258,12 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume_type: volume_type_1
|
||||
- is_public: is_public
|
||||
- extra_specs: extra_specs
|
||||
- description: description
|
||||
- volume_type: volume_type
|
||||
- name: name
|
||||
- id: id
|
||||
- description: description_15
|
||||
- name: name_7
|
||||
- id: volume_type_id_body
|
||||
- os-volume-type-access:is_public: os-volume-type-access:is_public
|
||||
|
||||
Response Example
|
||||
@ -285,7 +282,6 @@ Show an encryption type.
|
||||
To show an encryption type for an existing volume type.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -302,9 +298,9 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume_type_id: volume_type_id_body
|
||||
- encryption_id: encryption_id
|
||||
- encryption: encryption
|
||||
- volume_type_id: volume_type_id_body
|
||||
- encryption_id: encryption_id_body
|
||||
- key_size: key_size
|
||||
- provider: provider
|
||||
- control_location: control_location
|
||||
@ -331,7 +327,6 @@ Delete an encryption type.
|
||||
To delete an encryption type for an existing volume type.
|
||||
|
||||
Normal response codes: 202
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -354,7 +349,6 @@ Creates an encryption type.
|
||||
To create an encryption type for an existing volume type.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -382,9 +376,9 @@ Response Parameters
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume_type_id: volume_type_id_body
|
||||
- encryption_id: encryption_id
|
||||
- encryption: encryption
|
||||
- volume_type_id: volume_type_id_body
|
||||
- encryption_id: encryption_id_body
|
||||
- key_size: key_size
|
||||
- provider: provider
|
||||
- control_location: control_location
|
||||
@ -407,7 +401,6 @@ Update an encryption type.
|
||||
To update an encryption type for an existing volume type.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
|
||||
@ -16,6 +16,7 @@ Shows details for Block Storage API v3.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes:203,
|
||||
|
||||
|
||||
|
||||
@ -60,10 +60,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- os-extend: os-extend
|
||||
- new_size: new_size
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-extend: os-extend
|
||||
- new_size: new_size
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -72,11 +72,6 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reset a volume's statuses
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -93,12 +88,12 @@ Request
|
||||
|
||||
.. 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
|
||||
- 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
|
||||
---------------
|
||||
@ -115,6 +110,7 @@ Revert volume to snapshot
|
||||
Revert a volume to its latest snapshot, this API only support reverting a detached volume.
|
||||
|
||||
Normal response codes: 202
|
||||
|
||||
Error response codes: 400, 404
|
||||
|
||||
Request
|
||||
@ -149,10 +145,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- os-set_image_metadata: os-set_image_metadata
|
||||
- metadata: metadata
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-set_image_metadata: os-set_image_metadata
|
||||
- metadata: metadata
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -161,11 +157,6 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Remove image metadata from a volume
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -181,10 +172,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- os-unset_image_metadata: os-unset_image_metadata
|
||||
- key: key
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-unset_image_metadata: os-unset_image_metadata
|
||||
- key: key
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -256,12 +247,12 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-attach: os-attach
|
||||
- instance_uuid: instance_uuid
|
||||
- mountpoint: mountpoint
|
||||
- host_name: host_name
|
||||
- os-attach: os-attach
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -271,10 +262,6 @@ Request Example
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Detach volume from server
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -294,10 +281,10 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- attachment_id: attachment_id
|
||||
- os-detach: os-detach
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-detach: os-detach
|
||||
- attachment_id: attachment_id
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -306,17 +293,14 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Unmanage a volume
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. 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
|
||||
|
||||
@ -330,9 +314,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- os-unmanage: os-unmanage
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-unmanage: os-unmanage
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -341,11 +325,6 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Force detach a volume
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -364,11 +343,11 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- connector: connector
|
||||
- attachment_id: attachment_id
|
||||
- os-force_detach: os-force_detach
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-force_detach: os-force_detach
|
||||
- attachment_id: attachment_id
|
||||
- connector: connector
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -377,11 +356,6 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Retype a volume
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
@ -404,11 +378,11 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-retype: os-retype
|
||||
- new_type: new_type
|
||||
- migration_policy: migration_policy
|
||||
- os-retype: os-retype
|
||||
- volume_id: volume_id_path
|
||||
- project_id: project_id_path
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -417,11 +391,6 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Force delete a volume
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -439,9 +408,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- os-force_delete: os-force_delete
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- os-force_delete: os-force_delete
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -450,17 +419,13 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Update a volume's bootable status
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. 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
|
||||
|
||||
@ -482,10 +447,6 @@ Request Example
|
||||
:language: javascript
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Upload volume to image
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
@ -72,6 +72,7 @@ return bad request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -81,8 +82,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -177,21 +177,20 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- volume: volume
|
||||
- size: size
|
||||
- description: description
|
||||
- imageRef: imageRef
|
||||
- multiattach: multiattach
|
||||
- availability_zone: availability_zone
|
||||
- source_volid: source_volid
|
||||
- name: name_13
|
||||
- volume: volume
|
||||
- consistencygroup_id: consistencygroup_id
|
||||
- volume_type: volume_type
|
||||
- description: description
|
||||
- multiattach: multiattach
|
||||
- snapshot_id: snapshot_id
|
||||
- OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints
|
||||
- source_replica: source_replica
|
||||
- name: name_13
|
||||
- imageRef: imageRef
|
||||
- volume_type: volume_type
|
||||
- metadata: metadata
|
||||
- project_id: project_id_path
|
||||
- consistencygroup_id: consistencygroup_id
|
||||
- OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -247,6 +246,7 @@ filters in the url, API will return bad request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400)
|
||||
|
||||
|
||||
@ -256,8 +256,7 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- project_id: project_id_path
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- sort: sort
|
||||
- limit: limit
|
||||
- offset: offset
|
||||
- marker: marker
|
||||
@ -297,7 +296,6 @@ Preconditions
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -363,7 +361,6 @@ Updates a volume.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -371,12 +368,12 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- volume: volume
|
||||
- description: description
|
||||
- name: name_13
|
||||
- metadata: metadata
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- volume: volume
|
||||
- description: description
|
||||
- name: name_8
|
||||
- metadata: metadata
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -491,9 +488,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- metadata: metadata_3
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- metadata: metadata_3
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -529,7 +526,6 @@ Shows metadata for a volume.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -568,7 +564,6 @@ Replaces all the volume's metadata with the key-value pairs in the request.
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
@ -576,9 +571,9 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- metadata: metadata_3
|
||||
- project_id: project_id_path
|
||||
- volume_id: volume_id_path
|
||||
- metadata: metadata_3
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
@ -710,7 +705,6 @@ Display volumes summary with total number of volumes and total size in GB
|
||||
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes:
|
||||
|
||||
|
||||
Request
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user