summaryrefslogtreecommitdiff
path: root/api-ref/source/datastores.inc
blob: db77a96474f267075e481c34294a6f1ffd5d5d46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
.. -*- 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/{project_id}/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: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
instanceFault(500), notImplemented(501), serviceUnavailable(503)


Request
-------

.. rest_parameters:: parameters.yaml

   - parameter_name: parameter_name
   - datastore_version_id: datastore_version_id
   - project_id: project_id


Response Example
----------------

.. literalinclude:: samples/db-show-parameter-details.json
   :language: javascript




List datastore versions
~~~~~~~~~~~~~~~~~~~~~~~

.. rest_method::  GET /v1.0/{project_id}/datastores/{datastore_name}/versions

Lists the available versions of a data store.

Normal response codes: 200

Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
instanceFault(500), notImplemented(501), serviceUnavailable(503)


Request
-------

.. rest_parameters:: parameters.yaml

   - datastore_name: datastore_name
   - project_id: project_id


Response Example
----------------

.. literalinclude:: samples/db-list-datastore-versions.json
   :language: javascript




List configuration parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rest_method::  GET /v1.0/{project_id}/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: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
instanceFault(500), notImplemented(501), serviceUnavailable(503)


Request
-------

.. rest_parameters:: parameters.yaml

   - datastore_version_id: datastore_version_id
   - project_id: project_id


Response Example
----------------

.. literalinclude:: samples/db-list-parameters-response.json
   :language: javascript