diff options
| author | Lingxian Kong <anlin.kong@gmail.com> | 2019-08-26 15:45:28 +1200 |
|---|---|---|
| committer | Lingxian Kong <anlin.kong@gmail.com> | 2019-08-26 15:45:30 +1200 |
| commit | f32c6f81ec92db6dda4a08a28cb3ac4682653ace (patch) | |
| tree | c9abb7b40efc9eb1c04c29bc6b3fd03b11344584 /api-ref | |
| parent | 77dab835e6a1bcfc9ca104d72015c69cc17318f6 (diff) | |
| download | trove-f32c6f81ec92db6dda4a08a28cb3ac4682653ace.tar.gz | |
Filtering description for backup API
Story: #2006433
Task: #36344
Change-Id: I044b804e2ebdc6ecf545cb802114c5b774bb0645
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/backups.inc | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/api-ref/source/backups.inc b/api-ref/source/backups.inc index 9fb4f460..4b35ea05 100644 --- a/api-ref/source/backups.inc +++ b/api-ref/source/backups.inc @@ -12,7 +12,13 @@ List database backups .. rest_method:: GET /v1.0/{accountId}/backups -List all database backups information for a tenant. +List all database backups information for a project. You can filter results by +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. Normal response codes: 200 @@ -65,7 +71,8 @@ List database backups for an instance .. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/backups -List all database backups for the specified instance. +List all database backups for the specified instance. This is equivalent to +``GET /v1.0/{accountId}/backups?instance_id={instanceId}``. Normal response codes: 200 |