ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
363 lines
5.3 KiB
ReStructuredText
363 lines
5.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
===================================================
|
|
Quality of service (QoS) specifications (qos-specs)
|
|
===================================================
|
|
|
|
Administrators only, depending on policy settings.
|
|
|
|
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/{tenant_id}/qos-specs/{qos_id}/disassociate_all
|
|
|
|
Disassociates a QoS specification from all associations.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- qos_id: qos_id
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unset keys in QoS specification
|
|
===============================
|
|
|
|
.. rest_method:: PUT /v2/{tenant_id}/qos-specs/{qos_id}/delete_keys
|
|
|
|
Unsets keys in a QoS specification.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- keys: keys
|
|
- tenant_id: tenant_id
|
|
- qos_id: qos_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/qos-specs/qos-unset-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude::
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Get all associations for QoS specification
|
|
==========================================
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/associations
|
|
|
|
Lists all associations for a QoS specification.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- qos_id: qos_id
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/qos-specs/qos-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Associate QoS specification with volume type
|
|
============================================
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/associate
|
|
|
|
Associates a QoS specification with a volume type.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- qos_id: qos_id
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Disassociate QoS specification from volume type
|
|
===============================================
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/disassociate
|
|
|
|
Disassociates a QoS specification from a volume type.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- qos_id: qos_id
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Show QoS specification details
|
|
==============================
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}
|
|
|
|
Shows details for a QoS specification.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:413,405,404,403,401,400,503,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- qos_id: qos_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- name: name
|
|
- links: links
|
|
- id: id
|
|
- qos_specs: qos_specs
|
|
- consumer: consumer
|
|
- specs: specs
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/qos-specs/qos-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Set keys in QoS specification
|
|
=============================
|
|
|
|
.. rest_method:: PUT /v2/{tenant_id}/qos-specs/{qos_id}
|
|
|
|
Sets keys in a QoS specification.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- qos_specs: qos_specs
|
|
- specs: specs
|
|
- tenant_id: tenant_id
|
|
- qos_id: qos_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/qos-specs/qos-update-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/qos-specs/qos-update-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Delete QoS specification
|
|
========================
|
|
|
|
.. rest_method:: DELETE /v2/{tenant_id}/qos-specs/{qos_id}
|
|
|
|
Deletes a QoS specification.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- qos_id: qos_id
|
|
- force: force
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Create QoS specification
|
|
========================
|
|
|
|
.. rest_method:: POST /v2/{tenant_id}/qos-specs
|
|
|
|
Creates a QoS specification.
|
|
|
|
Specify one or more key and value pairs in the request body.
|
|
|
|
Error response codes:202,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- qos_specs: qos_specs
|
|
- consumer: consumer
|
|
- name: name
|
|
- tenant_id: tenant_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/qos-specs/qos-create-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- name: name
|
|
- links: links
|
|
- id: id
|
|
- qos_specs: qos_specs
|
|
- consumer: consumer
|
|
- specs: specs
|
|
|
|
|
|
|
|
|
|
|
|
List QoS specs
|
|
==============
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/qos-specs
|
|
|
|
Lists quality of service (QoS) specifications.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:300,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- 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
|
|
- name: name
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/qos-specs/qos-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|