Updated on 2024-09-11 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

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

String

Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.

limit

No

String

Number of records to be queried. Value: 10 (default value), 20, or 50.

begin_time

No

String

Query start time. The format is "yyyy-mm-ddThh:mm:ssZ".

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.

When begin_time is not empty, end_time is mandatory.

end_time

No

String

Query end time. The format is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the 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.

When end_time is not empty, begin_time is mandatory.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

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

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

backups

Array of IncrementalBackups objects

Backup information.

total_count

Long

Total number of backup files.

Table 5 IncrementalBackups

Parameter

Type

Description

id

String

Backup ID.

name

String

Backup name.

begin_time

String

Backup start time 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

Backup end time 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

Backup size, in KB.

instance_id

String

Instance ID.

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" : "GaussDBforMySQL--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.