Browse Kudu backups

This API is used to browse Kudu backups

application/json

Request Body

• opType integer required

  OpType

• queries object[]

  queryId string

  Default value: dataQuery

• paths object[] required

  Subclient content

  path string
• timeRange object

  Browse time rane

  fromTime integer

  from time to perform browse

  toTime integer

  to time to perform browse

• entity object required

  subclientId integer

  Subclient Id

  applicationId integer

  Application Id

  clientName string

  Client Name

  backupsetId integer

  Backupset Id

  instanceId integer

  Instance Id

  clientId integer

  Client Id

Responses

• 200
• 400
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• 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

  directory 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

  indexing object

  folderSize integer

  dmStubData 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": "127",
      "doClientSideSortingAndPaging": false,
      "session": {
        "sessionId": "1693800718-127"
      },
      "browseResult": {
        "queryId": "dataQuery",
        "dataResultSet": [
          {
            "displayName": "table1",
            "displayPath": "/table1",
            "path": "/table1",
            "size": 0,
            "modificationTime": 1693798138,
            "name": "table1",
            "flags": {
              "isPseudo": false,
              "file": true,
              "isFake": false,
              "snap": false
            },
            "advancedData": {
              "backupJobId": 9037,
              "referenceTime": 1693798142,
              "offset": 9,
              "archiveGroupId": 10,
              "objectGuid": "cd4f9fed1aeb8ef22026ab11c5afc81d",
              "backupTime": 1693798142,
              "archiveFileId": 10507,
              "subclient": {
                "_type_": 7,
                "applicationId": 200
              },
              "sourceCommServer": {
                "_type_": 1,
                "commCellId": 2
              },
              "advConfig": {
                "recallRequest": false,
                "browseAdvancedConfigResp": {
                  "commcellNumber": 265567866
                }
              },
              "browseMetaData": {
                "indexing": {},
                "dmStubData": {
                  "guid": "0c8bbc93e384750a75421f94698d8fde"
                }
              }
            }
          },
          {
            "displayName": "table2",
            "displayPath": "/table2",
            "path": "/table2",
            "size": 0,
            "modificationTime": 1693798138,
            "name": "table2",
            "flags": {
              "isPseudo": false,
              "file": true,
              "isFake": false,
              "snap": false
            },
            "advancedData": {
              "backupJobId": 9037,
              "referenceTime": 1693798142,
              "offset": 10,
              "archiveGroupId": 10,
              "objectGuid": "591a41f1da1748dc823b608501e919cf",
              "backupTime": 1693798142,
              "archiveFileId": 10507,
              "subclient": {
                "_type_": 7,
                "applicationId": 200
              },
              "sourceCommServer": {
                "_type_": 1,
                "commCellId": 2
              },
              "advConfig": {
                "recallRequest": false,
                "browseAdvancedConfigResp": {
                  "commcellNumber": 265567866
                }
              },
              "browseMetaData": {
                "indexing": {},
                "dmStubData": {
                  "guid": "e1c861eb2d71b18d48d9c43722a58142"
                }
              }
            }
          }
        ]
      }
    },
    {
      "respType": 5,
      "workerId": "127",
      "doClientSideSortingAndPaging": false,
      "session": {
        "sessionId": "1693800718-127"
      }
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• object

{}

application/xml

• 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...