Browse the shards/replica set in the MongoDB cluster
This operation is used to browse the shards/replica set in the MongoDB cluster from the backup. We could browse at the cluster level or at the database/collection level by setting the browseViewName in the request.
- application/json
Request Body
- opType integer
options object
showDeletedFiles booleanDefault value:
false
hideUserHidden booleanDefault value:
true
timeRange object
fromTime integerBrowse start time
toTime integerbrowse end time
queries object[]
type integerqueryId stringfileOrFolder integerDefault value:
1
dataParam object
sortParam object
ascending booleansortBy integer[]aggrParam object
field integeraggrType integerDefault value:
4
advOptions object
browseViewName stringPossible values: [
DBView
,SHARDView
]SHARDView for cluster level b and DBView for database/collection level browse
paths object[]
path stringDefault value:
/
entity object
subclientId integersubclient Id
displayName stringMongoDB client instance display name
clientId integerMongoDB instance client Id
instanceName stringappName stringDefault value:
Big Data Apps
applicationId integerDefault value:
64
clientName stringMongoDB instance client name
backupsetId integerinstanceId integerMongoDB instance Id
Responses
- 200
- 400
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringbrowseResponses object[]
respType integerworkerId stringdoClientSideSortingAndPaging booleansession object
sessionId stringbrowseResult object
queryId stringdataResultSet object[]
displayName stringdisplayPath stringpath stringsize integermodificationTime integername stringflags object
isPseudo booleanfile 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
mongoDBShardInfo object
physicalSize integeroplogLastEntryTimestamp integeroplogDumpStagingLocation stringaFileNumber integersecondaryDataPathDir stringshardName stringprimaryPort integeroplogSyncTime integersecondaryMongoHost stringprimaryMongoHost stringprimaryDataPathDir stringsecondaryPort integermountPathsPerShard stringisConfigServer booleansecondaryClientId integerindexing object
dmStubData object
guid stringaggrResultSet object[]
result integergroupbyValue stringcount integer
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "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,
"file": 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": {
"mongoDBShardInfo": {
"physicalSize": 0,
"oplogLastEntryTimestamp": 0,
"oplogDumpStagingLocation": "string",
"aFileNumber": 0,
"secondaryDataPathDir": "string",
"shardName": "string",
"primaryPort": 0,
"oplogSyncTime": 0,
"secondaryMongoHost": "string",
"primaryMongoHost": "string",
"primaryDataPathDir": "string",
"secondaryPort": 0,
"mountPathsPerShard": "string",
"isConfigServer": true,
"secondaryClientId": 0
},
"indexing": {},
"dmStubData": {
"guid": "string"
}
}
}
}
],
"aggrResultSet": [
{
"result": 0,
"groupbyValue": "string",
"count": 0
}
]
}
}
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "WebServer",
"value": "OBLIVION"
}
]
},
"browseResponses": [
{
"respType": 0,
"workerId": "93",
"doClientSideSortingAndPaging": false,
"session": {
"sessionId": "1692802306-93"
},
"browseResult": {
"queryId": "0",
"dataResultSet": [
{
"displayName": "mongo5",
"displayPath": "/mongo5",
"path": "/mongo5",
"size": 14073856,
"modificationTime": 1692791236,
"name": "mongo5",
"flags": {
"isPseudo": false,
"file": true,
"isFake": false,
"snap": false
},
"advancedData": {
"backupJobId": 34350,
"referenceTime": 1692791276,
"offset": 1,
"archiveGroupId": 19,
"objectGuid": "84079a12359b9e6ce27cc7e7f35a262d",
"backupTime": 1692791276,
"archiveFileId": 173332,
"subclient": {
"_type_": 7,
"applicationId": 1342
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 3487453
}
},
"browseMetaData": {
"mongoDBShardInfo": {
"physicalSize": 14073856,
"oplogLastEntryTimestamp": 1692791212,
"oplogDumpStagingLocation": "/opt/commvault/iDataAgent/jobResults/2/1342",
"aFileNumber": 173330,
"secondaryDataPathDir": "/mongo5/data",
"shardName": "mongo5",
"primaryPort": 27777,
"oplogSyncTime": 0,
"secondaryMongoHost": "xxx.xxx.xxx",
"primaryMongoHost": "xxx.xxx.xxx",
"primaryDataPathDir": "/mongo5/data",
"secondaryPort": 27777,
"mountPathsPerShard": "mongo5#/mongo5/data||173330",
"isConfigServer": false,
"secondaryClientId": 712
},
"indexing": {},
"dmStubData": {
"guid": "1f625a2ac1450bcaec48632d5ab488fb"
}
}
}
}
]
}
},
{
"respType": 0,
"workerId": "93",
"doClientSideSortingAndPaging": false,
"session": {
"sessionId": "1692802306-93"
},
"browseResult": {
"queryId": "1",
"aggrResultSet": [
{
"result": 1,
"groupbyValue": "",
"count": 1
}
]
}
},
{
"respType": 5,
"workerId": "93",
"doClientSideSortingAndPaging": false,
"session": {
"sessionId": "1692802306-93"
}
}
]
}
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": "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...