文档中心 游戏数据库 TcaplusDB API 文档 数据结构

数据结构

最近更新时间：2020-02-26 16:35:19

查看pdf

在这篇文章中：

ClusterInfo

集群详细信息

被如下接口引用：DescribeClusters。

名称 类型 描述
ClusterName String 集群名称
ClusterId String 集群ID
Region String 集群所在地域
IdlType String 集群数据描述语言类型，如：PROTO,TDR或MIX
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，表示取不到有效值。

ErrorInfo

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

被如下接口引用：ClearTables、CompareIdlFiles、CreateTables、DeleteIdlFiles、DeleteTables、DescribeTables、DescribeTablesInRecycle、ModifyTableMemos、ModifyTableQuotas、ModifyTables、RecoverRecycleTables、RollbackTables、VerifyIdlFiles。

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

Filter

过滤条件

被如下接口引用：DescribeClusters、DescribeTableGroups、DescribeTables、DescribeTablesInRecycle、DescribeTasks。

名称 类型 必选 描述
Name String 是 过滤字段名
Value 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，表示取不到有效值。

ParsedTableInfoNew

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

被如下接口引用：CompareIdlFiles、VerifyIdlFiles。

名称 类型 描述
TableIdlType String 表格描述语言类型：PROTO或TDR
注意：此字段可能返回 null，表示取不到有效值。
TableInstanceId String 表格实例ID
注意：此字段可能返回 null，表示取不到有效值。
TableName String 表格名称
注意：此字段可能返回 null，表示取不到有效值。
TableType String 表格数据结构类型：GENERIC或LIST
注意：此字段可能返回 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，表示取不到有效值。

RegionInfo

TcaplusDB服务地域信息详情

被如下接口引用：DescribeRegions。

名称 类型 描述
RegionName String 地域Ap-Code
RegionAbbr String 地域缩写
RegionId Integer 地域ID

SelectedTableInfoNew

被选中的表信息

被如下接口引用：ClearTables、CompareIdlFiles、CreateBackup、CreateTables、DeleteTables、DescribeTables、ModifyTableMemos、ModifyTableQuotas、ModifyTables、RecoverRecycleTables、RollbackTables。

名称 类型 必选 描述
TableGroupId String 是 表所属表格组ID
TableName String 是 表格名称
TableInstanceId String 否 表实例ID
TableIdlType String 否 表格描述语言类型：PROTO或TDR
TableType String 否 表格数据结构类型：GENERIC或LIST
ListElementNum Integer 否 LIST表元素个数
ReservedVolume Integer 否 表格预留容量（GB）
ReservedReadQps Integer 否 表格预留读QPS
ReservedWriteQps Integer 否 表格预留写QPS
Memo String 否 表格备注信息
FileName String 否 Key回档文件名，回档专用
FileExtType String 否 Key回档文件扩展名，回档专用
FileSize Integer 否 Key回档文件大小，回档专用
FileContent String 否 Key回档文件内容，回档专用

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 表格数据结构类型，如：GENERIC或LIST
注意：此字段可能返回 null，表示取不到有效值。
TableIdlType String 表格数据描述语言（IDL）类型，如：PROTO或TDR
注意：此字段可能返回 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 表格预留读QPS
注意：此字段可能返回 null，表示取不到有效值。
ReservedWriteQps Integer 表格预留写QPS
注意：此字段可能返回 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，表示取不到有效值。

TableResultNew

表处理结果信息

被如下接口引用：ClearTables、CreateTables、DeleteTables、ModifyTableMemos、ModifyTableQuotas、ModifyTables、RecoverRecycleTables。

名称 类型 描述
TableInstanceId String 表格实例ID，形如：tcaplus-3be64cbb
注意：此字段可能返回 null，表示取不到有效值。
TaskId String 任务ID，对于创建单任务的接口有效
注意：此字段可能返回 null，表示取不到有效值。
TableName String 表格名称
注意：此字段可能返回 null，表示取不到有效值。
TableType String 表格数据结构类型，如：GENERIC或LIST
注意：此字段可能返回 null，表示取不到有效值。
TableIdlType String 表数据描述语言（IDL）类型，如：PROTO或TDR
注意：此字段可能返回 null，表示取不到有效值。
TableGroupId String 表格所属表格组ID
注意：此字段可能返回 null，表示取不到有效值。
Error ErrorInfo 错误信息
注意：此字段可能返回 null，表示取不到有效值。
TaskIds Array of String 任务ID列表，对于创建多任务的接口有效
注意：此字段可能返回 null，表示取不到有效值。

TableRollbackResultNew

表格回档结果信息

被如下接口引用：RollbackTables。

名称 类型 描述
TableInstanceId String 表格实例ID，形如：tcaplus-3be64cbb
注意：此字段可能返回 null，表示取不到有效值。
TaskId String 任务ID，对于创建单任务的接口有效
注意：此字段可能返回 null，表示取不到有效值。
TableName String 表格名称
注意：此字段可能返回 null，表示取不到有效值。
TableType String 表格数据结构类型，如：GENERIC或LIST
注意：此字段可能返回 null，表示取不到有效值。
TableIdlType String 表格数据描述语言（IDL）类型，如：PROTO或TDR
注意：此字段可能返回 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，表示取不到有效值。

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

游戏数据库 TcaplusDB 相关文档