API Explorer

Name	Type	IN	Mandatory	Description
x-auth-token	string	header	Yes	Specifies the user token obtained from the IAM service.
project_id	string	path	Yes	Specifies the project ID of a tenant in a region.
mode	string	query	No	Specifies the DB instance mode. Valid value: Sharding ReplicaSet Single
end_time	string	query	No	Specifies the end time of the query. The format is "yyyy-mm-dd hh:mm:ss". The value is in UTC format. When begin_time is not empty, end_time is mandatory.
begin_time	string	query	No	Specifies the start time of the query. The format is yyyy-mm-dd hh:mm:ss. The value is in UTC format. When end_time is not empty, begin_time is mandatory.
limit	integer	query	No	Specifies the maximum allowed number of backups to be queried. The value ranges from 1 to 100. If this parameter is not transferred, the first 100 DB instances are queried by default.
offset	integer	query	No	Specifies the index position. The query starts from the next instance creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data. The value must be greater than or equal to 0. If this parameter is not transferred, offset is set to 0 by default, indicating that the query starts from the latest created DB instance.
backup_type	string	query	No	Specifies the backup type. Auto: indicates automated full backup. Manual: indicates manual full backup. Incremental: indicates automated incremental backup. If this parameter is not transferred, all full backups, including automated and manual full backups, are queried by default. When the value of this field is Incremental, the instance ID must be transferred.
backup_id	string	query	No	Specifies the backup ID. If the backup ID belongs to an automated incremental backup, the instance ID must be specified.
instance_id	string	query	No	Specifies the instance ID, which can be obtained by calling the API for querying instances and details. If you do not have an instance, you can call the API used for creating an instance.

Name	Type	Description
backups	Array of BackupForList objects	Indicates the backup list.
total_count	integer	Indicates the total number of queried records.

Name

Type

Description

backups

Array of BackupForList objects

Indicates the backup list.

total_count

integer

Indicates the total number of queried records.

Name	Type	Description
id	string	Indicates the backup ID.
name	string	Indicates the backup name.
instance_id	string	Indicates the ID of the DB instance from which the backup was created. You can obtain the ID by calling the API for querying DB instances. If you do not have an instance, you can call the API used for creating an instance.
instance_name	string	Indicates the name of the DB instance for which the backup is created.
datastore	BackupDatabase object	Indicates the database version.
type	string	Indicates the backup type. Auto: indicates automated full backup. Manual indicates manual full backup. Incremental: indicates automated incremental backup.
begin_time	string	Indicates the backup start time. The format of the start time is yyyy-mm-dd hh:mm:ss. The value is in UTC format.
end_time	string	Indicates the backup end time. The format of the end time is yyyy-mm-dd hh:mm:ss. The value is in UTC format.
status	string	Indicates the backup status. Valid value: BUILDING: Backup in progress COMPLETED: Backup completed FAILED: Backup failed DISABLED: Backup being deleted
size	long	Indicates the backup size in KB.
description	string	Indicates the backup description.

Name

Type

Description

string

Indicates the backup ID.

name

string

Indicates the backup name.

instance_id

string

Indicates the ID of the DB instance from which the backup was created. You can obtain the ID by calling the API for querying DB instances. If you do not have an instance, you can call the API used for creating an instance.

instance_name

string

Indicates the name of the DB instance for which the backup is created.

datastore

BackupDatabase object

Indicates the database version.

type

string

Indicates the backup type.

Auto: indicates automated full backup.
Manual indicates manual full backup.
Incremental: indicates automated incremental backup.

begin_time

string

Indicates the backup start time. The format of the start time is yyyy-mm-dd hh:mm:ss. The value is in UTC format.

end_time

string

Indicates the backup end time. The format of the end time is yyyy-mm-dd hh:mm:ss. The value is in UTC format.

status

string

Indicates the backup status. Valid value:

BUILDING: Backup in progress
COMPLETED: Backup completed
FAILED: Backup failed
DISABLED: Backup being deleted

size

long

Indicates the backup size in KB.

description

string

Indicates the backup description.

Name	Type	Description
type	string	Indicates the DB engine. Valid value: DDS-Community or DDS-Enhanced.
version	string	Indicates the database of version 3.4 or later. The value is 3.4, 4.0, 4.2, 4.4 or 5.0.

Name

Type

Description

type

string

Indicates the DB engine. Valid value: DDS-Community or DDS-Enhanced.

version

string

Indicates the database of version 3.4 or later. The value is 3.4, 4.0, 4.2, 4.4 or 5.0.

Name	Type	Description
error_code	string	Specifies the error returned when a task submission exception occurs.
error_msg	string	Specifies the description of the error returned when a task submission exception occurs.

Name

Type

Description

error_code

string

Specifies the error returned when a task submission exception occurs.

error_msg

string

Specifies the description of the error returned when a task submission exception occurs.

{ "backups": [ { "id ": "43e4feaab48f11e89039fa163ebaa7e4br02", "name": "backup-test", "instance_id": "43e4feaab48f11e89039fa163ebaa7e4in02", "instance_name": "cluster-test", "datastore": { "type": "DDS-Community", "version": 3.2 }, "type": "auto", "begin_time": "2018-08-06 12:41:14", "end_time": "2018-08-06 12:43:14", "status": "COMPLETED", "size": 2803, "description": "backup description" } ], "total_count": 1 }

Outline