Help Center/ KooDrive/ API Reference（Carrier）/ API/ Backup Record/ Viewing Backup Records
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Viewing Backup Records

Function

Viewing backup records.

URI

GET /koodrive/ose/v1/backup/record/{recordId}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

recordId

Yes

String

Definition:

Backup record ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

This field stores the access token.

Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission.

Constraints:

The format is bearer+access token.

Range:

For details about how to obtain an access token, see the corresponding developer guide.

Default Value:

N/A

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app ID authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Signature time, which is used for app ID authentication.

Constraints:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

Default Value:

N/A

Definition:

Signature time, which is used for app ID authentication.

Constraints:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

Integer

Status code.

msg

String

Status description.

data

BackupRecord object

Backup record.
Table 4 BackupRecord

Parameter

Type

Description

recordId

String

Record ID.

moduleCode

String

Module code.

status

Integer

Status Value:

  • 0: new.

  • 1: completed.

  • 2: to be deleted.

properties

String

Custom property.

version

Integer

Version.

createTime

String

Creation time.

endTime

String

End time.

deviceInfo

DeviceEntity object

Device information.
Table 5 DeviceEntity

Parameter

Type

Description

deviceId

String

Device ID.

machineCode

String

Machine code.

deviceName

String

Device name.

deviceOS

String

Device system.

createTime

String

Creation time.

Example Requests

Request example for viewing backup records.

/koodrive/ose/v1/backup/record/1842862763295184641

Authorization:Bearer+60f4ccc7b1********3dd9a68068
x-backup-lock-id: 78e41c7e-db02-4d55-85b3-8153e4fefd2e@102

Example Responses

Status code: 200

Response body for viewing backup records.

{
  "data" : {
    "recordId" : "1842862763295184641",
    "moduleCode" : "101",
    "status" : 0,
    "properties" : "{\"test\":\"123\"}",
    "version" : 1,
    "createTime" : "2025-12-17T07:59:20.752Z"
  },
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Response body for viewing backup records.
Parent topic: Backup Record