Run full backup of a CockroachDB instance
Select
SaaS
Customer Managed
This API is used to run a full backup of CockroachDB instance.
- application/json
Request Body
taskInfo object
task object
taskType integerassociations object[]
clientName stringinstanceName stringdisplayName stringbackupsetId integer_type_ stringcommCellName stringinstanceId integercsGUID stringsubclientGUID stringsubclientId integerclientId integerappName stringbackupsetName stringapplicationId integersubclientName stringentityInfo object
companyId integercompanyName stringsubTasks object[]
subTask object
subTaskType integeroperationType integeroptions object
backupOpts object
backupLevel stringdataOpt object
createNewIndex booleancommonOpts object
notifyUserOnJobCompletion boolean
Responses
- 200
- 400
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
- jobIds string[]
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 1328,
"jobIds": [
"8840"
]
}
Bad Request
- application/json
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "No instance is specified",
"errorCode": 4
}
Loading...