a96fad9f3b
Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566
367 lines
5.8 KiB
ReStructuredText
367 lines
5.8 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Quality of service (QoS) specifications (qos-specs)
|
|
===================================================
|
|
|
|
Administrators only.
|
|
|
|
Creates, lists, shows details for, associates, disassociates, sets
|
|
keys, unsets keys, and deletes quality of service (QoS)
|
|
specifications.
|
|
|
|
|
|
Disassociate QoS specification from all associations
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}/disassociate_all
|
|
|
|
Disassociates a QoS specification from all associations.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- qos_id: qos_id
|
|
|
|
|
|
Unset keys in QoS specification
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: PUT /v2/{project_id}/qos-specs/{qos_id}/delete_keys
|
|
|
|
Unsets keys in a QoS specification.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- keys: keys
|
|
- project_id: project_id_path
|
|
- qos_id: qos_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/qos-unset-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/qos-unset-response.json
|
|
:language: javascript
|
|
|
|
|
|
Get all associations for QoS specification
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}/associations
|
|
|
|
Lists all associations for a QoS specification.
|
|
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- qos_id: qos_id
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/qos-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
Associate QoS specification with volume type
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}/associate
|
|
|
|
Associates a QoS specification with a volume type.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- qos_id: qos_id
|
|
- vol_type_id: vol_type_id
|
|
|
|
|
|
Disassociate QoS specification from volume type
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}/disassociate
|
|
|
|
Disassociates a QoS specification from a volume type.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- qos_id: qos_id
|
|
- vol_type_id: vol_type_id
|
|
|
|
|
|
Show QoS specification details
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}
|
|
|
|
Shows details for a QoS specification.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error ../status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
- 405
|
|
- 413
|
|
- 503
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- qos_id: qos_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- name: name_4
|
|
- links: links_2
|
|
- id: id_3
|
|
- qos_specs: qos_specs
|
|
- consumer: consumer
|
|
- specs: specs
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/qos-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
Set keys in QoS specification
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: PUT /v2/{project_id}/qos-specs/{qos_id}
|
|
|
|
Sets keys in a QoS specification.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- qos_specs: qos_specs
|
|
- specs: specs
|
|
- project_id: project_id_path
|
|
- qos_id: qos_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/qos-update-request.json
|
|
:language: javascript
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/qos-update-response.json
|
|
:language: javascript
|
|
|
|
|
|
Delete QoS specification
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: DELETE /v2/{project_id}/qos-specs/{qos_id}
|
|
|
|
Deletes a QoS specification.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 202
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- qos_id: qos_id
|
|
- force: force
|
|
|
|
|
|
Create QoS specification
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST /v2/{project_id}/qos-specs
|
|
|
|
Creates a QoS specification.
|
|
|
|
Specify one or more key and value pairs in the request body.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 202
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- qos_specs: qos_specs
|
|
- consumer: consumer
|
|
- name: name_4
|
|
- project_id: project_id_path
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/qos-create-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- name: name_4
|
|
- links: links_2
|
|
- id: id_3
|
|
- qos_specs: qos_specs
|
|
- consumer: consumer
|
|
- specs: specs
|
|
|
|
|
|
List QoS specs
|
|
--------------
|
|
|
|
.. rest_method:: GET /v2/{project_id}/qos-specs
|
|
|
|
Lists quality of service (QoS) specifications.
|
|
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 200
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- sort_key: sort_key
|
|
- sort_dir: sort_dir
|
|
- limit: limit
|
|
- marker: marker
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- specs: specs
|
|
- qos_specs: qos_specs
|
|
- consumer: consumer
|
|
- id: id_3
|
|
- name: name_4
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/qos-list-response.json
|
|
:language: javascript
|