数据结构

最近更新时间:2021-05-20 08:07:58

我的收藏

Application

审批申请单

被如下接口引用:DescribeApplications。

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

ApplyResult

更新申请单结果

被如下接口引用:UpdateApply。

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

ApplyStatus

申请单id及其状态

被如下接口引用:UpdateApply。

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

ClusterInfo

集群详细信息

被如下接口引用:DescribeClusters。

名称 类型 描述
ClusterName String 集群名称
ClusterId String 集群ID
Region String 集群所在地域
IdlType String 集群数据描述语言类型,如:PROTO,TDR
NetworkType String 网络类型
VpcId String 集群关联的用户私有网络实例ID
SubnetId String 集群关联的用户子网实例ID
CreatedTime Timestamp 创建时间
Password String 集群密码
PasswordStatus String 密码状态
ApiAccessId String TcaplusDB SDK连接参数,接入ID
ApiAccessIp String TcaplusDB SDK连接参数,接入地址
ApiAccessPort Integer TcaplusDB SDK连接参数,接入端口
OldPasswordExpireTime String 如果PasswordStatus是unmodifiable说明有旧密码还未过期,此字段将显示旧密码过期的时间,否则为空
注意:此字段可能返回 null,表示取不到有效值。
ApiAccessIpv6 String TcaplusDB SDK连接参数,接入ipv6地址
注意:此字段可能返回 null,表示取不到有效值。
ClusterType Integer 集群类型
注意:此字段可能返回 null,表示取不到有效值。
ClusterStatus Integer 集群状态
注意:此字段可能返回 null,表示取不到有效值。
ReadCapacityUnit Integer 读CU
注意:此字段可能返回 null,表示取不到有效值。
WriteCapacityUnit Integer 写CU
注意:此字段可能返回 null,表示取不到有效值。
DiskVolume Integer 磁盘容量
注意:此字段可能返回 null,表示取不到有效值。
ServerList Array of ServerDetailInfo 独占server机器信息
注意:此字段可能返回 null,表示取不到有效值。
ProxyList Array of ProxyDetailInfo 独占proxy机器信息
注意:此字段可能返回 null,表示取不到有效值。
Censorship Integer 是否开启审核 0-不开启 1-开启
DbaUins Array of String 审批人uin列表
注意:此字段可能返回 null,表示取不到有效值。

CompareTablesInfo

比较表格的Meta信息

被如下接口引用:MergeTablesData。

名称 类型 必选 描述
SrcTableClusterId String 源表格的集群id
SrcTableGroupId String 源表格的表格组id
SrcTableName String 源表格的表名
DstTableClusterId String 目标表格的集群id
DstTableGroupId String 目标表格的表格组id
DstTableName String 目标表格的表名
SrcTableInstanceId String 源表格的实例id
DstTableInstanceId String 目标表格的实例id

ErrorInfo

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

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

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

FieldInfo

表格字段信息列表

被如下接口引用:SetTableIndex。

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

Filter

过滤条件

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

名称 类型 必选 描述
Name String 过滤字段名
Value String 过滤字段值
Values Array of String 过滤字段值

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,表示取不到有效值。

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,表示取不到有效值。
Error ErrorInfo 成功时此字段返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
Table CompareTablesInfo 对比的表格信息
ApplicationId String 申请单Id
注意:此字段可能返回 null,表示取不到有效值。

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
MachineType String 机器类型
ProcessSpeed Integer 请求包速度
AverageProcessDelay Integer 请求包时延
SlowProcessSpeed Integer 慢处理包速度

ProxyMachineInfo

proxy机器信息

被如下接口引用:DescribeMachine。

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

RegionInfo

TcaplusDB服务地域信息详情

被如下接口引用:DescribeRegions。

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

SelectedTableInfoNew

被选中的表信息

被如下接口引用:ClearTables, CompareIdlFiles, CreateBackup, CreateTables, DeleteTableIndex, DeleteTables, 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

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

被如下接口引用:SetTableIndex。

名称 类型 必选 描述
TableGroupId String 表所属表格组ID
TableName String 表格名称
TableInstanceId String 表实例ID
TableIdlType String 表格描述语言类型:PROTOTDR
TableType String 表格数据结构类型:GENERICLIST
SelectedFields Array of FieldInfo 待创建索引的字段列表
ShardNum Integer 索引分片数

ServerDetailInfo

server独占机器的详细信息

被如下接口引用:DescribeClusters。

名称 类型 描述
ServerUid String svr唯一id
MachineType String 机器类型
MemoryRate Integer 内存占用量
DiskRate Integer 磁盘占用量
ReadNum Integer 读次数
WriteNum Integer 写次数

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

TableGroupInfo

表格组详细信息

被如下接口引用:DescribeTableGroups。

名称 类型 描述
TableGroupId String 表格组ID
TableGroupName String 表格组名称
CreatedTime Timestamp 表格组创建时间
TableCount Integer 表格组包含的表格数量
TotalSize Integer 表格组包含的表格存储总量(MB)

TableInfoNew

表格详情信息

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

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

TableResultNew

表处理结果信息

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

名称 类型 描述
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,表示取不到有效值。
ApplicationId String 腾讯云申请审核单Id
注意:此字段可能返回 null,表示取不到有效值。

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 任务详情
目录