Improve API doc
Change-Id: If48ef016c6fb7a875ceabc9f106e4cd85858d147
This commit is contained in:
Lingxian Kong
parent
b4bc1d85f0
commit
dacb400e0b
@ -327,6 +327,7 @@
|
|||||||
- openstack/tempest
|
- openstack/tempest
|
||||||
irrelevant-files:
|
irrelevant-files:
|
||||||
- ^.*\.rst$
|
- ^.*\.rst$
|
||||||
|
- ^api-ref/.*$
|
||||||
- ^doc/.*$
|
- ^doc/.*$
|
||||||
- ^etc/.*$
|
- ^etc/.*$
|
||||||
- ^releasenotes/.*$
|
- ^releasenotes/.*$
|
||||||
|
|||||||
@ -4,8 +4,7 @@
|
|||||||
API versions
|
API versions
|
||||||
============
|
============
|
||||||
|
|
||||||
Lists information for all Database Service API versions and shows
|
Lists information for all Database Service API versions.
|
||||||
Database Service v1.0 details.
|
|
||||||
|
|
||||||
|
|
||||||
List versions
|
List versions
|
||||||
@ -13,40 +12,13 @@ List versions
|
|||||||
|
|
||||||
.. rest_method:: GET /
|
.. rest_method:: GET /
|
||||||
|
|
||||||
Lists information about all Database Service API versions.
|
Lists information about all Database Service API versions. No authentication
|
||||||
|
needed.
|
||||||
|
|
||||||
Normal response codes: 200
|
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)
|
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-versions-response.json
|
.. literalinclude:: samples/versions-response.json
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Show version details
|
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: GET /v1.0
|
|
||||||
|
|
||||||
Shows details for the Database Service API v1.0.
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-version-response.json
|
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|||||||
@ -4,7 +4,7 @@
|
|||||||
Backups
|
Backups
|
||||||
=======
|
=======
|
||||||
|
|
||||||
List, show details, create and delete backups.
|
|
||||||
|
|
||||||
|
|
||||||
List database backups
|
List database backups
|
||||||
@ -17,16 +17,12 @@ using query string parameters. The following filters are supported:
|
|||||||
|
|
||||||
- ``instance_id={instance_id}`` - Return the list of backups for a particular
|
- ``instance_id={instance_id}`` - Return the list of backups for a particular
|
||||||
database instance.
|
database instance.
|
||||||
- ``all_projects`` - Return the list of backups for all the projects, this is
|
- ``all_projects=True/False`` - Return the list of backups for all the
|
||||||
admin only param by default.
|
projects, this is an admin only param by default.
|
||||||
|
- ``datastore={datastore}`` - Return a list of backups of the same datastore.
|
||||||
|
|
||||||
Normal response codes: 200
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
@ -60,34 +56,42 @@ Response Parameters
|
|||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-backup-list-response.json
|
.. literalinclude:: samples/backup-list-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
List database backups for an instance
|
Create database backup
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/backups
|
.. rest_method:: POST /v1.0/{project_id}/backups
|
||||||
|
|
||||||
List all database backups for the specified instance. This is equivalent to
|
Creates a database backup for instance.
|
||||||
``GET /v1.0/{project_id}/backups?instance_id={instanceId}``.
|
|
||||||
|
|
||||||
Normal response codes: 200
|
In the Trove deployment with service tenant enabled, The backup data is
|
||||||
|
stored as objects in OpenStack Swift service in the user's
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
container(``database_backups`` by default)
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
|
|
||||||
instanceFault(500), notImplemented(501), serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- name: backup_name
|
||||||
|
- instance: backup_instanceId
|
||||||
|
- parent_id: backup_parentId
|
||||||
|
- incremental: backup_incremental
|
||||||
|
- description: backup_description
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/backup-create-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -95,7 +99,6 @@ Response Parameters
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- backups: backup_list
|
|
||||||
- created: created
|
- created: created
|
||||||
- datastore: datastore2
|
- datastore: datastore2
|
||||||
- datastore.type: datastore_type1
|
- datastore.type: datastore_type1
|
||||||
@ -115,7 +118,7 @@ Response Parameters
|
|||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-backups-by-instance-response.json
|
.. literalinclude:: samples/backup-create-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -130,11 +133,6 @@ Show detailes of a backup.
|
|||||||
|
|
||||||
Normal response codes: 200
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
@ -168,71 +166,7 @@ Response Parameters
|
|||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-backup-get-response.json
|
.. literalinclude:: samples/backup-get-response.json
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Create database backup
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: POST /v1.0/{project_id}/backups
|
|
||||||
|
|
||||||
Creates a database backup for instance.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
- name: backup_name
|
|
||||||
- instance: backup_instanceId
|
|
||||||
- parent_id: backup_parentId
|
|
||||||
- incremental: backup_incremental
|
|
||||||
- description: backup_description
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-backup-create-request.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- created: created
|
|
||||||
- datastore: datastore2
|
|
||||||
- datastore.type: datastore_type1
|
|
||||||
- datastore.version: datastore_version_name
|
|
||||||
- datastore.version_id: datastore_version_id1
|
|
||||||
- description: backup_description1
|
|
||||||
- id: backup_id
|
|
||||||
- instance_id: backup_instanceId
|
|
||||||
- locationRef: backup_locationRef
|
|
||||||
- name: backup_name
|
|
||||||
- parent_id: backup_parentId1
|
|
||||||
- size: backup_size
|
|
||||||
- status: backup_status
|
|
||||||
- updated: updated
|
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-backup-create-response.json
|
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -247,15 +181,10 @@ Deletes a database backup.
|
|||||||
|
|
||||||
Normal response codes: 202
|
Normal response codes: 202
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
|
|
||||||
instanceFault(500), notImplemented(501), serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- backupId: backup_id
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- backupId: backup_id
|
||||||
@ -1,49 +1,8 @@
|
|||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
|
|
||||||
=====================================
|
====================
|
||||||
Configuration groups (configurations)
|
Configuration groups
|
||||||
=====================================
|
====================
|
||||||
|
|
||||||
Creates and lists all configuration groups.
|
|
||||||
|
|
||||||
|
|
||||||
Create configuration group
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: POST /v1.0/{project_id}/configurations
|
|
||||||
|
|
||||||
Creates a configuration group.
|
|
||||||
|
|
||||||
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: datastore
|
|
||||||
- values: values
|
|
||||||
- name: name
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-create-config-group-request.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-create-config-group-response.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -55,15 +14,8 @@ List configuration groups
|
|||||||
|
|
||||||
Lists all configuration groups.
|
Lists all configuration groups.
|
||||||
|
|
||||||
The list includes the associated data store and data store version
|
|
||||||
for each configuration group.
|
|
||||||
|
|
||||||
Normal response codes: 200
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
@ -76,14 +28,78 @@ Request
|
|||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-list-cfg-groups-response.json
|
.. literalinclude:: samples/config-groups-list-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
List configuration group instances
|
Create configuration group
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/configurations
|
||||||
|
|
||||||
|
Creates a configuration group.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore: datastore
|
||||||
|
- name: name
|
||||||
|
- values: values
|
||||||
|
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/config-group-create-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/config-group-create-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Show configuration group details
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/configurations/{configId}
|
||||||
|
|
||||||
|
Lists details about a configuration group, including its values.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- configId: configId
|
||||||
|
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/config-group-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
List instances applied the configuration group
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v1.0/{project_id}/configurations/{configId}/instances
|
.. rest_method:: GET /v1.0/{project_id}/configurations/{configId}/instances
|
||||||
|
|
||||||
@ -91,54 +107,25 @@ Lists the instances associated with the specified configuration group.
|
|||||||
|
|
||||||
Normal response codes: 200
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- configId: configId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- configId: configId
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-config-group-instances-response.json
|
.. literalinclude:: samples/config-group-list-instances-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Delete configuration group
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: DELETE /v1.0/{project_id}/configurations/{configId}
|
|
||||||
|
|
||||||
Deletes a configuration group.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
- configId: configId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Patch configuration group
|
Patch configuration group
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
@ -148,64 +135,21 @@ Sets new values for a configuration group.
|
|||||||
|
|
||||||
Normal response codes: 200
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- values: values
|
|
||||||
- configId: configId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- configId: configId
|
||||||
|
- values: values
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-patch-config-group-request.json
|
.. literalinclude:: samples/config-group-patch-request.json
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-patch-config-group-response-json-http.txt
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Show configuration group details
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: GET /v1.0/{project_id}/configurations/{configId}
|
|
||||||
|
|
||||||
Lists details about a configuration group, including its values.
|
|
||||||
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
- configId: configId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-config-group-details-response.json
|
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -220,9 +164,6 @@ Sets new values for a configuration group. Also lets you change the name and
|
|||||||
description of the configuration group.
|
description of the configuration group.
|
||||||
|
|
||||||
Normal response codes: 202
|
Normal response codes: 202
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
|
|
||||||
instanceFault(500), notImplemented(501), serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
@ -230,15 +171,36 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- configId: configId
|
||||||
- values: values
|
- values: values
|
||||||
- description: description
|
- description: description
|
||||||
- name: name
|
- name: name
|
||||||
- configId: configId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-update-config-group-request.json
|
.. literalinclude:: samples/config-group-put-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Delete configuration group
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: DELETE /v1.0/{project_id}/configurations/{configId}
|
||||||
|
|
||||||
|
Deletes a configuration group.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- configId: configId
|
||||||
@ -1,221 +0,0 @@
|
|||||||
.. -*- rst -*-
|
|
||||||
|
|
||||||
==================================
|
|
||||||
Database instance actions (action)
|
|
||||||
==================================
|
|
||||||
|
|
||||||
Resizes instances and volumes and restarts instances.
|
|
||||||
|
|
||||||
|
|
||||||
Restart instance
|
|
||||||
~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
|
||||||
|
|
||||||
Restarts the database service for an instance.
|
|
||||||
|
|
||||||
The restart operation restarts only the database instance. Restarting
|
|
||||||
the database erases any dynamic configuration settings that you make
|
|
||||||
in the database instance.
|
|
||||||
|
|
||||||
The database instance is unavailable until the instance restarts.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-restart-request.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Resize instance
|
|
||||||
~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
|
||||||
|
|
||||||
Resizes the memory for an instance.
|
|
||||||
|
|
||||||
If you provide a valid ``flavorRef``, this operation changes the
|
|
||||||
memory size of the instance, and restarts the database.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-resize-instance-request.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Resize instance volume
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
|
||||||
|
|
||||||
Resizes the volume that is attached to an instance.
|
|
||||||
|
|
||||||
You can use this operation to increase but not decrease the volume
|
|
||||||
size. A valid volume size is an integer value in gigabytes (GB).
|
|
||||||
|
|
||||||
You cannot increase the volume to a size that is larger than the
|
|
||||||
API volume size limit.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-resize-volume-request.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Promote instance to replica source
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
|
||||||
|
|
||||||
Promotes a replica.
|
|
||||||
|
|
||||||
If you have set up replication, and the base instance is still
|
|
||||||
reachable, you can use this operation to promote a replica to be
|
|
||||||
the new base instance.
|
|
||||||
|
|
||||||
This can be useful if you want to make a configuration change to
|
|
||||||
the base instance that your replicas are replicating from. For
|
|
||||||
example, you might want to increase the disk or CPU capacity. If
|
|
||||||
you made the change on the base instance directly, you would need
|
|
||||||
to take the base instance down for the duration of the operation.
|
|
||||||
Instead, you can create a replica, make the configuration change on
|
|
||||||
the replica, and then promote the replica to become the new base
|
|
||||||
instance.
|
|
||||||
|
|
||||||
For ``instanceId``, pass in the instance ID of the replica you want
|
|
||||||
to promote.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-promote-replica-request.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Delete replication base instance
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
|
||||||
|
|
||||||
Deletes the base instance in a replication set.
|
|
||||||
|
|
||||||
If the base instance becomes unreachable, you can use this
|
|
||||||
operation to delete the base instance.
|
|
||||||
|
|
||||||
This operation:
|
|
||||||
|
|
||||||
- Finds the replica that has processed the greatest number of
|
|
||||||
transactions and picks that replica to use as the new base
|
|
||||||
instance.
|
|
||||||
|
|
||||||
- Transfers the public IP of the old base instance to the new base
|
|
||||||
instance (which is the newly-promoted replica).
|
|
||||||
|
|
||||||
- Deletes the old base instance.
|
|
||||||
|
|
||||||
- Takes all the instances in the replication set and makes them
|
|
||||||
start replicating from the new base instance.
|
|
||||||
|
|
||||||
For ``instanceId``, pass in the instance ID of the unreachable base
|
|
||||||
instance.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-eject-replica-request.json
|
|
||||||
:language: javascript
|
|
||||||
@ -1,37 +1,8 @@
|
|||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
|
|
||||||
=====================
|
=========
|
||||||
Databases (databases)
|
Databases
|
||||||
=====================
|
=========
|
||||||
|
|
||||||
Creates, lists all, and deletes databases.
|
|
||||||
|
|
||||||
|
|
||||||
Delete database
|
|
||||||
~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: DELETE /v1.0/{project_id}/instances/{instanceId}/databases/{databaseName}
|
|
||||||
|
|
||||||
Deletes a database.
|
|
||||||
|
|
||||||
This operation also deletes all data that is associated with the
|
|
||||||
database.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- databaseName: databaseName
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -45,27 +16,23 @@ Creates a database within an instance.
|
|||||||
|
|
||||||
Normal response codes: 202
|
Normal response codes: 202
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
|
|
||||||
instanceFault(500), notImplemented(501), serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
- name: name
|
||||||
- characterSet: characterSet
|
- characterSet: characterSet
|
||||||
- collate: collate
|
- collate: collate
|
||||||
- name: name
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-create-databases-request.json
|
.. literalinclude:: samples/databases-create-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -78,29 +45,127 @@ List instance databases
|
|||||||
|
|
||||||
Lists databases for an instance.
|
Lists databases for an instance.
|
||||||
|
|
||||||
This operation returns only the user-defined databases and not the
|
This operation returns only the user-defined databases and not the system
|
||||||
system databases. Only the database administrator can view the
|
databases. Only the database administrator can get system databases such as
|
||||||
``mysql``, ``information_schema``, and ``lost+found`` system
|
``mysql``, ``information_schema``, and ``lost+found``.
|
||||||
databases.
|
|
||||||
|
|
||||||
Normal response codes: 200
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-list-databases-response.json
|
.. literalinclude:: samples/databases-list-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
List instance databases for a user
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/users/{user_name}/databases
|
||||||
|
|
||||||
|
Get all the databases that the user has access to.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
- user_name: user_name
|
||||||
|
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/databases-list-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Grant databases access
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: PUT /v1.0/{project_id}/instances/{instanceId}/users/{user_name}/databases
|
||||||
|
|
||||||
|
Grant user access to the databases.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
- user_name: user_name
|
||||||
|
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/user-grant-databases-access-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Revoke databases access
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: DELETE /v1.0/{project_id}/instances/{instanceId}/users/{user_name}/databases/{database_name}
|
||||||
|
|
||||||
|
Revoke user access to the database.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
- user_name: user_name
|
||||||
|
- database_name: databaseName
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Delete database
|
||||||
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: DELETE /v1.0/{project_id}/instances/{instanceId}/databases/{database_name}
|
||||||
|
|
||||||
|
Deletes a database.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
- database_name: databaseName
|
||||||
391
api-ref/source/datastore-versions.inc
Normal file
391
api-ref/source/datastore-versions.inc
Normal file
@ -0,0 +1,391 @@
|
|||||||
|
.. -*- rst -*-
|
||||||
|
|
||||||
|
==================
|
||||||
|
Datastore Versions
|
||||||
|
==================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
List datastore versions
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/datastores/{datastore}/versions
|
||||||
|
|
||||||
|
Get all the registered versions for a given datastore
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore: data_store
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-list-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Show datastore version
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/datastores/{datastore}/versions/{version}
|
||||||
|
|
||||||
|
Get information for a given datastore version(name or ID)
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore: data_store
|
||||||
|
- version: version
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
List datastore version configuration parameters
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/datastores/{datastore}/versions/{version}/parameters
|
||||||
|
|
||||||
|
Get all the config parameters associated with the specified datastore version
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore: data_store
|
||||||
|
- version: version
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-parameter-list-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Show datastore version configuration parameter
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/datastores/{datastore}/versions/{version}/parameters/{parameter_name}
|
||||||
|
|
||||||
|
Get the specified config parameter definition.
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore: data_store
|
||||||
|
- version: version
|
||||||
|
- parameter_name: parameter_name
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-parameter-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Show datastore version
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/datastores/versions/{datastore_version_id}
|
||||||
|
|
||||||
|
Get information for a given datastore version ID.
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore_version_id: datastore_version_id
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
List datastore version configuration parameters
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/datastores/versions/{datastore_version_id}/parameters
|
||||||
|
|
||||||
|
Get all the config parameters associated with the specified datastore version
|
||||||
|
ID.
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore_version_id: datastore_version_id
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-parameter-list-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Show datastore version configuration parameter
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/datastores/versions/{datastore_version_id}/parameters/{parameter_name}
|
||||||
|
|
||||||
|
Get the specified config parameter definition.
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore_version_id: datastore_version_id
|
||||||
|
- parameter_name: parameter_name
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-parameter-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Create datastore version configuration parameters
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/mgmt/datastores/versions/{datastore_version_id}/parameters
|
||||||
|
|
||||||
|
Admin only API. Register a configuration parameter for the specified datastore
|
||||||
|
version. The parameter definition contains the type, minimum and maximum
|
||||||
|
values(if type is integer), and whether you must restart the instance after the
|
||||||
|
parameter value is changed.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore_version_id: datastore_version_id
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-parameter-create-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-parameter-create-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Update a datastore version configuration parameter
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: PUT /v1.0/{project_id}/mgmt/datastores/versions/{datastore_version_id}/parameters/{parameter_name}
|
||||||
|
|
||||||
|
Admin only API. Update a configuration parameter for the specified datastore
|
||||||
|
version.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore_version_id: datastore_version_id
|
||||||
|
- parameter_name: parameter_name
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-parameter-update-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-parameter-update-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Delete a datastore version configuration parameter
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: DELETE /v1.0/{project_id}/mgmt/datastores/versions/{datastore_version_id}/parameters/{parameter_name}
|
||||||
|
|
||||||
|
Admin only API. Remove a configuration parameter for the specified datastore
|
||||||
|
version.
|
||||||
|
|
||||||
|
Normal response codes: 204
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore_version_id: datastore_version_id
|
||||||
|
- parameter_name: parameter_name
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Create datastore version
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/mgmt/datastore-versions
|
||||||
|
|
||||||
|
Admin only API. Register a datastore version, create the datastore if doesn't
|
||||||
|
exist.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-create-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
List datastore versions
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/mgmt/datastore-versions
|
||||||
|
|
||||||
|
Admin only API. Get all the datastore versions.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-mgmt-list-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Show datastore version details
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/mgmt/datastore-versions/{datastore_version_id}
|
||||||
|
|
||||||
|
Admin only API. Get information for a datastore version.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore_version_id: datastore_version_id
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-mgmt-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Update datastore version details
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: PATCH /v1.0/{project_id}/mgmt/datastore-versions/{datastore_version_id}
|
||||||
|
|
||||||
|
Admin only API. Update a specific datastore version.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore_version_id: datastore_version_id
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/datastore-version-mgmt-patch-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Delete a datastore version
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: DELETE /v1.0/{project_id}/mgmt/datastore-versions/{datastore_version_id}
|
||||||
|
|
||||||
|
Admin only API. Delete a specific datastore version.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- datastore_version_id: datastore_version_id
|
||||||
@ -1,111 +1,52 @@
|
|||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
|
|
||||||
========================
|
==========
|
||||||
Data stores (datastores)
|
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
|
List datastores
|
||||||
version.
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Details include the type, minimum and maximum values, and whether
|
.. rest_method:: GET /v1.0/{project_id}/datastores
|
||||||
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)
|
|
||||||
|
|
||||||
|
Get all the datastores registered in the system
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- parameter_name: parameter_name
|
|
||||||
- datastore_version_id: datastore_version_id
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-show-parameter-details.json
|
.. literalinclude:: samples/datastore-list-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
List datastore versions
|
Show datastore details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v1.0/{project_id}/datastores/{datastore_name}/versions
|
.. rest_method:: GET /v1.0/{project_id}/datastores/{datastore}
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
|
Shows datastore details
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- datastore_name: datastore_name
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- datastore: data_store
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-list-datastore-versions.json
|
.. literalinclude:: samples/datastore-show-response.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
|
:language: javascript
|
||||||
|
|||||||
@ -7,12 +7,13 @@
|
|||||||
.. rest_expand_all::
|
.. rest_expand_all::
|
||||||
|
|
||||||
.. include:: api-versions.inc
|
.. include:: api-versions.inc
|
||||||
.. include:: database-instances.inc
|
|
||||||
.. include:: database-instance-actions.inc
|
|
||||||
.. include:: database-instance-logs.inc
|
|
||||||
.. include:: databases.inc
|
|
||||||
.. include:: user-management.inc
|
|
||||||
.. include:: datastores.inc
|
.. include:: datastores.inc
|
||||||
.. include:: configurations.inc
|
.. include:: datastore-versions.inc
|
||||||
|
.. include:: instances.inc
|
||||||
|
.. include:: instance-actions.inc
|
||||||
|
.. include:: instance-logs.inc
|
||||||
.. include:: backups.inc
|
.. include:: backups.inc
|
||||||
|
.. include:: configurations.inc
|
||||||
|
.. include:: databases.inc
|
||||||
|
.. include:: users.inc
|
||||||
.. include:: quotas.inc
|
.. include:: quotas.inc
|
||||||
|
|||||||
311
api-ref/source/instance-actions.inc
Normal file
311
api-ref/source/instance-actions.inc
Normal file
@ -0,0 +1,311 @@
|
|||||||
|
.. -*- rst -*-
|
||||||
|
|
||||||
|
================
|
||||||
|
Instance actions
|
||||||
|
================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Restart instance
|
||||||
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Restarts the database service for an instance.
|
||||||
|
|
||||||
|
The restart operation restarts only the database instance. Restarting
|
||||||
|
the database erases any dynamic configuration settings that you make
|
||||||
|
in the database instance.
|
||||||
|
|
||||||
|
The database service is unavailable until the instance restart finishes.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-action-restart-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Resize instance flavor
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Resizes the (Nova)flavor for an instance.
|
||||||
|
|
||||||
|
If you provide a valid ``flavorRef``, this operation changes the
|
||||||
|
memory size of the instance, and restarts the database.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
- flavorRef: flavorRef
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-action-resize-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Resize instance volume
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Resizes the volume that is attached to an instance.
|
||||||
|
|
||||||
|
You can use this operation to increase but not decrease the volume
|
||||||
|
size. A valid volume size is an integer value in gigabytes (GB).
|
||||||
|
|
||||||
|
You cannot increase the volume to a size that is larger than the
|
||||||
|
API volume size limit.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
- volume: volume
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-action-resize-volume-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Promote instance to replica master
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Promotes a replica.
|
||||||
|
|
||||||
|
If you have set up replication, and the master instance is still reachable, you
|
||||||
|
can use this operation to promote a replica to be the new master instance.
|
||||||
|
|
||||||
|
This can be useful if you want to make a configuration change or maintenance to
|
||||||
|
the master instance. If you made the change on the master instance directly,
|
||||||
|
you would need to take the master instance down for the duration of the
|
||||||
|
operation. Instead, you can create a replica, make the configuration change on
|
||||||
|
the replica, and then promote the replica to become the new master instance.
|
||||||
|
|
||||||
|
Once this command is executed, the status of all the instances will be set to
|
||||||
|
``PROMOTE`` and Trove will work its magic until all of them to come back to
|
||||||
|
``HEALTHY``.
|
||||||
|
|
||||||
|
The ``instanceId`` is the instance ID of the replica you want to promote.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-action-promote-replica-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Eject the master instance
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Remove the master instance in a replication set.
|
||||||
|
|
||||||
|
This should be only done in a failed master scenario. This command ejects the
|
||||||
|
current master and then forces a re-election for the new master. The new master
|
||||||
|
is effectively the one with the most current replica of the old master.
|
||||||
|
|
||||||
|
Once this command is executed, the status of all the instances will be set to
|
||||||
|
``EJECT`` and Trove will work its magic until all of them to come back to
|
||||||
|
``HEALTHY``.
|
||||||
|
|
||||||
|
The ``instanceId`` is the ID of the current unavailable master instance.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-action-eject-replica-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Reset instance status
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Set instance service status to ``ERROR`` and clear the current task status.
|
||||||
|
Mark any running backup operations as ``FAILED``.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-action-reset-status-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Stop database service
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/mgmt/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Admin only API. Stop database service inside an instance.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-mgmt-action-stop-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Reboot instance
|
||||||
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/mgmt/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Admin only API. Reboot the database instance, database service will be stopped
|
||||||
|
before rebooting.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-mgmt-action-reboot-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Cold Migrate instance
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/mgmt/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Admin only API. Migrate(resize) the database instance, database service will be
|
||||||
|
stopped before migrating.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-mgmt-action-migrate-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Reset instance task status
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: POST /v1.0/{project_id}/mgmt/instances/{instanceId}/action
|
||||||
|
|
||||||
|
Admin only API. Reset task status of an instance, mark any running backup
|
||||||
|
operations as ``FAILED``.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-mgmt-action-reset-task-status-request.json
|
||||||
|
:language: javascript
|
||||||
@ -1,10 +1,10 @@
|
|||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
|
|
||||||
======================
|
=============
|
||||||
Database instance logs
|
Instance logs
|
||||||
======================
|
=============
|
||||||
|
|
||||||
|
|
||||||
List, show details, enable, disable, publish, and discard logs for instances.
|
|
||||||
|
|
||||||
|
|
||||||
List instance logs
|
List instance logs
|
||||||
@ -15,24 +15,18 @@ List instance logs
|
|||||||
Listing all logs for an instance.
|
Listing all logs for an instance.
|
||||||
|
|
||||||
Different datastore backend has its own ``guest_log_exposed_logs``
|
Different datastore backend has its own ``guest_log_exposed_logs``
|
||||||
configuration to determine which type of logs will be listed by default. For
|
configuration to determine which type of logs will be listed by default. Admin
|
||||||
admin context, all logs will be listed.
|
user can get all the logs.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -54,7 +48,7 @@ Response Parameters
|
|||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-list-logs-response.json
|
.. literalinclude:: samples/instance-log-list-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -69,29 +63,21 @@ Show details for a instance log.
|
|||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
- name: log_name
|
- name: log_name
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-show-log-request.json
|
.. literalinclude:: samples/instance-log-show-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
@ -107,11 +93,10 @@ Response Parameters
|
|||||||
- prefix: log_prefix
|
- prefix: log_prefix
|
||||||
- metafile: log_metafile
|
- metafile: log_metafile
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-show-log-response.json
|
.. literalinclude:: samples/instance-log-show-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -126,30 +111,22 @@ Enable a log type for a instance.
|
|||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
- name: log_name
|
- name: log_name
|
||||||
- enable: log_enable_action
|
- enable: log_enable_action
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-enable-log-request.json
|
.. literalinclude:: samples/instance-log-enable-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
@ -165,11 +142,10 @@ Response Parameters
|
|||||||
- prefix: log_prefix
|
- prefix: log_prefix
|
||||||
- metafile: log_metafile
|
- metafile: log_metafile
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-enable-log-response.json
|
.. literalinclude:: samples/instance-log-enable-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -184,30 +160,22 @@ Disable a log type for a instance.
|
|||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
- name: log_name
|
- name: log_name
|
||||||
- disable: log_disable_action
|
- disable: log_disable_action
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-disable-log-request.json
|
.. literalinclude:: samples/instance-log-disable-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
@ -227,7 +195,7 @@ Response Parameters
|
|||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-disable-log-response.json
|
.. literalinclude:: samples/instance-log-disable-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -240,34 +208,26 @@ Publish instance log
|
|||||||
|
|
||||||
Publish a log type for a instance.
|
Publish a log type for a instance.
|
||||||
|
|
||||||
*Note:* ``publish`` will automatically ``enable`` a log.
|
Publish`` will automatically ``enable`` a log.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
- name: log_name
|
- name: log_name
|
||||||
- publish: log_publish_action
|
- publish: log_publish_action
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-publish-log-request.json
|
.. literalinclude:: samples/instance-log-publish-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
@ -283,11 +243,10 @@ Response Parameters
|
|||||||
- prefix: log_prefix
|
- prefix: log_prefix
|
||||||
- metafile: log_metafile
|
- metafile: log_metafile
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-publish-log-response.json
|
.. literalinclude:: samples/instance-log-publish-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -302,19 +261,13 @@ Discard all previously published logs for a instance.
|
|||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
- name: log_name
|
- name: log_name
|
||||||
- discard: log_discard_action
|
- discard: log_discard_action
|
||||||
|
|
||||||
@ -322,7 +275,7 @@ Request
|
|||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-discard-log-request.json
|
.. literalinclude:: samples/instance-log-discard-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -345,5 +298,5 @@ Response Parameters
|
|||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-discard-log-response.json
|
.. literalinclude:: samples/instance-log-discard-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
@ -1,13 +1,10 @@
|
|||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
|
|
||||||
==============================
|
=========
|
||||||
Database instances (instances)
|
Instances
|
||||||
==============================
|
=========
|
||||||
|
|
||||||
|
|
||||||
Lists, shows details for, creates, attaches a configuration group to, detaches
|
|
||||||
a configuration group from, update the name, upgrade datastore version,
|
|
||||||
deletes, lists configuration defaults, creates root, and determines whether
|
|
||||||
root is enabled, for instances.
|
|
||||||
|
|
||||||
|
|
||||||
List database instances
|
List database instances
|
||||||
@ -15,17 +12,11 @@ List database instances
|
|||||||
|
|
||||||
.. rest_method:: GET /v1.0/{project_id}/instances
|
.. rest_method:: GET /v1.0/{project_id}/instances
|
||||||
|
|
||||||
Lists information, including status, for all database instances.
|
Lists information for all database instances. Supported filters:
|
||||||
|
include_clustered
|
||||||
Lists status and information for all database instances.
|
|
||||||
|
|
||||||
Normal response codes: 200
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
@ -33,52 +24,57 @@ Request
|
|||||||
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instances-index-response.json
|
.. literalinclude:: samples/instance-list-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Show database instance details
|
List database instances(admin)
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}
|
.. rest_method:: GET /v1.0/{project_id}/mgmt/instances
|
||||||
|
|
||||||
Shows database instance details.
|
Admin only API. Get all the instances, supported filters: deleted,
|
||||||
|
include_clustered. Could show more information such as Cinder volume ID, Nova
|
||||||
Lists the status and details of the database instance.
|
server information, etc.
|
||||||
|
|
||||||
Lists the volume size in gigabytes (GB) and the approximate GB
|
|
||||||
used. After instance creation, the ``used`` value is greater than 0, which
|
|
||||||
is expected as databases may create some basic (non empty) files to
|
|
||||||
represent an empty schema. The response does not include the ``used``
|
|
||||||
attribute when the instance status is ``BUILD``, ``REBOOT``,
|
|
||||||
``RESIZE``, or ``ERROR``.
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
Response Example
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
|
----------------
|
||||||
instanceFault(500), notImplemented(501), serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-mgmt-list-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
List database instances(with details)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/instances/detail
|
||||||
|
|
||||||
|
Lists information for all database instances with more details, such as created
|
||||||
|
and updated time, service status updated time, the failure message, etc.
|
||||||
|
Supported filters: include_clustered
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-instance-status-detail-response.json
|
.. literalinclude:: samples/instance-list-detail-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -99,11 +95,6 @@ unless the ``access`` parameter is defined.
|
|||||||
|
|
||||||
Normal response codes: 200
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
@ -147,7 +138,7 @@ Request
|
|||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-create-instance-request.json
|
.. literalinclude:: samples/instance-create-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -209,120 +200,98 @@ Response Parameters
|
|||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-create-instance-response.json
|
.. literalinclude:: samples/instance-create-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Attach configuration group
|
Show database instance details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}
|
||||||
|
|
||||||
|
Shows database instance details.
|
||||||
|
|
||||||
|
Lists the volume size in gigabytes (GB) and the approximate GB
|
||||||
|
used. After instance creation, the ``used`` value is greater than 0, which
|
||||||
|
is expected as databases may create some basic (non empty) files to
|
||||||
|
represent an empty schema. The response does not include the ``used``
|
||||||
|
attribute when the instance status is ``BUILD``, ``REBOOT``,
|
||||||
|
``RESIZE``, or ``ERROR``.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Show database instance details(admin)
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/mgmt/instances/{instanceId}
|
||||||
|
|
||||||
|
Admin only API. Get an instance information, including Cinder volume, Nova
|
||||||
|
server, etc.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-mgmt-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Attach/Detach configuration group
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v1.0/{project_id}/instances/{instanceId}
|
.. rest_method:: PUT /v1.0/{project_id}/instances/{instanceId}
|
||||||
|
|
||||||
Attaches a configuration group to an instance.
|
Attach or detach a configuration group for an instance. When you pass in only
|
||||||
|
an instance ID and omit the configuration ID, this operation detaches any
|
||||||
|
configuration group that was attached to the instance.
|
||||||
|
|
||||||
Normal response codes: 202
|
Normal response codes: 202
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
- configuration: configuration
|
- configuration: configuration
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-attach-config-group-request.json
|
.. literalinclude:: samples/instance-put-attach-config-group-request.json
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Detach configuration group
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: PUT /v1.0/{project_id}/instances/{instanceId}
|
|
||||||
|
|
||||||
Detaches a configuration group from an instance.
|
|
||||||
|
|
||||||
When you pass in only an instance ID and omit the configuration ID,
|
|
||||||
this operation detaches any configuration group that was attached
|
|
||||||
to the instance.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- configuration: configuration
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-detach-config-group-request.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Detach replica
|
|
||||||
~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_method:: PATCH /v1.0/{project_id}/instances/{instanceId}
|
|
||||||
|
|
||||||
Detaches a replica from its replication source.
|
|
||||||
|
|
||||||
If you created an instance that is a replica of a source instance,
|
|
||||||
you can detach the replica from the source. This can be useful if
|
|
||||||
the source becomes unavailable. In this case, you can detach the
|
|
||||||
replica from the source, making the replica a standalone database
|
|
||||||
instance. You can then take the new standalone instance and create
|
|
||||||
a new replica of that instance.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- replica_of: replica_of
|
|
||||||
- slave_of: slave_of
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. literalinclude:: samples/db-detach-replica-request.json
|
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -337,34 +306,27 @@ Update the instance name.
|
|||||||
|
|
||||||
Normal response codes: 202
|
Normal response codes: 202
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
- instance: instance
|
- instance: instance
|
||||||
- name: instanceName
|
- name: instanceName
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
|
||||||
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-update-instance-name-request.json
|
.. literalinclude:: samples/instance-patch-update-name-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Upgrade datastore version
|
Upgrade datastore version for instance
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PATCH /v1.0/{project_id}/instances/{instanceId}
|
.. rest_method:: PATCH /v1.0/{project_id}/instances/{instanceId}
|
||||||
|
|
||||||
@ -376,27 +338,56 @@ and changes back to ``HEALTHY`` after upgrading finishes, otherwize changes to
|
|||||||
|
|
||||||
Normal response codes: 202
|
Normal response codes: 202
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
Request
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), badMediaType(415),
|
-------
|
||||||
unprocessableEntity(422), instanceFault(500), notImplemented(501),
|
|
||||||
serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
- instance: instance
|
||||||
|
- datastore_version: datastore_version
|
||||||
|
|
||||||
|
Request Example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-patch-upgrade-datastore-version-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Detach replica
|
||||||
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: PATCH /v1.0/{project_id}/instances/{instanceId}
|
||||||
|
|
||||||
|
Detaches a replica from its replication source.
|
||||||
|
|
||||||
|
If you created an instance that is a replica of a source instance,
|
||||||
|
you can detach the replica from the source later on. This can be useful if
|
||||||
|
the source becomes unavailable. In this case, you can detach the
|
||||||
|
replica from the source, making the replica a standalone database
|
||||||
|
instance. You can then take the new standalone instance and create
|
||||||
|
a new replica of that instance.
|
||||||
|
|
||||||
|
Normal response codes: 202
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instance: instance
|
|
||||||
- datastore_version: datastore_version
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
- instance: instance
|
||||||
|
- replica_of: replica_of
|
||||||
|
- slave_of: slave_of
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-upgrade-instance-datastore-version-request.json
|
.. literalinclude:: samples/instance-patch-detach-replica-request.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
@ -407,56 +398,68 @@ Delete database instance
|
|||||||
|
|
||||||
.. rest_method:: DELETE /v1.0/{project_id}/instances/{instanceId}
|
.. rest_method:: DELETE /v1.0/{project_id}/instances/{instanceId}
|
||||||
|
|
||||||
Deletes a database instance, including any associated data.
|
Deletes a database instance.
|
||||||
|
|
||||||
This operation does not delete any read slaves.
|
This operation does not delete any slaves.
|
||||||
|
|
||||||
You cannot complete this operation when the instance state is
|
|
||||||
either ``REBUILDING`` or ``BUILDING``.
|
|
||||||
|
|
||||||
Normal response codes: 202
|
Normal response codes: 202
|
||||||
|
|
||||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
||||||
itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
|
|
||||||
instanceFault(500), notImplemented(501), serviceUnavailable(503)
|
|
||||||
|
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
List configuration defaults
|
List backups of database instance
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/configuration
|
.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/backups
|
||||||
|
|
||||||
Lists the configuration defaults for an instance.
|
Get all the backups for an instance.
|
||||||
|
|
||||||
Normal response codes: 200
|
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
|
Request
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- instanceId: instanceId
|
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. literalinclude:: samples/db-list-cfg-defaults-response.json
|
.. literalinclude:: samples/instance-backup-list-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
List default configuration parameters of database instance
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/configuration
|
||||||
|
|
||||||
|
Get the default configuration parameters for an instance.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
- instanceId: instanceId
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/instance-configuration-list-response.json
|
||||||
:language: javascript
|
:language: javascript
|
||||||
@ -11,6 +11,12 @@ configId:
|
|||||||
in: path
|
in: path
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
data_store:
|
||||||
|
description: |
|
||||||
|
Name or ID of the data store.
|
||||||
|
in: path
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
databaseName:
|
databaseName:
|
||||||
description: |
|
description: |
|
||||||
The name for the database.
|
The name for the database.
|
||||||
@ -39,7 +45,7 @@ instanceId:
|
|||||||
description: |
|
description: |
|
||||||
The ID of the database instance.
|
The ID of the database instance.
|
||||||
in: path
|
in: path
|
||||||
required: false
|
required: true
|
||||||
type: string
|
type: string
|
||||||
parameter_name:
|
parameter_name:
|
||||||
description: |
|
description: |
|
||||||
@ -66,6 +72,12 @@ user_project:
|
|||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
version:
|
||||||
|
description: |
|
||||||
|
Name or ID of the datastore version.
|
||||||
|
in: path
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
# variables in body
|
# variables in body
|
||||||
access:
|
access:
|
||||||
description: |
|
description: |
|
||||||
@ -362,7 +374,7 @@ flavorId1:
|
|||||||
flavorRef:
|
flavorRef:
|
||||||
description: |
|
description: |
|
||||||
Reference (href), which is the actual URI to a
|
Reference (href), which is the actual URI to a
|
||||||
flavor as it appears in the list flavors response. Rather than
|
flavor as it appears in the list flavors response. Rather than
|
||||||
the flavor URI, you can also pass the flavor ID (integer) as the
|
the flavor URI, you can also pass the flavor ID (integer) as the
|
||||||
``flavorRef`` value. For example, ``1``.
|
``flavorRef`` value. For example, ``1``.
|
||||||
in: body
|
in: body
|
||||||
|
|||||||
@ -4,7 +4,34 @@
|
|||||||
Quotas
|
Quotas
|
||||||
======
|
======
|
||||||
|
|
||||||
Show and update quotas.
|
|
||||||
|
|
||||||
|
|
||||||
|
Show resources limit for current project
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_method:: GET /v1.0/{project_id}/limits
|
||||||
|
|
||||||
|
Get resources quota and rate limit for the current project.
|
||||||
|
|
||||||
|
Normal response codes: 200
|
||||||
|
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/limit-show-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Show resources quota for a specific project
|
Show resources quota for a specific project
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
@ -42,6 +69,8 @@ Response Example
|
|||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Update resources quota for a specific project
|
Update resources quota for a specific project
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|||||||
@ -3,13 +3,13 @@
|
|||||||
{
|
{
|
||||||
"character_set": "utf8",
|
"character_set": "utf8",
|
||||||
"collate": "utf8_general_ci",
|
"collate": "utf8_general_ci",
|
||||||
"name": "testingdb"
|
"name": "databaseA"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "anotherdb"
|
"name": "databaseB"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "oneMoreDB"
|
"name": "databaseC"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@ -1,5 +1,8 @@
|
|||||||
{
|
{
|
||||||
"databases": [
|
"databases": [
|
||||||
|
{
|
||||||
|
"name": "databaseB"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"name": "databaseC"
|
"name": "databaseC"
|
||||||
},
|
},
|
||||||
96
api-ref/source/samples/datastore-list-response.json
Normal file
96
api-ref/source/samples/datastore-list-response.json
Normal file
@ -0,0 +1,96 @@
|
|||||||
|
{
|
||||||
|
"datastores": [
|
||||||
|
{
|
||||||
|
"default_version": "9e46a201-e92e-4ae0-af89-4af12a21bb45",
|
||||||
|
"id": "75dc45e0-2c3c-47ee-a5b8-5213288e3fe2",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/75dc45e0-2c3c-47ee-a5b8-5213288e3fe2",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/75dc45e0-2c3c-47ee-a5b8-5213288e3fe2",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "mariadb",
|
||||||
|
"versions": [
|
||||||
|
{
|
||||||
|
"id": "9e46a201-e92e-4ae0-af89-4af12a21bb45",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/versions/9e46a201-e92e-4ae0-af89-4af12a21bb45",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/versions/9e46a201-e92e-4ae0-af89-4af12a21bb45",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "10.4"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"default_version": "b3d5c099-dbd5-4518-baa3-7c7c195671bf",
|
||||||
|
"id": "3bf89e46-c3ed-4db6-a423-6e6709ec21ef",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/3bf89e46-c3ed-4db6-a423-6e6709ec21ef",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/3bf89e46-c3ed-4db6-a423-6e6709ec21ef",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "mysql",
|
||||||
|
"versions": [
|
||||||
|
{
|
||||||
|
"id": "b3d5c099-dbd5-4518-baa3-7c7c195671bf",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/versions/b3d5c099-dbd5-4518-baa3-7c7c195671bf",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/versions/b3d5c099-dbd5-4518-baa3-7c7c195671bf",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "5.7"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "cc9ee471-e781-43bf-a796-423c5d549997",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/cc9ee471-e781-43bf-a796-423c5d549997",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/cc9ee471-e781-43bf-a796-423c5d549997",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "postgresql",
|
||||||
|
"versions": [
|
||||||
|
{
|
||||||
|
"id": "4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/versions/4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/versions/4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "12"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
32
api-ref/source/samples/datastore-show-response.json
Normal file
32
api-ref/source/samples/datastore-show-response.json
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
{
|
||||||
|
"datastore": {
|
||||||
|
"id": "cc9ee471-e781-43bf-a796-423c5d549997",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/cc9ee471-e781-43bf-a796-423c5d549997",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/cc9ee471-e781-43bf-a796-423c5d549997",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "postgresql",
|
||||||
|
"versions": [
|
||||||
|
{
|
||||||
|
"id": "4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/versions/4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/versions/4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "12"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
11
api-ref/source/samples/datastore-version-create-request.json
Normal file
11
api-ref/source/samples/datastore-version-create-request.json
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"version": {
|
||||||
|
"datastore_name": "mysql",
|
||||||
|
"datastore_manager": "mysql",
|
||||||
|
"name": "test",
|
||||||
|
"image": "58b83318-cb18-4189-8d89-a015dc3839dd",
|
||||||
|
"active": true,
|
||||||
|
"default": false,
|
||||||
|
"packages": []
|
||||||
|
}
|
||||||
|
}
|
||||||
19
api-ref/source/samples/datastore-version-list-response.json
Normal file
19
api-ref/source/samples/datastore-version-list-response.json
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"versions": [
|
||||||
|
{
|
||||||
|
"datastore": "cc9ee471-e781-43bf-a796-423c5d549997",
|
||||||
|
"id": "4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/versions/4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/versions/4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "12"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@ -0,0 +1,30 @@
|
|||||||
|
{
|
||||||
|
"versions": [
|
||||||
|
{
|
||||||
|
"active": true,
|
||||||
|
"datastore_id": "75dc45e0-2c3c-47ee-a5b8-5213288e3fe2",
|
||||||
|
"datastore_manager": "mariadb",
|
||||||
|
"datastore_name": "mariadb",
|
||||||
|
"default": false,
|
||||||
|
"id": "385fa391-f6f1-4444-9d80-7dc3b2188fa3",
|
||||||
|
"image": "42706631-3b76-4d1c-95c9-6a85e72eebda",
|
||||||
|
"name": "10.4-dev-train",
|
||||||
|
"packages": [
|
||||||
|
""
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"active": true,
|
||||||
|
"datastore_id": "cc9ee471-e781-43bf-a796-423c5d549997",
|
||||||
|
"datastore_manager": "postgresql",
|
||||||
|
"datastore_name": "postgresql",
|
||||||
|
"default": false,
|
||||||
|
"id": "4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"image": "2eb8005f-270c-492f-977e-3c041a622ef7",
|
||||||
|
"name": "12",
|
||||||
|
"packages": [
|
||||||
|
""
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"image": "42706631-3b76-4d1c-95c9-6a85e72eebda",
|
||||||
|
"active": true
|
||||||
|
}
|
||||||
@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"version": {
|
||||||
|
"active": true,
|
||||||
|
"datastore_id": "75dc45e0-2c3c-47ee-a5b8-5213288e3fe2",
|
||||||
|
"datastore_manager": "mariadb",
|
||||||
|
"datastore_name": "mariadb",
|
||||||
|
"default": false,
|
||||||
|
"id": "385fa391-f6f1-4444-9d80-7dc3b2188fa3",
|
||||||
|
"image": "42706631-3b76-4d1c-95c9-6a85e72eebda",
|
||||||
|
"name": "10.4-dev-train",
|
||||||
|
"packages": [
|
||||||
|
""
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"configuration-parameter": {
|
||||||
|
"name": "connect_timeout",
|
||||||
|
"data_type": "integer",
|
||||||
|
"min_size": 64,
|
||||||
|
"max_size": 65535,
|
||||||
|
"restart_required": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"configuration-parameters": [
|
||||||
|
{
|
||||||
|
"datastore_version_id": "4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"max": 65535,
|
||||||
|
"min": 64,
|
||||||
|
"name": "connect_timeout",
|
||||||
|
"restart_required": false,
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
{
|
||||||
|
"configuration-parameters": [
|
||||||
|
{
|
||||||
|
"datastore_version_id": "b3d5c099-dbd5-4518-baa3-7c7c195671bf",
|
||||||
|
"max": 1,
|
||||||
|
"min": 0,
|
||||||
|
"name": "autocommit",
|
||||||
|
"restart_required": false,
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"datastore_version_id": "b3d5c099-dbd5-4518-baa3-7c7c195671bf",
|
||||||
|
"max": 65535,
|
||||||
|
"min": 1,
|
||||||
|
"name": "auto_increment_increment",
|
||||||
|
"restart_required": false,
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"datastore_version_id": "b3d5c099-dbd5-4518-baa3-7c7c195671bf",
|
||||||
|
"max": 65535,
|
||||||
|
"min": 1,
|
||||||
|
"name": "auto_increment_offset",
|
||||||
|
"restart_required": false,
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"datastore_version_id": "b3d5c099-dbd5-4518-baa3-7c7c195671bf",
|
||||||
|
"max": 31536000,
|
||||||
|
"min": 1,
|
||||||
|
"name": "wait_timeout",
|
||||||
|
"restart_required": false,
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"datastore_version_id": "b3d5c099-dbd5-4518-baa3-7c7c195671bf",
|
||||||
|
"max": 31536000,
|
||||||
|
"min": 1,
|
||||||
|
"name": "wait_timeout",
|
||||||
|
"restart_required": false,
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"configuration-parameter": {
|
||||||
|
"name": "connect_timeout",
|
||||||
|
"data_type": "integer",
|
||||||
|
"min_size": 64,
|
||||||
|
"max_size": 65535,
|
||||||
|
"restart_required": 1
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"datastore_version_id": "4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"deleted": 0,
|
||||||
|
"deleted_at": null,
|
||||||
|
"max_size": 65535,
|
||||||
|
"min_size": 64,
|
||||||
|
"name": "connect_timeout",
|
||||||
|
"restart_required": true,
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
17
api-ref/source/samples/datastore-version-show-response.json
Normal file
17
api-ref/source/samples/datastore-version-show-response.json
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"version": {
|
||||||
|
"datastore": "cc9ee471-e781-43bf-a796-423c5d549997",
|
||||||
|
"id": "4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"links": [
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/datastores/versions/4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"rel": "self"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"href": "https://127.0.0.1:8779/datastores/versions/4eb0179d-fe11-4556-9422-5267d2fc7625",
|
||||||
|
"rel": "bookmark"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "12"
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,7 +0,0 @@
|
|||||||
PUT /v1.0/1234/instances/4c93c73b-d6d0-47d7-b8c6-b699d19d7de9 HTTP/1.1
|
|
||||||
User-Agent: python-example-client
|
|
||||||
Host: openstack.example.com
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 202 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 0
|
|
||||||
Date: Mon, 13 Jul 2015 19:53:04 GMT
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
POST /v1.0/1234/backups HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"backup": {
|
|
||||||
"description": "My Incremental Backup",
|
|
||||||
"incremental": 0,
|
|
||||||
"instance": "44b277eb-39be-4921-be31-3d61b43651d7",
|
|
||||||
"name": "Incremental Snapshot",
|
|
||||||
"parent_id": "a9832168-7541-4536-b8d9-a8a9b79cf1b4"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 202 Accepted
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 462
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
{
|
|
||||||
"backup": {
|
|
||||||
"created": "2014-10-30T12:30:00",
|
|
||||||
"datastore": {
|
|
||||||
"type": "mysql",
|
|
||||||
"version": "5.5",
|
|
||||||
"version_id": "b00000b0-00b0-0b00-00b0-000b000000bb"
|
|
||||||
},
|
|
||||||
"description": "My Incremental Backup",
|
|
||||||
"id": "2e351a71-dd28-4bcb-a7d6-d36a5b487173",
|
|
||||||
"instance_id": "44b277eb-39be-4921-be31-3d61b43651d7",
|
|
||||||
"locationRef": null,
|
|
||||||
"name": "Incremental Snapshot",
|
|
||||||
"parent_id": "a9832168-7541-4536-b8d9-a8a9b79cf1b4",
|
|
||||||
"size": null,
|
|
||||||
"status": "NEW",
|
|
||||||
"updated": "2014-10-30T12:30:00"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
POST /v1.0/1234/backups HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 202 Accepted
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 404
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
DELETE /v1.0/1234/backups/a9832168-7541-4536-b8d9-a8a9b79cf1b4 HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 202 Accepted
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 0
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
GET /v1.0/1234/backups/a9832168-7541-4536-b8d9-a8a9b79cf1b4 HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 439
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
GET /v1.0/1234/backups HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 929
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
POST /v1.0/1234/instances HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
{
|
|
||||||
"instance": {
|
|
||||||
"flavorRef": 1,
|
|
||||||
"name": "backup_instance",
|
|
||||||
"restorePoint": {
|
|
||||||
"backupRef": "a9832168-7541-4536-b8d9-a8a9b79cf1b4"
|
|
||||||
},
|
|
||||||
"volume": {
|
|
||||||
"size": 2
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 717
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,41 +0,0 @@
|
|||||||
{
|
|
||||||
"instance": {
|
|
||||||
"created": "2014-10-30T12:30:00",
|
|
||||||
"datastore": {
|
|
||||||
"type": "mysql",
|
|
||||||
"version": "5.5"
|
|
||||||
},
|
|
||||||
"flavor": {
|
|
||||||
"id": "1",
|
|
||||||
"links": [
|
|
||||||
{
|
|
||||||
"href": "https://troveapi.org/v1.0/1234/flavors/1",
|
|
||||||
"rel": "self"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"href": "https://troveapi.org/flavors/1",
|
|
||||||
"rel": "bookmark"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"hostname": "e09ad9a3f73309469cf1f43d11e79549caf9acf2.troveexampledb.com",
|
|
||||||
"id": "d5a9db64-7ef7-41c5-8e1e-4013166874bc",
|
|
||||||
"links": [
|
|
||||||
{
|
|
||||||
"href": "https://troveapi.org/v1.0/1234/instances/d5a9db64-7ef7-41c5-8e1e-4013166874bc",
|
|
||||||
"rel": "self"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"href": "https://troveapi.org/instances/d5a9db64-7ef7-41c5-8e1e-4013166874bc",
|
|
||||||
"rel": "bookmark"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"name": "backup_instance",
|
|
||||||
"region": "RegionOne",
|
|
||||||
"status": "BUILD",
|
|
||||||
"updated": "2014-10-30T12:30:00",
|
|
||||||
"volume": {
|
|
||||||
"size": 2
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/backups HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 929
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,38 +0,0 @@
|
|||||||
{
|
|
||||||
"backups": [
|
|
||||||
{
|
|
||||||
"created": "2014-10-30T12:30:00",
|
|
||||||
"datastore": {
|
|
||||||
"type": "mysql",
|
|
||||||
"version": "5.5",
|
|
||||||
"version_id": "b00000b0-00b0-0b00-00b0-000b000000bb"
|
|
||||||
},
|
|
||||||
"description": "My Backup",
|
|
||||||
"id": "a9832168-7541-4536-b8d9-a8a9b79cf1b4",
|
|
||||||
"instance_id": "44b277eb-39be-4921-be31-3d61b43651d7",
|
|
||||||
"locationRef": "http://localhost/path/to/backup",
|
|
||||||
"name": "snapshot",
|
|
||||||
"parent_id": null,
|
|
||||||
"size": 0.14,
|
|
||||||
"status": "COMPLETED",
|
|
||||||
"updated": "2014-10-30T12:30:00"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"created": "2014-10-30T12:30:00",
|
|
||||||
"datastore": {
|
|
||||||
"type": "mysql",
|
|
||||||
"version": "5.5",
|
|
||||||
"version_id": "b00000b0-00b0-0b00-00b0-000b000000bb"
|
|
||||||
},
|
|
||||||
"description": "My Incremental Backup",
|
|
||||||
"id": "2e351a71-dd28-4bcb-a7d6-d36a5b487173",
|
|
||||||
"instance_id": "44b277eb-39be-4921-be31-3d61b43651d7",
|
|
||||||
"locationRef": "http://localhost/path/to/backup",
|
|
||||||
"name": "Incremental Snapshot",
|
|
||||||
"parent_id": "a9832168-7541-4536-b8d9-a8a9b79cf1b4",
|
|
||||||
"size": 0.14,
|
|
||||||
"status": "COMPLETED",
|
|
||||||
"updated": "2014-10-30T12:30:00"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
PUT /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users/dbuser1 HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
{
|
|
||||||
"user": {
|
|
||||||
"name": "new_username",
|
|
||||||
"password": "new_password"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 202 Accepted
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 0
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
PUT /v1.0/1234/instances/692d8418-7a8f-47f1-8060-59846c6e024f/users HTTP/1.1
|
|
||||||
User-Agent: python-example-client
|
|
||||||
Host: ord.databases.api.rackspacecloud.com
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
{
|
|
||||||
"users": [
|
|
||||||
{
|
|
||||||
"name": "dbuser1",
|
|
||||||
"password": "newpassword"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "dbuser2",
|
|
||||||
"password": "anotherpassword"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
HTTP/1.1 202 Accepted
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 152
|
|
||||||
Date: Wed, 21 Mar 2012 17:46:46 GMT
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
GET /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/root HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 21
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
GET /v1.0/1234/configurations/5678 HTTP/1.1
|
|
||||||
User-Agent: python-example-client
|
|
||||||
Host: openstack.example.com
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 138
|
|
||||||
Date: Fri, 20 Nov 2015 19:53:04 GMT
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
GET /v1.0/1234/configurations/5678/instances HTTP/1.1
|
|
||||||
User-Agent: python-example-client
|
|
||||||
Host: openstack.example.com
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 138
|
|
||||||
Date: Fri, 20 Nov 2015 19:53:04 GMT
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
PUT /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7 HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
{
|
|
||||||
"instance": {
|
|
||||||
"configuration": "43a6ea86-e959-4735-9e46-a6a5d4a2d80f"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 202 Accepted
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 0
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
POST /v1.0/1234/configurations HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,14 +0,0 @@
|
|||||||
{
|
|
||||||
"configuration": {
|
|
||||||
"datastore": {
|
|
||||||
"type": "a00000a0-00a0-0a00-00a0-000a000000aa",
|
|
||||||
"version": "b00000b0-00b0-0b00-00b0-000b000000bb"
|
|
||||||
},
|
|
||||||
"description": "example description",
|
|
||||||
"name": "example-configuration-name",
|
|
||||||
"values": {
|
|
||||||
"collation_server": "latin1_swedish_ci",
|
|
||||||
"connect_timeout": 120
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 431
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
{
|
|
||||||
"configuration": {
|
|
||||||
"created": "2014-10-30T12:30:00",
|
|
||||||
"datastore_name": "mysql",
|
|
||||||
"datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb",
|
|
||||||
"datastore_version_name": "5.5",
|
|
||||||
"description": "example description",
|
|
||||||
"id": "43a6ea86-e959-4735-9e46-a6a5d4a2d80f",
|
|
||||||
"instance_count": 0,
|
|
||||||
"name": "example-configuration-name",
|
|
||||||
"updated": "2014-10-30T12:30:00",
|
|
||||||
"values": {
|
|
||||||
"collation_server": "latin1_swedish_ci",
|
|
||||||
"connect_timeout": 120
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
DELETE /v1.0/1234/configurations/43a6ea86-e959-4735-9e46-a6a5d4a2d80f HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 202 Accepted
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 0
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
PUT /v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7 HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
{
|
|
||||||
"instance": {
|
|
||||||
"configuration": ""
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 202 Accepted
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 0
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
GET /v1.0/1234/configurations/43a6ea86-e959-4735-9e46-a6a5d4a2d80f HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 431
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
{
|
|
||||||
"configuration": {
|
|
||||||
"created": "2014-10-30T12:30:00",
|
|
||||||
"datastore_name": "mysql",
|
|
||||||
"datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb",
|
|
||||||
"datastore_version_name": "5.5",
|
|
||||||
"description": "example description",
|
|
||||||
"id": "43a6ea86-e959-4735-9e46-a6a5d4a2d80f",
|
|
||||||
"instance_count": 0,
|
|
||||||
"name": "example-configuration-name",
|
|
||||||
"updated": "2014-10-30T12:30:00",
|
|
||||||
"values": {
|
|
||||||
"collation_server": "latin1_swedish_ci",
|
|
||||||
"connect_timeout": 120
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
PATCH /v1.0/1234/configurations/43a6ea86-e959-4735-9e46-a6a5d4a2d80f HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"configuration": {
|
|
||||||
"values": {
|
|
||||||
"connect_timeout": 300
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 0
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
GET /v1.0/1234/configurations/43a6ea86-e959-4735-9e46-a6a5d4a2d80f/instances HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 93
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"instances": [
|
|
||||||
{
|
|
||||||
"id": "44b277eb-39be-4921-be31-3d61b43651d7",
|
|
||||||
"name": "json_rack_instance"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
GET /v1.0/1234/configurations HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 336
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
@ -1,14 +0,0 @@
|
|||||||
{
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"created": "2014-10-30T12:30:00",
|
|
||||||
"datastore_name": "mysql",
|
|
||||||
"datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb",
|
|
||||||
"datastore_version_name": "5.5",
|
|
||||||
"description": "example description",
|
|
||||||
"id": "43a6ea86-e959-4735-9e46-a6a5d4a2d80f",
|
|
||||||
"name": "example-configuration-name",
|
|
||||||
"updated": "2014-10-30T12:30:00"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
GET /v1.0/1234/datastores/a00000a0-00a0-0a00-00a0-000a000000aa/versions/b00000b0-00b0-0b00-00b0-000b000000bb/parameters/collation_server HTTP/1.1
|
|
||||||
User-Agent: python-troveclient
|
|
||||||
Host: troveapi.org
|
|
||||||
X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7
|
|
||||||
Accept: application/json
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
Content-Length: 147
|
|
||||||
Date: Mon, 18 Mar 2013 19:09:17 GMT
|
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user