Skip to main content

Browse the shards/replica set in the MongoDB cluster​

Select

SaaS
Customer Managed

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.

Request Body
  • opType integer
  • options object
  • showDeletedFiles boolean

    Default value: false

  • hideUserHidden boolean

    Default value: true

  • timeRange object
  • fromTime integer

    Browse start time

  • toTime integer

    browse end time

  • queries object[]
  • type integer
  • queryId string
  • fileOrFolder integer

    Default value: 1

  • dataParam object
  • sortParam object
  • ascending boolean
  • sortBy integer[]
  • aggrParam object
  • field integer
  • aggrType integer

    Default value: 4

  • advOptions object
  • browseViewName string

    Possible values: [DBView, SHARDView]

    SHARDView for cluster level b and DBView for database/collection level browse

  • paths object[]
  • path string

    Default value: /

  • entity object
  • subclientId integer

    subclient Id

  • displayName string

    MongoDB client instance display name

  • clientId integer

    MongoDB instance client Id

  • instanceName string
  • appName string

    Default value: Big Data Apps

  • applicationId integer

    Default value: 64

  • clientName string

    MongoDB instance client name

  • backupsetId integer
  • instanceId integer

    MongoDB instance Id

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • browseResponses object[]
  • respType integer
  • workerId string
  • doClientSideSortingAndPaging boolean
  • session object
  • sessionId string
  • browseResult object
  • queryId string
  • dataResultSet object[]
  • displayName string
  • displayPath string
  • path string
  • size integer
  • modificationTime integer
  • name string
  • flags object
  • isPseudo boolean
  • file boolean
  • isFake boolean
  • snap boolean
  • advancedData object
  • backupJobId integer
  • referenceTime integer
  • offset integer
  • archiveGroupId integer
  • objectGuid string
  • backupTime integer
  • archiveFileId integer
  • subclient object
  • _type_ integer
  • applicationId integer
  • sourceCommServer object
  • _type_ integer
  • commCellId integer
  • advConfig object
  • recallRequest boolean
  • browseAdvancedConfigResp object
  • commcellNumber integer
  • browseMetaData object
  • mongoDBShardInfo object
  • physicalSize integer
  • oplogLastEntryTimestamp integer
  • oplogDumpStagingLocation string
  • aFileNumber integer
  • secondaryDataPathDir string
  • shardName string
  • primaryPort integer
  • oplogSyncTime integer
  • secondaryMongoHost string
  • primaryMongoHost string
  • primaryDataPathDir string
  • secondaryPort integer
  • mountPathsPerShard string
  • isConfigServer boolean
  • secondaryClientId integer
  • indexing object
  • dmStubData object
  • guid string
  • aggrResultSet object[]
  • result integer
  • groupbyValue string
  • count integer
POST /dobrowse

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "opType": 0,

  "options": {

    "showDeletedFiles": false,

    "hideUserHidden": true

  },

  "timeRange": {

    "fromTime": 0,

    "toTime": 0

  },

  "queries": [

    {

      "type": 0,

      "queryId": "string",

      "fileOrFolder": 1,

      "dataParam": {

        "sortParam": {

          "ascending": true,

          "sortBy": [

            0

          ]

        }

      },

      "aggrParam": {

        "field": 0,

        "aggrType": 4

      }

    }

  ],

  "advOptions": {

    "browseViewName": "DBView"

  },

  "paths": [

    {

      "path": "/"

    }

  ],

  "entity": {

    "subclientId": 0,

    "displayName": "string",

    "clientId": 0,

    "instanceName": "string",

    "appName": "Big Data Apps",

    "applicationId": 64,

    "clientName": "string",

    "backupsetId": 0,

    "instanceId": 0

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/DoBrowse' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "opType": 0,
  "options": {
    "showDeletedFiles": false,
    "hideUserHidden": true
  },
  "timeRange": {
    "fromTime": 0,
    "toTime": 0
  },
  "queries": [
    {
      "type": 0,
      "queryId": "string",
      "fileOrFolder": 1,
      "dataParam": {
        "sortParam": {
          "ascending": true,
          "sortBy": [
            0
          ]
        }
      },
      "aggrParam": {
        "field": 0,
        "aggrType": 4
      }
    }
  ],
  "advOptions": {
    "browseViewName": "DBView"
  },
  "paths": [
    {
      "path": "/"
    }
  ],
  "entity": {
    "subclientId": 0,
    "displayName": "string",
    "clientId": 0,
    "instanceName": "string",
    "appName": "Big Data Apps",
    "applicationId": 64,
    "clientName": "string",
    "backupsetId": 0,
    "instanceId": 0
  }
}'