Domain name for API request: sqlserver.intl.tencentcloudapi.com.
This API is used to query the scheduled backup retention plans of instances.
A maximum of 20 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: DescribeRegularBackupPlan. |
| 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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| InstanceId | Yes | String | Instance ID. |
| RegularBackupSaveDays | Yes | Integer | Scheduled backup retention days, in the range of [90 - 3650]. The default value is 365. |
| RegularBackupStrategy | Yes | String | Scheduled backup policy. years - annually; quarters - quarterly; months - monthly. The default value is months. |
| RegularBackupCounts | Yes | Integer | Number of retained scheduled backups. The default value is 1. |
| RegularBackupStartTime | Yes | String | Scheduled backup start date, in the format of YYYY-MM-DD. The current date is used by default. |
| BackupCycle.N | Yes | Array of Integer | Regular backup cycle. |
| Parameter Name | Type | Description |
|---|---|---|
| SaveModePeriod | Array of String | Regular backup plan. |
| SaveModeRegular | Array of String | Scheduled backup plan. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to querying the scheduled backup retention plan for the Instance (mssql-j8kv137v)
POST / HTTP/1.1
Host: sqlserver.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegularBackupPlan
<Common request parameters>
{
"InstanceId": "mssql-j8kv137v",
"RegularBackupCounts": "1",
"RegularBackupSaveDays": "365",
"RegularBackupStrategy": "month",
"RegularBackupStartTime": "2022-10-10",
"BackupCycle": [
1,
2,
3
]
}{
"Response": {
"RequestId": "a62cac28-1656-4115-bf8d-189bef5e1102",
"SaveModePeriod": [
"2022-10-24 00:00:00"
],
"SaveModeRegular": [
"2022-10-26 00:00:00"
]
}
}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.DBError | Database error. |
| FailedOperation.GcsError | The operation failed or the network timed out. |
| FailedOperation.NotSupport | The operation is not supported. |
| InvalidParameter.InputIllegal | Input error. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| ResourceUnavailable.InstanceStatusInvalid | Invalid instance status. |
文档反馈