Browse CockroachDB backups
Select
SaaS
Customer Managed
This API is used to browse CockroachDB backups
- application/json
- application/xml
- multipart/form-data
Request Body
- opType integer
queries object[]
queryId stringpaths object[]
path stringadvOptions object
browseViewName string- timeRange object
entity object
subclientId integerapplicationId integerclientName stringbackupsetId integerinstanceId integerclientId integer
Request Body
- opType integer
queries object[]
queryId stringpaths object[]
path stringentity object
subclientId integerapplicationId integerclientName stringbackupsetId integerinstanceId integerclientId integer
Request Body
- object
Responses
- 200
- 400
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
browseResponses object[]
respType integerworkerId stringdoClientSideSortingAndPaging booleansession object
sessionId stringbrowseResult object
queryId stringdataResultSet object[]
displayName stringdisplayPath stringpath stringsize integermodificationTime integername stringflags object
isPseudo booleandirectory booleanisFake booleansnap booleanadvancedData object
backupJobId integerreferenceTime integeroffset integerarchiveGroupId integerobjectGuid stringbackupTime integerarchiveFileId integersubclient object
_type_ integerapplicationId integersourceCommServer object
_type_ integercommCellId integeradvConfig object
recallRequest booleanbrowseAdvancedConfigResp object
commcellNumber integerbrowseMetaData object
indexing object
folderSize integerdmStubData object
guid string
{
"browseResponses": [
{
"respType": 0,
"workerId": "string",
"doClientSideSortingAndPaging": true,
"session": {
"sessionId": "string"
},
"browseResult": {
"queryId": "string",
"dataResultSet": [
{
"displayName": "string",
"displayPath": "string",
"path": "string",
"size": 0,
"modificationTime": 0,
"name": "string",
"flags": {
"isPseudo": true,
"directory": true,
"isFake": true,
"snap": true
},
"advancedData": {
"backupJobId": 0,
"referenceTime": 0,
"offset": 0,
"archiveGroupId": 0,
"objectGuid": "string",
"backupTime": 0,
"archiveFileId": 0,
"subclient": {
"_type_": 0,
"applicationId": 0
},
"sourceCommServer": {
"_type_": 0,
"commCellId": 0
},
"advConfig": {
"recallRequest": true,
"browseAdvancedConfigResp": {
"commcellNumber": 0
}
},
"browseMetaData": {
"indexing": {
"folderSize": 0
},
"dmStubData": {
"guid": "string"
}
}
}
}
]
}
}
]
}
{
"browseResponses": [
{
"respType": 0,
"workerId": 81,
"doClientSideSortingAndPaging": false,
"session": {
"sessionId": "1693597957-81"
},
"browseResult": {
"queryId": "dataQuery",
"dataResultSet": [
{
"displayName": "defaultdb",
"displayPath": "/defaultdb",
"path": "/defaultdb",
"size": 0,
"modificationTime": 1692728146,
"name": "defaultdb",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": false,
"snap": false
},
"advancedData": {
"backupJobId": 8181,
"referenceTime": 1692728158,
"offset": 1,
"archiveGroupId": 4,
"objectGuid": "22679a50dec74a7ad19f7fff369369ea",
"backupTime": 1692728158,
"archiveFileId": 9038,
"subclient": {
"_type_": 7,
"applicationId": 327
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 265567866
}
},
"browseMetaData": {
"indexing": {
"folderSize": 0
},
"dmStubData": {
"guid": "dbd819c0b29ae1b36e4197dfce9ef3f9"
},
"cockroachDBMetadata": {
"type": 1
}
}
}
},
{
"displayName": "postgres",
"displayPath": "/postgres",
"path": "/postgres",
"size": 0,
"modificationTime": 1692728146,
"name": "postgres",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": false,
"snap": false
},
"advancedData": {
"backupJobId": 8181,
"referenceTime": 1692728158,
"offset": 2,
"archiveGroupId": 4,
"objectGuid": "6f5470ab12ac9e6e045f5dc686a01bd8",
"backupTime": 1692728158,
"archiveFileId": 9038,
"subclient": {
"_type_": 7,
"applicationId": 327
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 265567866
}
},
"browseMetaData": {
"indexing": {
"folderSize": 0
},
"dmStubData": {
"guid": "1f14edbc2ba2bc5040fa16ad704c4f55"
},
"cockroachDBMetadata": {
"type": 1
}
}
}
},
{
"displayName": "scale1",
"displayPath": "/scale1",
"path": "/scale1",
"size": 0,
"modificationTime": 1692728146,
"name": "scale1",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": false,
"snap": false
},
"advancedData": {
"backupJobId": 8181,
"referenceTime": 1692728158,
"offset": 3,
"archiveGroupId": 4,
"objectGuid": "61108c829c637357b8742d23d1f3aa0a",
"backupTime": 1692728158,
"archiveFileId": 9038,
"subclient": {
"_type_": 7,
"applicationId": 327
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 265567866
}
},
"browseMetaData": {
"indexing": {
"folderSize": 0
},
"dmStubData": {
"guid": "e0d3f9dec2c0901497222f862d41c069"
},
"cockroachDBMetadata": {
"type": 1
}
}
}
},
{
"displayName": "system",
"displayPath": "/system",
"path": "/system",
"size": 0,
"modificationTime": 1692728146,
"name": "system",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": false,
"snap": false
},
"advancedData": {
"backupJobId": 8181,
"referenceTime": 1692728158,
"offset": 24,
"archiveGroupId": 4,
"objectGuid": "0ea554b019cc5a3e6337c45b68b3a647",
"backupTime": 1692728158,
"archiveFileId": 9038,
"subclient": {
"_type_": 7,
"applicationId": 327
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 265567866
}
},
"browseMetaData": {
"indexing": {
"folderSize": 0
},
"dmStubData": {
"guid": "a1258b4855889ae8241560eb93f0a47c"
},
"cockroachDBMetadata": {
"type": 1
}
}
}
}
]
}
},
{
"respType": 5,
"workerId": 81,
"doClientSideSortingAndPaging": false,
"session": {
"sessionId": "1693597957-81"
}
}
]
}
Bad Request
- application/json
- application/xml
- Schema
- Example (from schema)
Schema
- object
{}
- 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": "string",
"errorCode": 0
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "string",
"errorCode": 0
}
Loading...