tencent cloud

Feedback

ModifyDatabaseCT

Last updated: 2022-01-26 14:32:27

1. API Description

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

This API is used to enable or disable the change tracking (CT) feature.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyDatabaseCT.
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.
DBNames.N Yes Array of String Array of database names
ModifyType Yes String Enable or disable CT. Valid values: enable, disable
InstanceId Yes String Instance ID
ChangeRetentionDay No Integer Retention period (in days) of change tracking information when CT is enabled. Value range: 3-30. Default value: 3

3. Output Parameters

Parameter Name Type Description
FlowId Integer Task ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Enabling/Disabling CT

Input Example

https://sqlserver.tencentcloudapi.com/?Action=ModifyDatabaseCT
&InstanceId=mssql-j8kv137v
&DBNames.0=test_db
&ModifyType=enable
&<Common request parameters>

Output Example

{
  "Response": {
    "FlowId": 9999,
    "RequestId": "a928d733-1099-4f44-84ad-991da182d0s3"
  }
}

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

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.DBError Database error
InvalidParameterValue.DBNameNotNull The database name is required.
InvalidParameterValue.ModifyTypeValueInvalid Only enable and disable are valid values.
ResourceNotFound.DBNotFound The database does not exist.
ResourceUnavailable.DBInvalidStatus Invalid database status.
ResourceUnavailable.InstanceStatusInvalid Invalid instance status.
ResourceUnavailable.NotSupportRoInstance Read-Only instances are not supported.
UnsupportedOperation.NotSupportRepeat Repeated operations are not supported.
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