ModifyCrossBackupStrategy

Download PDF

Last updated:2025-10-28 22:49:33

ModifyCrossBackupStrategy

Last updated: 2025-10-28 22:49:33

Download PDF

1. API Description

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

This API is used to enable or disable cross-region backup policies.

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: ModifyCrossBackupStrategy.
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.
CrossBackupEnabled	Yes	String	Cross-region backup switch (data backup & log backup). enable - enabled; disable - disabled.
InstanceId	No	String	Instance ID.
InstanceIdSet.N	No	Array of String	Instance ID list.
CrossBackupSaveDays	No	Integer	Retention days for cross-region backups. Value range: 7-1830. The default value is 7.
CrossBackupRegion.N	No	Array of String	Target region ID for cross-region backups, with a maximum of two and a minimum of one.
CleanUpCrossBackup	No	Integer	Whether to clean up cross-region backups (data backups & log backups) immediately. This parameter is only valid when the value of BackupEnabled is disabled. 1 - yes; 0 - no. The default value is 0.

3. Output Parameters

Parameter Name	Type	Description
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.

4. Example

Example1 Enabling or Disabling Cross-Region Backup Policies

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=ModifyCrossBackupStrategy
&InstanceId=mssql-7vfv3rk3
&InstanceIdSet.0=mssql-7vfv3rk3
&CrossBackupEnabled=enable
&CrossBackupSaveDays=7
&CrossBackupRegion.0=ap-guangzhou
&CleanUpCrossBackup=1
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "fc765108-efcd-11ec-887f-525400853186"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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
FailedOperation.DBError	Database error.
InvalidParameter.InputIllegal	Input error.
InvalidParameterValue.IllegalRegion	Invalid region.
ResourceUnavailable.InstanceStatusInvalid	Invalid instance status.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud