数据结构

最近更新时间:2024-06-18 02:12:03

我的收藏

Application

审批申请单

被如下接口引用:DescribeApplications。

名称 类型 描述
ApplicationId String 审批单号
示例值:10001
ApplicationType Integer 申请类型
示例值:表格合并
ClusterId String 集群Id
示例值:1822112
ClusterName String 集群名称
示例值:Test
TableGroupName String 表格组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:db_user
TableName String 表格名称
示例值:db_user_info
Applicant String 申请人
示例值:yuxinfan
CreatedTime String 建单时间
示例值:2021-01-18 20:10:21
ApplicationStatus Integer 处理状态 -1 撤回 0-待审核 1-已经审核并提交任务 2-已驳回
示例值:0
TableGroupId String 表格组Id
示例值:222
TaskId String 已提交的任务Id,未提交申请为0
示例值:222
TableInstanceId String 腾讯云上table的唯一键
注意:此字段可能返回 null,表示取不到有效值。
示例值:tcaplus_dsdfsdf
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-01-18 20:10:21
ExecuteUser String 审批人
注意:此字段可能返回 null,表示取不到有效值。
示例值:yuxinfan
ExecuteStatus String 执行状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CanCensor Boolean 该申请单是否可以被当前用户审批
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CanWithdrawal Boolean 该申请单是否可以被当前用户撤回
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

ApplyResult

更新申请单结果

被如下接口引用:UpdateApply。

名称 类型 描述
ApplicationId String 申请单id
示例值:10001
ApplicationType Integer 申请类型
示例值:0
ApplicationStatus Integer 处理状态 0-待审核 1-已经审核并提交任务 2-已驳回
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TaskId String 已提交的任务Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

ApplyStatus

申请单id及其状态

被如下接口引用:UpdateApply。

名称 类型 必选 描述
ApplicationId String 集群id-申请单id
示例值:1-10001
ApplicationStatus Integer 处理状态-1-撤回 1-通过 2-驳回,非0状态的申请单不可改变状态。
示例值:0
ApplicationType Integer 申请单类型
示例值:0
ClusterId String 集群Id
示例值:10001

BackupExpireRuleInfo

备份保留策略详情
集群策略: ClueterId=集群Id, TableGroupId=-1, TableName="-1"
集群+表格组策略: ClueterId=集群Id, TableGroupId=表格组Id, TableName="-1"
集群+表格组+表格策略: ClueterId=集群Id, TableGroupId=表格组Id, TableName="表格名"

FileTag=0 txh引擎文件, =1 ulog流水文件, 当要设置为=1时, 这两项不可变 TableGroupId=-1和TableName="-1"
ExpireDay为大于等于1,小于999的整形数字
OperType=0 代表动作为新增, =1 代表动作为删除, =2 代表动作为修改, 其中0和2可以混用,后端实现兼容

被如下接口引用:SetBackupExpireRule。

名称 类型 必选 描述
TableGroupId String 所属表格组ID
示例值:0
TableName String 表名称
示例值:0
FileTag Integer 文件标签,见上面描述
示例值:0
ExpireDay Integer 淘汰天数,见上面描述
示例值:0
OperType Integer 操作类型,见上面描述
示例值:0

BackupRecords

备份记录
作为出参时,每个字段都会填充
作为入参时, 原封不动将每个字段填回结构体, 注意只有FIleTag=OSDATA才可以调用此接口

被如下接口引用:DeleteBackupRecords, DescribeBackupRecords。

名称 类型 必选 描述
ZoneId Integer 表格组ID
示例值:0
TableName String 表名称
示例值:0
BackupType String 备份源
示例值:0
FileTag String 文件标签:TCAPLUS_FULL或OSDATA
示例值:0
ShardCount Integer 分片数量
示例值:0
BackupBatchTime String 备份批次日期
示例值:0
BackupFileSize Integer 备份文件汇总大小
示例值:0
BackupSuccRate String 备份成功率
示例值:0
BackupExpireTime String 备份文件过期时间
示例值:0
AppId Integer 业务ID
示例值:0

ClusterInfo

集群详细信息

被如下接口引用:DescribeClusters。

名称 类型 描述
ClusterName String 集群名称
示例值:0
ClusterId String 集群ID
示例值:0
Region String 集群所在地域
示例值:0
IdlType String 集群数据描述语言类型,如:PROTO,TDR
示例值:0
NetworkType String 网络类型
示例值:0
VpcId String 集群关联的用户私有网络实例ID
示例值:0
SubnetId String 集群关联的用户子网实例ID
示例值:0
CreatedTime Timestamp 创建时间
示例值:0
Password String 集群密码
示例值:0
PasswordStatus String 密码状态
示例值:0
ApiAccessId String TcaplusDB SDK连接参数,接入ID
示例值:0
ApiAccessIp String TcaplusDB SDK连接参数,接入地址
示例值:0
ApiAccessPort Integer TcaplusDB SDK连接参数,接入端口
示例值:0
OldPasswordExpireTime String 如果PasswordStatus是unmodifiable说明有旧密码还未过期,此字段将显示旧密码过期的时间,否则为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ApiAccessIpv6 String TcaplusDB SDK连接参数,接入ipv6地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ClusterType Integer 集群类型,0,1:共享集群; 2:独立集群
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ClusterStatus Integer 集群状态, 0:表示正常运行中,1:表示冻结隔离一般欠费进入此状态,2:表示待回收,一般用户主动触发删除进入这个状态,3:待释放,进入这个状态,表示可以释放此表占用的资源了,4:变更中
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ReadCapacityUnit Integer 读CU
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
WriteCapacityUnit Integer 写CU
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DiskVolume Integer 磁盘容量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ServerList Array of ServerDetailInfo 独占server机器信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ProxyList Array of ProxyDetailInfo 独占proxy机器信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Censorship Integer 是否开启审核 0-不开启 1-开启
示例值:0
DbaUins Array of String 审批人uin列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DataFlowStatus Integer 是否开启了数据订阅
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
KafkaInfo KafkaInfo 数据订阅的kafka信息
注意:此字段可能返回 null,表示取不到有效值。
TxhBackupExpireDay Integer 集群Txh备份文件多少天后过期删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
UlogBackupExpireDay Integer 集群Ulog备份文件多少天后过期删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
IsReadOnlyUlogBackupExpireDay Integer 集群Ulog备份文件过期策略是否为只读, 0: UlogBackupExpire是只读,不可修改, 1: UlogBackupExpire可以修改(当前业务存在Svrid第二段等于clusterid的机器)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RestProxyStatus Integer restproxy状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

CompareTablesInfo

比较表格的Meta信息

被如下接口引用:MergeTablesData。

名称 类型 必选 描述
SrcTableClusterId String 源表格的集群id
注意:此字段可能返回 null,表示取不到有效值。
SrcTableGroupId String 源表格的表格组id
注意:此字段可能返回 null,表示取不到有效值。
SrcTableName String 源表格的表名
注意:此字段可能返回 null,表示取不到有效值。
DstTableClusterId String 目标表格的集群id
注意:此字段可能返回 null,表示取不到有效值。
DstTableGroupId String 目标表格的表格组id
注意:此字段可能返回 null,表示取不到有效值。
DstTableName String 目标表格的表名
注意:此字段可能返回 null,表示取不到有效值。
SrcTableInstanceId String 源表格的实例id
注意:此字段可能返回 null,表示取不到有效值。
DstTableInstanceId String 目标表格的实例id
注意:此字段可能返回 null,表示取不到有效值。

ErrorInfo

描述每个实例(应用,大区或表)处理过程中可能出现的错误详情。

被如下接口引用:ClearTables, CompareIdlFiles, CreateSnapshots, CreateTables, DeleteIdlFiles, DeleteSnapshots, DeleteTableDataFlow, DeleteTableIndex, DeleteTables, DescribeClusterTags, DescribeSnapshots, DescribeTableGroupTags, DescribeTableTags, DescribeTables, DescribeTablesInRecycle, MergeTablesData, ModifySnapshots, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables, RollbackTables, SetTableDataFlow, SetTableIndex, UpdateApply, VerifyIdlFiles。

名称 类型 描述
Code String 错误码
Message String 错误信息

FieldInfo

表格字段信息列表

被如下接口引用:SetTableDataFlow, SetTableIndex。

名称 类型 必选 描述
FieldName String 表格字段名称
IsPrimaryKey String 字段是否是主键字段
FieldType String 字段类型
FieldSize Integer 字段长度

Filter

过滤条件

被如下接口引用:DescribeClusters, DescribeTableGroups, DescribeTables, DescribeTablesInRecycle, DescribeTasks。

名称 类型 必选 描述
Name String 过滤字段名
示例值:"name"
Value String 过滤字段值
示例值:"value"
Values Array of String 过滤字段值
示例值:["value1", "value2"]

IdlFileInfo

表定义描述文件详情,包含文件内容

被如下接口引用:CompareIdlFiles, CreateTables, DeleteIdlFiles, DescribeIdlFileInfos, DescribeTables, DescribeTablesInRecycle, ModifyTables, VerifyIdlFiles。

名称 类型 必选 描述
FileName String 文件名称,不包含扩展名
FileType String 数据描述语言(IDL)类型
FileExtType String 文件扩展名
FileSize Integer 文件大小(Bytes)
FileId Integer 文件ID,对于已上传的文件有意义
注意:此字段可能返回 null,表示取不到有效值。
FileContent String 文件内容,对于本次新上传的文件有意义
注意:此字段可能返回 null,表示取不到有效值。

IdlFileInfoWithoutContent

表定义描述文件详情,不包含文件内容

被如下接口引用:DeleteIdlFiles。

名称 类型 描述
FileName String 文件名称,不包含扩展名
注意:此字段可能返回 null,表示取不到有效值。
FileType String 数据描述语言(IDL)类型
注意:此字段可能返回 null,表示取不到有效值。
FileExtType String 文件扩展名
注意:此字段可能返回 null,表示取不到有效值。
FileSize Integer 文件大小(Bytes)
注意:此字段可能返回 null,表示取不到有效值。
FileId Integer 文件ID
注意:此字段可能返回 null,表示取不到有效值。
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。

KafkaInfo

ckafka地址信息

被如下接口引用:DescribeClusters, SetTableDataFlow, SetTableIndex。

名称 类型 必选 描述
Address String Kafka address
注意:此字段可能返回 null,表示取不到有效值。
示例值:ckafka-3azrwxvw.ap-shanghai.ckafka.tencentcloudmq.com:6006
Topic String Kafka topic
注意:此字段可能返回 null,表示取不到有效值。
示例值:tcapstream
User String kafka username
注意:此字段可能返回 null,表示取不到有效值。
示例值:ckafka-3azrwxvw#tcaplusDev
Password String kafka password
注意:此字段可能返回 null,表示取不到有效值。
示例值:tcaplusDev123321
Instance String ckafka实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:ckafka-l4xpzgpz
IsVpc Integer 是否走VPC
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

KeyFile

部分key导入快照数据时所需要的key文件

被如下接口引用:ImportSnapshots。

名称 类型 必选 描述
FileName String key文件名称
FileExtType String key文件扩展名
FileContent String key文件内容
FileSize Integer key文件大小

MachineInfo

机器类型和数量

被如下接口引用:CreateCluster, ModifyClusterMachine。

名称 类型 必选 描述
MachineType String 机器类型
MachineNum Integer 机器数量

MergeTableResult

合服结果

被如下接口引用:MergeTablesData。

名称 类型 描述
TaskId String 任务Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Error ErrorInfo 成功时此字段返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Table CompareTablesInfo 对比的表格信息
示例值:0
ApplicationId String 申请单Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

MergeTablesInfo

合服请求入参

被如下接口引用:MergeTablesData。

名称 类型 必选 描述
MergeTables CompareTablesInfo 合服的表格信息
CheckIndex Boolean 是否检查索引

ParsedTableInfoNew

从IDL表描述文件中解析出来的表信息

被如下接口引用:CompareIdlFiles, VerifyIdlFiles。

名称 类型 描述
TableIdlType String 表格描述语言类型:PROTOTDR
注意:此字段可能返回 null,表示取不到有效值。
TableInstanceId String 表格实例ID
注意:此字段可能返回 null,表示取不到有效值。
TableName String 表格名称
注意:此字段可能返回 null,表示取不到有效值。
TableType String 表格数据结构类型:GENERICLIST
注意:此字段可能返回 null,表示取不到有效值。
KeyFields String 主键字段信息
注意:此字段可能返回 null,表示取不到有效值。
OldKeyFields String 原主键字段信息,改表校验时有效
注意:此字段可能返回 null,表示取不到有效值。
ValueFields String 非主键字段信息
注意:此字段可能返回 null,表示取不到有效值。
OldValueFields String 原非主键字段信息,改表校验时有效
注意:此字段可能返回 null,表示取不到有效值。
TableGroupId String 所属表格组ID
注意:此字段可能返回 null,表示取不到有效值。
SumKeyFieldSize Integer 主键字段总大小
注意:此字段可能返回 null,表示取不到有效值。
SumValueFieldSize Integer 非主键字段总大小
注意:此字段可能返回 null,表示取不到有效值。
IndexKeySet String 索引键集合
注意:此字段可能返回 null,表示取不到有效值。
ShardingKeySet String 分表因子集合
注意:此字段可能返回 null,表示取不到有效值。
TdrVersion Integer TDR版本号
注意:此字段可能返回 null,表示取不到有效值。
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。
ListElementNum Integer LIST类型表格元素个数
注意:此字段可能返回 null,表示取不到有效值。
SortFieldNum Integer SORTLIST类型表格排序字段个数
注意:此字段可能返回 null,表示取不到有效值。
SortRule Integer SORTLIST类型表格排序顺序
注意:此字段可能返回 null,表示取不到有效值。

PoolInfo

center资源池中的机器信息

被如下接口引用:DescribeMachine。

名称 类型 描述
PoolUid Integer 唯一id
Ipv6Enable Integer 是否支持ipv6
AvailableAppCount Integer 剩余可用app
ServerList Array of ServerMachineInfo svr机器列表
ProxyList Array of ProxyMachineInfo proxy机器列表

ProxyDetailInfo

独占的proxy详细信息

被如下接口引用:DescribeClusters。

名称 类型 描述
ProxyUid String proxy的唯一id
示例值:1.2.2.2
MachineType String 机器类型
示例值:0
ProcessSpeed Integer 请求包速度
示例值:0
AverageProcessDelay Integer 请求包时延
示例值:0
SlowProcessSpeed Integer 慢处理包速度
示例值:0
Version String 版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:3.46.0

ProxyMachineInfo

proxy机器信息

被如下接口引用:DescribeMachine。

名称 类型 描述
ProxyUid String 唯一id
示例值:tcaproxy-123
MachineType String 机器类型
示例值:T1
AvailableCount Integer 可分配proxy资源数
示例值:1

RegionInfo

TcaplusDB服务地域信息详情

被如下接口引用:DescribeRegions。

名称 类型 描述
RegionName String 地域Ap-Code
RegionAbbr String 地域缩写
RegionId Integer 地域ID
Ipv6Enable Integer 是否支持ipv6,0:不支持,1:支持

SelectedTableInfoNew

被选中的表信息

被如下接口引用:ClearTables, CompareIdlFiles, CreateBackup, CreateTables, DeleteTableDataFlow, DeleteTableIndex, DeleteTables, DescribeSnapshots, DescribeTableTags, DescribeTables, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables, RollbackTables。

名称 类型 必选 描述
TableGroupId String 表所属表格组ID
TableName String 表格名称
TableInstanceId String 表实例ID
TableIdlType String 表格描述语言类型:PROTOTDR
TableType String 表格数据结构类型:GENERICLIST
ListElementNum Integer LIST表元素个数
ReservedVolume Integer 表格预留容量(GB)
ReservedReadQps Integer 表格预留读CU
ReservedWriteQps Integer 表格预留写CU
Memo String 表格备注信息
FileName String Key回档文件名,回档专用
FileExtType String Key回档文件扩展名,回档专用
FileSize Integer Key回档文件大小,回档专用
FileContent String Key回档文件内容,回档专用

SelectedTableWithField

附带被选中字段信息的表格列表

被如下接口引用:SetTableDataFlow, SetTableIndex。

名称 类型 必选 描述
TableGroupId String 表所属表格组ID
示例值:101
TableName String 表格名称
示例值:tb_example
TableInstanceId String 表实例ID
示例值:tcaplus-1f224454
TableIdlType String 表格描述语言类型:PROTOTDR
示例值:PROTO
TableType String 表格数据结构类型:GENERICLIST
示例值:GENERIC
SelectedFields Array of FieldInfo 待创建索引、缓写、数据订阅的字段列表
ShardNum Integer 索引分片数
示例值:3
KafkaInfo KafkaInfo ckafka实例信息

ServerDetailInfo

server独占机器的详细信息

被如下接口引用:DescribeClusters。

名称 类型 描述
ServerUid String svr唯一id
示例值:1.2.2.2
MachineType String 机器类型
示例值:master
MemoryRate Integer 内存占用量
示例值:0
DiskRate Integer 磁盘占用量
示例值:0
ReadNum Integer 读次数
示例值:0
WriteNum Integer 写次数
示例值:0
Version String 版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:3.46.0

ServerMachineInfo

svr的机器列表ServerList

被如下接口引用:DescribeMachine。

名称 类型 描述
ServerUid String 机器唯一id
MachineType String 机器类型

SnapshotInfo

快照列表

被如下接口引用:CreateSnapshots, ImportSnapshots。

名称 类型 必选 描述
TableGroupId String 所属表格组ID
TableName String 表名称
SnapshotName String 快照名称
SnapshotTime Timestamp 快照时间点
SnapshotDeadTime Timestamp 快照过期时间点

SnapshotInfoNew

新的快照过期时间

被如下接口引用:DeleteSnapshots, ModifySnapshots。

名称 类型 必选 描述
TableGroupId String 所属表格组ID
TableName String 表名称
SnapshotName String 快照名称
SnapshotDeadTime Timestamp 快照过期时间点

SnapshotResult

创建快照结果

被如下接口引用:CreateSnapshots, DeleteSnapshots, DescribeSnapshots, ModifySnapshots。

名称 类型 描述
TableGroupId String 表格所属表格组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TableName String 表格名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TaskId String 任务ID,对于创建单任务的接口有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SnapshotName String 快照名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SnapshotTime Timestamp 快照的时间点
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SnapshotDeadTime Timestamp 快照的过期时间点
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SnapshotCreateTime Timestamp 快照创建时间点
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SnapshotSize Integer 快照大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SnapshotStatus Integer 快照状态,0 生成中 1 正常 2 删除中 3 已失效 4 回档使用中
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ApplicationId String 申请单ID
注意:此字段可能返回 null,表示取不到有效值。

SyncTableField

缓写表字段名称的映射

被如下接口引用:DescribeTables, DescribeTablesInRecycle。

名称 类型 必选 描述
SourceName String TcaplusDB表字段名称
示例值:id
TargetName String 目标缓写表的字段名称
示例值:id

SyncTableInfo

TcaplusDB的缓写表信息

被如下接口引用:DescribeTables, DescribeTablesInRecycle。

名称 类型 描述
TargetTableSplitNum Integer 目标缓写表的分表数目
示例值:1
TargetTableNamePrefix Array of String 目标缓写表名前缀
TargetSyncDBInstanceId String 缓写数据库实例ID
示例值:cdb-70zdmgg1
TargetDatabaseName String 缓写表所在数据库名称
示例值:db
Status Integer 缓写状态,0:创建中,1:进行中,2:关闭,-1:被删除
示例值:0
ClusterId String 表格所在集群ID
示例值:18641706761
TableGroupId Integer 表格所在表格组ID
示例值:1
TableName String 表格名称
示例值:tablename
TableId String 表格ID
示例值:tcaplus-d753f0db
KeyFieldMapping Array of SyncTableField TcaplusDB表主键字段到目标缓写表字段的映射
ValueFieldMapping Array of SyncTableField TcaplusDB表字段到目标缓写表字段的映射

TableGroupInfo

表格组详细信息

被如下接口引用:DescribeTableGroups。

名称 类型 描述
TableGroupId String 表格组ID
示例值:"123"
TableGroupName String 表格组名称
示例值:"ZoneName"
CreatedTime Timestamp 表格组创建时间
示例值:20211011
TableCount Integer 表格组包含的表格数量
示例值:10
TotalSize Integer 表格组包含的表格存储总量(MB)
示例值:100
TxhBackupExpireDay Integer 表格Txh备份文件多少天后过期删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
EnableMysql Integer 是否开启mysql负载均衡,0未开启 1开启中 2已开启
示例值:1
MysqlConnIp String mysql负载均衡vip
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.0.0.0
MysqlConnPort Integer mysql负载均衡vport
注意:此字段可能返回 null,表示取不到有效值。
示例值:3306

TableInfoNew

表格详情信息

被如下接口引用:DescribeTables, DescribeTablesInRecycle。

名称 类型 描述
TableName String 表格名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableInstanceId String 表格实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableType String 表格数据结构类型,如:GENERICLIST
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableIdlType String 表格数据描述语言(IDL)类型,如:PROTOTDR
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterId String 表格所属集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterName String 表格所属集群名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableGroupId String 表格所属表格组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableGroupName String 表格所属表格组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
KeyStruct String 表格主键字段结构json字符串
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ValueStruct String 表格非主键字段结构json字符串
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ShardingKeySet String 表格分表因子集合,对PROTO类型表格有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IndexStruct String 表格索引键字段集合,对PROTO类型表格有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ListElementNum Integer LIST类型表格元素个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IdlFiles Array of IdlFileInfo 表格所关联IDL文件信息列表
注意:此字段可能返回 null,表示取不到有效值。
ReservedVolume Integer 表格预留容量(GB)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ReservedReadQps Integer 表格预留读CU
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ReservedWriteQps Integer 表格预留写CU
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TableSize Integer 表格实际数据量大小(MB)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status String 表格状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreatedTime String 表格创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UpdatedTime String 表格最后一次修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Memo String 表格备注信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApiAccessId String TcaplusDB SDK数据访问接入ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SortFieldNum Integer SORTLIST类型表格排序字段个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SortRule Integer SORTLIST类型表格排序顺序
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DbClusterInfoStruct String 表格分布式索引/缓写、kafka数据订阅信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TxhBackupExpireDay Integer 表格Txh备份文件多少天后过期删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SyncTableInfo SyncTableInfo 表格的缓写信息
注意:此字段可能返回 null,表示取不到有效值。

TableResultNew

表处理结果信息

被如下接口引用:ClearTables, CreateTables, DeleteTableDataFlow, DeleteTableIndex, DeleteTables, ModifyTableMemos, ModifyTableQuotas, ModifyTableTags, ModifyTables, RecoverRecycleTables, SetTableDataFlow, SetTableIndex。

名称 类型 描述
TableInstanceId String 表格实例ID,形如:tcaplus-3be64cbb
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TaskId String 任务ID,对于创建单任务的接口有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TableName String 表格名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TableType String 表格数据结构类型,如:GENERICLIST
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TableIdlType String 表数据描述语言(IDL)类型,如:PROTOTDR
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TableGroupId String 表格所属表格组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TaskIds Array of String 任务ID列表,对于创建多任务的接口有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ApplicationId String 腾讯云申请审核单Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

TableRollbackResultNew

表格回档结果信息

被如下接口引用:RollbackTables。

名称 类型 描述
TableInstanceId String 表格实例ID,形如:tcaplus-3be64cbb
注意:此字段可能返回 null,表示取不到有效值。
TaskId String 任务ID,对于创建单任务的接口有效
注意:此字段可能返回 null,表示取不到有效值。
TableName String 表格名称
注意:此字段可能返回 null,表示取不到有效值。
TableType String 表格数据结构类型,如:GENERICLIST
注意:此字段可能返回 null,表示取不到有效值。
TableIdlType String 表格数据描述语言(IDL)类型,如:PROTOTDR
注意:此字段可能返回 null,表示取不到有效值。
TableGroupId String 表格所属表格组ID
注意:此字段可能返回 null,表示取不到有效值。
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。
TaskIds Array of String 任务ID列表,对于创建多任务的接口有效
注意:此字段可能返回 null,表示取不到有效值。
FileId String 上传的key文件ID
注意:此字段可能返回 null,表示取不到有效值。
SuccKeyNum Integer 校验成功Key数量
注意:此字段可能返回 null,表示取不到有效值。
TotalKeyNum Integer Key文件中包含总的Key数量
注意:此字段可能返回 null,表示取不到有效值。

TagInfoUnit

标签信息单元

被如下接口引用:CreateCluster, CreateTableGroup, CreateTables, DescribeClusterTags, DescribeTableGroupTags, DescribeTableTags, ModifyClusterTags, ModifyTableGroupTags, ModifyTableTags。

名称 类型 必选 描述
TagKey String 标签键
TagValue String 标签值
注意:此字段可能返回 null,表示取不到有效值。

TagsInfoOfCluster

集群的标签信息

被如下接口引用:DescribeClusterTags。

名称 类型 描述
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of TagInfoUnit 标签信息
注意:此字段可能返回 null,表示取不到有效值。
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。

TagsInfoOfTable

表格标签信息

被如下接口引用:DescribeTableTags。

名称 类型 描述
TableInstanceId String 表格实例ID
注意:此字段可能返回 null,表示取不到有效值。
TableName String 表格名称
注意:此字段可能返回 null,表示取不到有效值。
TableGroupId String 表格组ID
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of TagInfoUnit 标签信息
注意:此字段可能返回 null,表示取不到有效值。
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。

TagsInfoOfTableGroup

表格组标签信息

被如下接口引用:DescribeTableGroupTags。

名称 类型 描述
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
TableGroupId String 表格组ID
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of TagInfoUnit 标签信息
注意:此字段可能返回 null,表示取不到有效值。
Error ErrorInfo 错误信息
注意:此字段可能返回 null,表示取不到有效值。

TaskInfoNew

任务信息详情

被如下接口引用:DescribeTasks。

名称 类型 描述
TaskId String 任务ID
TaskType String 任务类型
TransId String 任务所关联的TcaplusDB内部事务ID
ClusterId String 任务所属集群ID
ClusterName String 任务所属集群名称
Progress Integer 任务进度
StartTime Timestamp 任务创建时间
UpdateTime Timestamp 任务最后更新时间
Operator String 操作者
Content String 任务详情
TableGroupId String 表格组ID
注意:此字段可能返回 null,表示取不到有效值。
TableGroupName String 表格组名称
注意:此字段可能返回 null,表示取不到有效值。
TableName String 表名称
注意:此字段可能返回 null,表示取不到有效值。