Domain name for API request: sqlserver.tencentcloudapi.com.
This API is used to query the list of backups.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: sqlserver.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeBackups. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-03-28. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| StartTime | Yes | Timestamp | Start name (yyyy-MM-dd HH:mm:ss) |
| EndTime | Yes | Timestamp | End time (yyyy-MM-dd HH:mm:ss) |
| InstanceId | Yes | String | Instance ID in the format of mssql-njj2mtpl |
| Limit | No | Integer | Number of results per page. Value range: 1-100. Default value: 20 |
| Offset | No | Integer | Page number. Default value: 0 |
| BackupName | No | String | Filter by backup name. If this parameter is left empty, backup name will not be used in filtering. |
| Strategy | No | Integer | Filter by backup policy. Valid values: 0 (instance backup), 1 (multi-database backup). If this parameter is left empty, backup policy will not be used in filtering. |
| BackupWay | No | Integer | Filter by backup mode. Valid values: 0 (automatic backup on a regular basis), 1 (manual backup performed by the user at any time). If this parameter is left empty, backup mode will not be used in filtering. |
| BackupId | No | Integer | Filter by backup ID. If this parameter is left empty, backup ID will not be used in filtering. |
| DatabaseName | No | String | Filter backups by the database name. If the parameter is left empty, this filter criteria will not take effect. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of backups |
| Backups | Array of Backup | Backup list details |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://sqlserver.tencentcloudapi.com/?Action=DescribeBackups
&InstanceId=mssql-njj2mtpl
&StartTime=2018-03-28 00:00:00
&EndTime=2018-04-20 00:00:00
&Limit=20
&Offset=0
&<Common request parameters>{
"Response": {
"RequestId": "863b2797-858b-49f3-88e9-50159e564cbc",
"TotalCount": 2,
"Backups": [
{
"Id": 49760,
"BackupName": "mssql-3l3fgqn7_202007302200",
"FileName": "manual_instance_58001_20180702160920.bak.tar",
"StartTime": "2018-07-02 16:09:20",
"EndTime": "2018-07-02 16:09:20",
"Size": 192,
"Strategy": 0,
"Status": 1,
"BackupWay": 0,
"DBs": [
"testdbvictornew"
],
"InternalAddr": "http://10.66.0.88:58366/download/backup_49760.tar?YJW3gzNLKt2LCrywP9JslJXZo6TXiqprJ6x+tRJfDqzgJRdDrKF8j2V0XGk/MyyS00h9hexVea0A3GvpPf2aoq80DbnTNfZrLB+Ys00Glvzfv7CfaHRsoM95IpqVGrfNMrxomN6lVfnj6qb8Y3duxg==",
"ExternalAddr": "https://gz-dl-sqlserver.cloud.tencent.com/download/backup_49760.tar?YJW3gzNLKt2LCrywP9JslJXZo6TXiqprJ6x+tRJfDqzgJRdDrKF8j2V0XGk/MyyS00h9hexVea0A3GvpPf2aoq80DbnTNfZrLB+Ys00Glvzfv7CfaHRsoM95IpqVGrfNMrxomN6lVfnj6qb8Y3duxg=="
},
{
"Id": 49759,
"BackupName": "mssql-3l3fgqn7_202007302200",
"FileName": "manual_instance_58001_20180702010430.bak.tar",
"StartTime": "2018-07-02 01:04:30",
"EndTime": "2018-07-02 01:04:30",
"Size": 192,
"Strategy": 0,
"Status": 1,
"BackupWay": 0,
"DBs": [
"testdbvictornew"
],
"InternalAddr": "http://10.66.0.88:58366/download/backup_49759.tar?YJW3gzNLKt2LCrywP9JslJXZo6TXiqprJ6x+tRJfDqzgJRdDrKF8j2V0XGk/MyyS00h9hexVea0A3GvpPf2aoq80DbnTNfZrvuFmWRKDML0cICOu7LASU2gWXlUkKcHfj/tspGhVGw8RX0OKecEUIQ==",
"ExternalAddr": "https://gz-dl-sqlserver.cloud.tencent.com/download/backup_49759.tar?YJW3gzNLKt2LCrywP9JslJXZo6TXiqprJ6x+tRJfDqzgJRdDrKF8j2V0XGk/MyyS00h9hexVea0A3GvpPf2aoq80DbnTNfZrvuFmWRKDML0cICOu7LASU2gWXlUkKcHfj/tspGhVGw8RX0OKecEUIQ=="
}
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InternalError.CosError | COS API error. |
| InternalError.DBError | Database error |
| InternalError.GcsError | GCS API error. |
| InternalError.SystemError | System error. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.InputIllegal | Input error. |
| InvalidParameter.ParamsAssertFailed | An error occurred while converting parameter assertion. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication error. |
Was this page helpful?