List DB snapshots (GET /v1.0/{tenantId}/snapshots)
Lists information for all DB snapshots.
Request URI
{tenantID}
Project ID of the owner of the instance
Data Type | Cardinality |
---|---|
String | 1..1 |
Request Parameters
limit
Number of elements to display
20 to 100
Default:20
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Integer | 0..1 | None | None |
marker
A pagination token used to establish the starting point for retrieving the list.
Specify the ID or name of the last element returned in the previous list.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | None | None |
snapshotType
Specifies the DB snapshot type
automated | manual
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | None | None |
Response Headers
Status
Returns the status of the request.
One of the following values will be returned.
- 401:
- unauthorized
- 403:
- forbidden
- 500:
- instanceFault
- 501:
- notImplemented
- 503:
- serviceUnavailable
- 504:
- gatewayTimeout
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response Elements
name
Name of the DB snapshot
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String |
id
ID of the DB snapshot
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String |
instanceId
ID of the virtual database server that is the source of this snapshot
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String |
snapshotType
Type of snapshot
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String |
Example of Response
{
"snapshots": [
"snapshot":{
"name" : "snapshot1",
"id" : "snapshot_dfrtgy3h2uj5ik",
"instanceId" : "instance_r67fg9uj0kfp",
"snapshotType":"automated"
},
"snapshot":{
"name" : "snapshot2",
"id" : "snapshot_dftgyfewaj5ik",
"instanceId" : "instance_r67rftyufrp",
"snapshotType":"automated"
}
}