Updated on 2025-07-29 GMT+08:00

Querying Incremental Backups

Function

This API is used to query incremental backups. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/incremental-backups

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

String

Definition

Index offset. The query starts from the next piece of data indexed by this parameter.

Constraints

The value must be an integer and cannot be a negative number.

Range

≥ 0

Default Value

0

limit

No

String

Definition

Number of records to be queried.

Constraints

The value must be an integer and cannot be a negative number.

Range

10, 20, and 50

Default Value

10

begin_time

No

String

Definition

Query start time.

Constraints

When begin_time is not empty, end_time is mandatory.

Range

The value is in the "yyyy-mm-ddThh:mm:ssZ" format.

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

Default Value

N/A

end_time

No

String

Definition

Query end time.

Constraints

When end_time is not empty, begin_time is mandatory.

Range

The value is in the "yyyy-mm-ddThh:mm:ssZ" format and must be later than the query start time.

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

backups

Array of IncrementalBackups objects

Definition

Backup information.

total_count

Long

Definition

Total number of backup files.

Range

N/A

Table 5 IncrementalBackups

Parameter

Type

Description

id

String

Definition

Backup ID.

Range

The value contains 36 characters with a suffix of br07. Only letters and digits are allowed.

name

String

Definition

Backup name.

Range

The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

begin_time

String

Definition

Backup start time.

Range

The value is in the "yyyy-mm-ddThh:mm:ssZ" format.

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

end_time

String

Definition

Backup end time.

Range

The value is in the "yyyy-mm-ddThh:mm:ssZ" format.

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

size

Number

Definition

Backup size, in KB.

Range

N/A

instance_id

String

Definition

Instance ID.

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying incremental backups generated from July 6, 2022 to July 16, 2022

GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/incremental-backups?offset=0&limit=10&begin_time=2022-07-06T10:41:14+0800&end_time=2022-07-16T10:41:14+0800

Example Response

Status code: 200

Success.

{
  "backups" : [ {
    "id" : "f0d2aea28d26t4848b8c84ed3fea1822fbr07",
    "name" : "TaurusDB--20230728181555006",
    "begin_time" : "2022-07-07T12:41:14+0800",
    "end_time" : "2022-07-08T12:45:14+0800",
    "size" : 0.109375,
    "instance_id" : "61a4ea66210545909d74a05c27a7179ein07"
  } ],
  "total_count" : 1
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.