开启&关闭数据库CDC

最近更新时间:2024-03-12 01:47:13

我的收藏

1. 接口描述

接口请求域名: sqlserver.tencentcloudapi.com 。

本接口(ModifyDatabaseCDC)用于开启、关闭数据库数据变更捕获(CDC)

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyDatabaseCDC。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
DBNames.N Array of String 数据库名数组
示例值:[db_test]
ModifyType String 开启、关闭数据库CDC功能 enable;开启,disable:关闭
示例值:enable
InstanceId String 实例ID
示例值:mssql-j8kv137v

3. 输出参数

参数名称 类型 描述
FlowId Integer 流程ID
示例值:99999
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开启、关闭数据库数据变更捕获CDC

输入示例

https://sqlserver.tencentcloudapi.com/?Action=ModifyDatabaseCDC
&InstanceId=mssql-j8kv137v
&DBNames.0=test_db
&ModifyType=enable
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.DBError 数据库错误。
InvalidParameterValue.DBNameNotNull 数据库名称不能为空。
InvalidParameterValue.ModifyTypeValueInvalid 可选参数[enable, disable]。
ResourceNotFound.DBNotFound 数据库不存在。
ResourceNotFound.InstanceNotFound 实例不存在。
ResourceUnavailable.DBInvalidStatus 数据库状态无效。
ResourceUnavailable.InstanceStatusInvalid 实例状态无效。
ResourceUnavailable.NotSupportRoInstance 不支持只读实例。
UnauthorizedOperation.PermissionDenied cam鉴权错误。