API Introduction
Call the describeBackups API to query the instance backup list.
API Restrictions
None
URI
GET /v1/openApi/describeBackups
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | Optional | String | External instance ID of the document database | a649077e15f349cb8b4cde6f7285a568 |
prodInstFlag | Optional | String | The label of the database is specified as "instance ID instance name" | a649077e15f349cb8b4cde6f7285a568 test001 |
backupName | Optional | String | Backup Name | bak001 |
startTime | Optional | String | The start time of backup query | 10/10/2022 12:00:00 AM |
endTime | Optional | String | The end time of backup query | 10/10/2022 12:00:00 AM |
pageNow | Optional | Integer | Current page | 1 |
pageSize | Optional | Integer | Page size | 10 |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The XXX information is queried successfully | |
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
pageNum | Yes | Integer | Current page | 1 | |
pageSize | Yes | Integer | Number per page | 10 | |
total | Yes | Integer | Total number of queries | 100 | |
list | Yes | object[] | Query result body | list |
Table list
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
prodOrderStatus | Yes | Integer | Order status: 0->Order Normal, 1->Order Frozen, 2->Order Canceled, 3->Under Construction, 4->Construction Failed | ||
storePassword | Yes | String | Password for storing backup data on the machine | 123456 | |
prodInstFlag | Yes | String | The label of the dds database is specified as "instance ID instance name" | a649077e15f349cb8b4cde6f7285a568 test001 | |
prodDbEngine | Yes | String | Version of dds database product | 4.0 | |
description | Yes | String | Description | ||
ymdhi | Yes | String | Discarded field | 1 | |
backupType | Yes | String | Backup type: automatic backup and manual backup | Auto Backup | |
result | Yes | String | Brief description of the operation result | ||
storeUser | Yes | String | Username for storing backup data | admin | |
parameterGroupUsed | Yes | String | The name of the shard, single point, or replica set parameter group, which can be used to determine the version of the parameter group | ||
host | Yes | String | Source machine of the backup data | 127.0.0.1 | |
prodInstSetName | Yes | String | SET name corresponding to the dds database instance | set_mm_1 | |
storeIp | Yes | String | Host IP for storing backup files | 127.0.07 | |
startTime | Yes | String | The start time of backup | 10/10/2022 12:00:00 AM | |
toLsn | Yes | String | Latest lsn returned by backup, discarded field | ||
id | Yes | Integer | Primary key id of the backup table | 1 | |
binlogEndTime | Yes | String | Discarded field | ||
errorcode | Yes | Integer | Result: 0 means not started, 1 means wrong parameters, 2 means execution in progress, 3 means success, 4 means stopped, 5 means execution failed | 0 | |
sshPort | Yes | String | Backup machine login port | 8888 | |
prodInstName | Yes | String | Instance Name | test001 | |
binlogPosition | Yes | String | Location of the binlog file returned by backup, discarded field | ||
dbType | Yes | String | Database type, discarded field | ||
history | Yes | String | Detailed description of the operation results | ||
prodType | Yes | Integer | Instance type 0: Single instance, 1: one-master-one-slave, 2: one-master-two-slave, 3: one-master-three-slave | 0 | |
datalen | Yes | String | Data volume processed by the data backup | --- | |
fromLsn | Yes | String | lsn where the backup starts, discarded field | ||
gtidLastChange | Yes | String | Discarded field | ||
storePath | Yes | String | Home directory where backup files are stored | /data/test | |
binlogFileName | Yes | String | Name of the binlog file returned by the backup, discarded field | ||
backupDirName | Yes | String | Subdirectory where backup files are stored, discarded field | ||
ctype | Yes | String | Task reporting type, discarded field | ||
createTime | Yes | String | Creation or modification time | 10/10/2022 12:00:00 AM | |
port | Yes | String | Database port returned by the operation | 8888 | |
prodInstId | Yes | String | Instance ID. | a649077e15f349cb8b4cde6f7285a568 | |
endTime | Yes | String | The end time of backup | 10/10/2022 12:00:00 AM | |
backupName | Yes | String | Backup Name | bak001 |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeBackups?prodInstId=a649077e15f349cb8b4cde6f7285a568
Response Example
{
"statusCode": 800,
"message": "Success",
"returnObj": {
"pageSize": 10,
"list": [
{
"prodOrderStatus": null,
"storePassword": null,
"prodInstFlag": "c46d8f547cc648a78a68270092e70f80 mongodb001",
"prodDbEngine": "4.0",
"description": null,
"ymdhi": null,
"backupType": "Manual backup",
"result": null,
"storeUser": null,
"parameterGroupUsed": "Default-Mongo-4.0",
"host": null,
"prodInstSetName": "set_1098350",
"storeIp": null,
"startTime": 1658914910000,
"toLsn": null,
"id": 2,
"binlogEndTime": null,
"errorcode": 5,
"sshPort": null,
"prodInstName": "mongodb001",
"binlogPosition": null,
"dbType": null,
"history": null,
"prodType": 0,
"datalen": "---",
"fromLsn": null,
"gtidLastChange": null,
"storePath": null,
"binlogFileName": null,
"backupDirName": null,
"ctype": null,
"createTime": 1658914911000,
"port": null,
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"endTime": 1658914910000,
"backupName": "test-0727"
}
],
"pageNum": 1,
"total": 2
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None