修改订阅对象

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

我的收藏

1. 接口描述

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

本接口(ModifySubscribeObjects)用于修改数据订阅对象和kafka分区规则,如果是mongo订阅,还可以修改输出聚合规则。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifySubscribeObjects。
Version String 公共参数,本接口取值:2021-12-06。
Region String 公共参数,详见产品支持的 地域列表
SubscribeId String 数据订阅实例的ID
示例值:subs-9jyki7hniw
SubscribeObjectType Integer 数据订阅的类型,非mongo任务的枚举值:0-全实例更新;1-数据更新;2-结构更新;3-数据更新+结构更新。mongo任务的枚举值:0-全实例更新;4-订阅单库;5-订阅单集合
示例值:0
Objects.N Array of ModifiedSubscribeObject 修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则改字段必填。
DistributeRules.N Array of DistributeRule kafka分区策略。如果不填,默认不修改。如果填了,会覆盖原来的策略。
DefaultRuleType String 默认分区策略。不满足DistributeRules中正则表达式的数据,将按照默认分区策略计算分区。
非mongo产品支持的默认策略: table-按表名分区,pk-按表名+主键分区。mongo的默认策略仅支持:collection-按集合名分区。
该字段与DistributeRules搭配使用。如果配置了DistributeRules,该字段也必填。如果配置了该字段,视为配置了一条DistributeRules,原来的分区策略也会被覆盖。
示例值:table
PipelineInfo.N Array of PipelineInfo mongo输出聚合设置,mongo任务可选。如果不填,默认不修改。

3. 输出参数

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

4. 示例

示例1 修改数据订阅通道的订阅规则

修改数据订阅的订阅规则,如添加或者移除某些库表

输入示例

https://dts.tencentcloudapi.com/?Action=ModifySubscribeObjects
&SubscribeId=subs-ieuwi83j2e
&SubscribeObjectType=0
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.AuthFailureError 认证失败。
FailedOperation 操作失败。
FailedOperation.FailedOperationError 操作失败。
InternalError 内部错误。
InternalError.InternalErrorError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidParameterError 参数无效。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidParameterValueError 非法参数。
OperationDenied 操作被拒绝。
OperationDenied.OperationDeniedError 操作被拒绝。
ResourceNotFound 资源不存在。
ResourceNotFound.ResourceNotFoundError 资源未找到。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.UnauthorizedOperationError 未授权的操作。
UnsupportedOperation 操作不支持。
UnsupportedOperation.UnsupportedOperationError 不支持的操作。