新增、修改表格数据订阅

最近更新时间:2024-03-12 01:49:17

我的收藏

1. 接口描述

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

新增、修改表格数据订阅

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SetTableDataFlow。
Version String 公共参数,本接口取值:2019-08-23。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 表所属集群实例ID
示例值:5674209986
SelectedTables.N Array of SelectedTableWithField 待创建分布式索引表格列表

3. 输出参数

参数名称 类型 描述
TotalCount Integer 表格数据订阅创建结果数量
示例值:1
TableResults Array of TableResultNew 表格数据订阅创建结果列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新增、修改表格数据订阅

新增、修改表格数据订阅

输入示例

https://tcaplusdb.tencentcloudapi.com/?Action=SetTableDataFlow
&ClusterId=5674209986
&SelectedTables.0.TableInstanceId=tcaplus-1f224454
&SelectedTables.0.TableGroupId=101
&SelectedTables.0.TableName=tb_example
&SelectedTables.0.TableIdlType=PROTO
&SelectedTables.0.TableType=GENERIC
&SelectedTables.0.ShardNum=3
&SelectedTables.0.SelectedFields.0.FieldName=name
&SelectedTables.0.SelectedFields.0.IsPrimaryKey=Yes
&SelectedTables.0.SelectedFields.0.FieldType=string
&SelectedTables.0.SelectedFields.0.FieldSize=64
&SelectedTables.0.SelectedFields.1.FieldName=id
&SelectedTables.0.SelectedFields.1.IsPrimaryKey=No
&SelectedTables.0.SelectedFields.1.FieldType=int32
&SelectedTables.0.SelectedFields.1.FieldSize=4
&SelectedTables.0.KafkaInfo.Address=string
&SelectedTables.0.KafkaInfo.IsVpc=0
&SelectedTables.0.KafkaInfo.Topic=string
&SelectedTables.0.KafkaInfo.User=string
&SelectedTables.0.KafkaInfo.Password=string
&SelectedTables.0.KafkaInfo.Instance=string
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "122bb375-7464-4536-a3c5-8ddbdd6f4ce4",
        "TableResults": [
            {
                "Error": null,
                "TableGroupId": "101",
                "TableIdlType": null,
                "TableInstanceId": "tcaplus-1f224454",
                "TableName": "tb_example",
                "TableType": null,
                "ApplicationId": "null",
                "TaskId": "5674209986-1199",
                "TaskIds": null
            }
        ],
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 接口操作鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。