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.
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: ModifyDatabaseCT. |
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. |
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 |
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. |
https://sqlserver.tencentcloudapi.com/?Action=ModifyDatabaseCT
&InstanceId=mssql-j8kv137v
&DBNames.0=test_db
&ModifyType=enable
&<Common request parameters>
{
"Response": {
"FlowId": 9999,
"RequestId": "a928d733-1099-4f44-84ad-991da182d0s3"
}
}
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 |
---|---|
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. |
UnauthorizedOperation.PermissionDenied | CAM authentication error. |
UnsupportedOperation.NotSupportRepeat | Repeated operations are not supported. |
Was this page helpful?