tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyDatabaseCDC

Last updated: 2023-09-18 11:41:42

1. API Description

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

This API is used to enable or disable the change data capture (CDC) 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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyDatabaseCDC.
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 CDC. Valid values: enable, disable
InstanceId Yes String Instance ID

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 CDC

Input Example

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

Output Example

{
    "Response": {
        "FlowId": 9999,
        "RequestId": "a928d733-109a-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.
ResourceNotFound.InstanceNotFound The instance 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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy