Backups
All requests go to the gateway.
Authentication is not yet
documented. Placeholder values in angle brackets (<...>) are yours to fill in.
To restore an instance, use Restore Instance.
List Backup History
Query · db_listUserDbBackupHistoryByDb
Lists the backup history of a database instance, page by page.
Arguments
| Name | Type | Required |
|---|---|---|
pager | db_PagerInput | No |
filter | db_DbBackupHistoryFilterInput | Yes |
filter
| Field | Type | Required |
|---|---|---|
dbId | ID | Yes |
subscriptionId | ID | Yes |
status | db_DbBackupHistoryStatus | No |
Variables
{
"pager": { "page": 1, "limit": 20 },
"filter": {
"dbId": "<instance id>",
"subscriptionId": "<subscription id>"
}
}
Request
query ListDbBackupHistory(
$pager: db_PagerInput
$filter: db_DbBackupHistoryFilterInput!
) {
db_listUserDbBackupHistoryByDb(pager: $pager, filter: $filter) {
dbBackupHistories {
id
fileName
fileSize
fileSizeUnit
status
createdAt
}
pagination {
currentPage
lastPage
total
}
}
}
Response
db_ListDbBackupHistoryResponse!
| Field | Type |
|---|---|
dbBackupHistories | [db_DbBackupHistoryResponse!]! |
pagination | db_Pagination, nullable |
db_DbBackupHistoryResponse
| Field | Type |
|---|---|
id | ID! |
dbId | ID! |
subscriptionId | ID! |
mysabayUserId | Int! |
fileName | String! |
fileSize | Float! |
fileSizeUnit | db_FileSizeUnit! |
status | db_DbBackupHistoryStatus! |
createdAt | Float! |
updatedAt | Float! |
List Backup Log
Query · db_listUserDbBackupLogByDb
Lists the log entries for one backup of a database instance, page by page. Each entry records a backup, restore, expire or delete action.
Arguments
| Name | Type | Required |
|---|---|---|
pager | db_PagerInput | No |
filter | db_DbBackupLogFilterInput | Yes |
filter
| Field | Type | Required |
|---|---|---|
dbId | ID | Yes |
subscriptionId | ID | Yes |
dbBackupHistoryId | ID | Yes |
dbBackupHistoryId is the id of an entry from
List Backup History.
Variables
{
"pager": { "page": 1, "limit": 20 },
"filter": {
"dbId": "<instance id>",
"subscriptionId": "<subscription id>",
"dbBackupHistoryId": "<backup history id>"
}
}
Request
query ListDbBackupLog(
$pager: db_PagerInput
$filter: db_DbBackupLogFilterInput!
) {
db_listUserDbBackupLogByDb(pager: $pager, filter: $filter) {
dbBackupLogs {
id
actionType
status
errorMessage
initializedAt
finishedAt
}
pagination {
currentPage
lastPage
total
}
}
}
Response
db_ListDbBackupLogResponse!
| Field | Type |
|---|---|
dbBackupLogs | [db_DbBackupLogResponse!]! |
pagination | db_Pagination, nullable |
db_DbBackupLogResponse
| Field | Type |
|---|---|
id | ID! |
dbId | ID! |
subscriptionId | ID! |
dbBackupHistoryId | ID! |
mysabayUserId | Int! |
actionType | db_DbBackupLogActionType! |
status | db_DbBackupLogStatus! |
errorMessage | String |
initializedAt | Float! |
finishedAt | Float! |
createdAt | Float! |
updatedAt | Float! |