Domain name for API request: sqlserver.tencentcloudapi.com.
This API is used to query the list of backups.
A maximum of 60 requests can be initiated per second for this API.
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 Params. The value used for this API: DescribeBackups. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-28. |
Region | Yes | String | Common Params. 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 (scheduled backup); 1 (manual backup); 2 (archive backup). Default value: 2 . |
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. |
Group | No | Integer | Whether to group backup files by backup task. Valid value: 0 (no), 1 (yes). Default value: 0 . This parameter is valid only for unarchived backup files. |
Type | No | Integer | Backup type. Valid values: 1 (data backup), 2 (log backup). Default value: 1 . |
BackupFormat | No | String | Filter by backup file format. Valid values: pkg (archive file), single (Unarchived files). |
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. |
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackups
<Common request parameters>
{
"InstanceId": "mssql-njj2mtpl",
"EndTime": "2018-04-20 00:00:00",
"Limit": "20",
"StartTime": "2018-03-28 00:00:00",
"Offset": "0"
}
{
"Response": {
"RequestId": "863b2797-858b-49f3-88e9-50159e564cbc",
"TotalCount": 1,
"Backups": [
{
"BackupFormat": "single",
"BackupName": "mssql-xxx_20220619114124",
"BackupWay": 0,
"DBs": [
"test_db"
],
"CrossBackupAddr": [
{
-77"CrossExternalAddr": "http",
"CrossInternalAddr": "http",
"CrossRegion": "ap-beijing"
}
],
"CrossBackupStatus": [
{
"CrossRegion": "ap-beijing",
"CrossStatus": 1
}
],
"EndTime": "2022-06-19 11:54:53",
"ExternalAddr": "",
"FileName": "",
"GroupId": "16556099469691",
"Id": 0,
"InternalAddr": "",
"Size": 20887196,
"StartTime": "2022-06-19 11:41:24",
"Status": 1,
"Strategy": 0,
"Region": "ap-guangzhou"
}
]
}
}
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 |
---|---|
FailedOperation.CosError | Failed to access COS. |
FailedOperation.DBError | Database error. |
FailedOperation.GcsError | The operation failed or the network timed out. |
InternalError | Internal 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?