tencent cloud



Last updated: 2022-11-29 17:26:14

1. API Description

Domain name for API request: sqlserver.tencentcloudapi.com.

This API is used to modify the backup policy.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: ModifyBackupStrategy.
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.
InstanceId Yes String Instance ID.
BackupType No String Backup type. Valid values: weekly (when length(BackupDay) <=7 && length(BackupDay) >=2), daily (when length(BackupDay)=1). Default value: daily.
BackupTime No Integer Backup time. Value range: an integer from 0 to 23.
BackupDay No Integer Backup interval in days when the BackupType is daily. Valid value: 1.
BackupModel No String Backup mode. Valid values: master_pkg (archive the backup files of the primary node), master_no_pkg (do not archive the backup files of the primary node), slave_pkg (archive the backup files of the replica node), slave_no_pkg (do not archive the backup files of the replica node). Backup files of the replica node are supported only when Always On disaster recovery is enabled.
BackupCycle.N No Array of Integer The days of the week on which backup will be performed when “BackupType” is weekly. If data backup retention period is less than 7 days, the values will be 1-7, indicating that backup will be performed everyday by default; if data backup retention period is greater than or equal to 7 days, the values will be at least any two days, indicating that backup will be performed at least twice in a week by default.
BackupSaveDays No Integer Data (log) backup retention period. Value range: 3-1830 days, default value: 7 days.
RegularBackupEnable No String Archive backup status. Valid values: enable (enabled); disable (disabled). Default value: disable.
RegularBackupSaveDays No Integer Archive backup retention days. Value range: 90–3650 days. Default value: 365 days.
RegularBackupStrategy No String Archive backup policy. Valid values: years (yearly); quarters (quarterly); months(monthly); Default value:months`.
RegularBackupCounts No Integer The number of retained archive backups. Default value: 1.
RegularBackupStartTime No String Archive backup start date in YYYY-MM-DD format, which is the current time by default.

3. Output Parameters

Parameter Name Type Description
Errno Integer Returned error code.
Msg String Returned error message.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the backup policy of the "mssql-j8kv137v" instance

Input Example

Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBackupStrategy
<Common request parameters>

    "BackupTime": "14",
    "InstanceId": "mssql-j8kv137v",
    "RegularBackupCounts": "1",
    "BackupSaveDays": "7",
    "BackupDay": "1",
    "RegularBackupSaveDays": "365",
    "BackupType": "daily",
    "RegularBackupEnable": "enable",
    "RegularBackupStrategy": "month",
    "RegularBackupStartTime": "2022-10-10"

Output Example

    "Response": {
        "RequestId": "780339f6-30d7-419a-a30c-c2dc0933af1c",
        "Errno": 0,
        "Msg": ""

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.GcsError GCS API error.
InternalError.SystemError System error.
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
ResourceNotFound.InstanceNotFound The instance does not exist.
ResourceUnavailable.InstanceStatusInvalid Invalid instance status.
UnauthorizedOperation.PermissionDenied CAM authentication error.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support