summaryrefslogtreecommitdiff
path: root/api-ref/source/backups.inc
diff options
context:
space:
mode:
Diffstat (limited to 'api-ref/source/backups.inc')
-rw-r--r--api-ref/source/backups.inc125
1 files changed, 27 insertions, 98 deletions
diff --git a/api-ref/source/backups.inc b/api-ref/source/backups.inc
index d842619a..9fd8d331 100644
--- a/api-ref/source/backups.inc
+++ b/api-ref/source/backups.inc
@@ -4,7 +4,7 @@
Backups
=======
-List, show details, create and delete 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
database instance.
-- ``all_projects`` - Return the list of backups for all the projects, this is
- admin only param by default.
+- ``all_projects=True/False`` - Return the list of backups for all the
+ projects, this is an admin only param by default.
+- ``datastore={datastore}`` - Return a list of backups of the same datastore.
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
-------
@@ -60,34 +56,42 @@ Response Parameters
Response Example
----------------
-.. literalinclude:: samples/db-backup-list-response.json
+.. literalinclude:: samples/backup-list-response.json
:language: javascript
-List database backups for an instance
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. rest_method:: GET /v1.0/{project_id}/instances/{instanceId}/backups
+Create database backup
+~~~~~~~~~~~~~~~~~~~~~~
-List all database backups for the specified instance. This is equivalent to
-``GET /v1.0/{project_id}/backups?instance_id={instanceId}``.
+.. rest_method:: POST /v1.0/{project_id}/backups
-Normal response codes: 200
+Creates a database backup for instance.
-Error response codes: badRequest(400), unauthorized(401), forbidden(403),
-itemNotFound(404), badMethod(405), overLimit(413), unprocessableEntity(422),
-instanceFault(500), notImplemented(501), serviceUnavailable(503)
+In the Trove deployment with service tenant enabled, The backup data is
+stored as objects in OpenStack Swift service in the user's
+container(``database_backups`` by default)
+Normal response codes: 202
Request
-------
.. rest_parameters:: parameters.yaml
- - instanceId: instanceId
- 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
@@ -95,7 +99,6 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- - backups: backup_list
- created: created
- datastore: datastore2
- datastore.type: datastore_type1
@@ -115,7 +118,7 @@ Response Parameters
Response Example
----------------
-.. literalinclude:: samples/db-backups-by-instance-response.json
+.. literalinclude:: samples/backup-create-response.json
:language: javascript
@@ -130,11 +133,6 @@ Show detailes of a backup.
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
-------
@@ -168,71 +166,7 @@ Response Parameters
Response Example
----------------
-.. literalinclude:: samples/db-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
+.. literalinclude:: samples/backup-get-response.json
:language: javascript
@@ -247,15 +181,10 @@ Deletes a database backup.
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
- - backupId: backup_id
- project_id: project_id
+ - backupId: backup_id \ No newline at end of file