3b0d1ea25d
With this email[0], you must migrate API reference docs into RST. The conf.py and the tox environment are also cribbed from nova. Still need to retain the install_command in tox.ini, otherwise the api-ref job fails. [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Co-Authored-By: Anne Gentle <agentle@cisco.com> Co-Authored-By: Amrith Kumar <amrith@tesora.com> Change-Id: I3315261aa18729fa7a6aa79d4a1d6c24de1e2c6b
144 lines
2.2 KiB
ReStructuredText
144 lines
2.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
========================
|
|
Data stores (datastores)
|
|
========================
|
|
|
|
Lists data store versions, lists parameters for data stores, and
|
|
shows parameter details for a data store version.
|
|
|
|
|
|
Show configuration parameter details
|
|
====================================
|
|
|
|
.. rest_method:: GET /v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters/{parameter_name}
|
|
|
|
Displays details for a configuration parameter associated with a data store version.
|
|
|
|
Details include the type, minimum and maximum values, and whether
|
|
you must restart the instance after you change the parameter value.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:413,405,404,403,401,400,422,503,500,501,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- parameter_name: parameter_name
|
|
- datastore_version_id: datastore_version_id
|
|
- accountId: accountId
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/db-show-parameter-details.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List datastore versions
|
|
=======================
|
|
|
|
.. rest_method:: GET /v1.0/{accountId}/datastores/{datastore_name}/versions
|
|
|
|
Lists the available versions of a data store.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:413,405,404,403,401,400,422,503,500,501,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- datastore_name: datastore_name
|
|
- accountId: accountId
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/db-list-datastore-versions.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List configuration parameters
|
|
=============================
|
|
|
|
.. rest_method:: GET /v1.0/{accountId}/datastores/versions/{datastore_version_id}/parameters
|
|
|
|
Lists the available configuration parameters for a data store version.
|
|
|
|
Parameter information includes the type, minimum and maximum
|
|
values, and whether you must restart the instance after you change
|
|
a parameter value.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:413,405,404,403,401,400,422,503,500,501,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- datastore_version_id: datastore_version_id
|
|
- accountId: accountId
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/db-list-parameters-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|