diff options
author | Fan Zhang <zh.f@outlook.com> | 2018-02-05 09:54:32 +0800 |
---|---|---|
committer | Fan Zhang <zh.f@outlook.com> | 2018-02-27 19:28:38 +0800 |
commit | 3301a2a7403b38480ec87132cfabfd7c60892223 (patch) | |
tree | 2b26e4b24e72d2cfe44f0fb37390c6dbd20652d4 /api-ref/source/backups.inc | |
parent | d6bd37f3f337b1756730c55164834a18c86e7018 (diff) | |
download | trove-3301a2a7403b38480ec87132cfabfd7c60892223.tar.gz |
[api-ref] Add sections for backups.
Change-Id: If3a929e9de31dd901c4838e85f91f76941f33d05
Closes-bug: #1663096
Signed-off-by: Fan Zhang <zh.f@outlook.com>
Diffstat (limited to 'api-ref/source/backups.inc')
-rw-r--r-- | api-ref/source/backups.inc | 254 |
1 files changed, 254 insertions, 0 deletions
diff --git a/api-ref/source/backups.inc b/api-ref/source/backups.inc new file mode 100644 index 00000000..9fb4f460 --- /dev/null +++ b/api-ref/source/backups.inc @@ -0,0 +1,254 @@ +.. -*- rst -*- + +======= +Backups +======= + +List, show details, create and delete backups. + + +List database backups +~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET /v1.0/{accountId}/backups + +List all database backups information for a tenant. + +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 + + - accountId: accountId + + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - backups: backup_list + - 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-list-response.json + :language: javascript + + + + +List database backups for an instance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/backups + +List all database backups for the specified instance. + +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 + + - instanceId: instanceId + - accountId: accountId + + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - backups: backup_list + - 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-backups-by-instance-response.json + :language: javascript + + + + +Show database backup details +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET /v1.0/{accountId}/backups/{backupId} + +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 +------- + +.. rest_parameters:: parameters.yaml + + - accountId: accountId + - backupId: backup_id + + +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-get-response.json + :language: javascript + + + + +Create database backup +~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: POST /v1.0/{accountId}/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 + - accountId: accountId + + +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 + + + + +Delete database backup +~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: DELETE /v1.0/{accountId}/backups/{backupId} + +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 + - accountId: accountId |