{ "name": "tcaplusdb", "display_name": "游戏数据库 TcaplusDB", "description": "介绍如何使用API对游戏数据库TcaplusDB进行操作，包括表格组、集群操作等。", "domain": "other", "api_version": "2019-08-23", "endpoint": "tcaplusdb.tencentcloudapi.com", "actions": [ { "name": "ClearTables", "description": "根据给定的表信息，清除表数据。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表所属集群实例ID", "example": "898898" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待清理表信息列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "CompareIdlFiles", "description": "选中目标表格，上传并校验改表文件，返回是否允许修改表格结构的结果。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待修改表格所在集群ID", "example": "187676" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待修改表格列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] }, { "name": "ExistingIdlFiles", "type": "array", "required": false, "description": "选中的已上传IDL文件列表，与NewIdlFiles必选其一", "example": "{}", "item_type": "object", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "文件名称，不包含扩展名", "example": "fieldName" }, { "name": "FileType", "type": "string", "required": true, "description": "数据描述语言（IDL）类型", "example": "1" }, { "name": "FileExtType", "type": "string", "required": true, "description": "文件扩展名", "example": "proto" }, { "name": "FileSize", "type": "integer", "required": true, "description": "文件大小（Bytes）", "example": "137545" }, { "name": "FileId", "type": "integer", "required": false, "description": "文件ID，对于已上传的文件有意义", "example": "243445" }, { "name": "FileContent", "type": "string", "required": false, "description": "文件内容，对于本次新上传的文件有意义", "example": "filecontent" } ] }, { "name": "NewIdlFiles", "type": "array", "required": false, "description": "本次上传IDL文件列表，与ExistingIdlFiles必选其一", "example": "{}", "item_type": "object", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "文件名称，不包含扩展名", "example": "fieldName" }, { "name": "FileType", "type": "string", "required": true, "description": "数据描述语言（IDL）类型", "example": "1" }, { "name": "FileExtType", "type": "string", "required": true, "description": "文件扩展名", "example": "proto" }, { "name": "FileSize", "type": "integer", "required": true, "description": "文件大小（Bytes）", "example": "137545" }, { "name": "FileId", "type": "integer", "required": false, "description": "文件ID，对于已上传的文件有意义", "example": "243445" }, { "name": "FileContent", "type": "string", "required": false, "description": "文件内容，对于本次新上传的文件有意义", "example": "filecontent" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "CreateBackup", "description": "用户创建备份任务", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待创建备份表所属集群ID", "example": "0" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待创建备份表信息列表", "example": "0", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息", "example": "0" } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "CreateCluster", "description": "本接口用于创建TcaplusDB集群", "status": "online", "parameters": [ { "name": "IdlType", "type": "string", "required": true, "description": "集群数据描述语言类型，如：`PROTO`，`TDR`或`MIX`", "example": "TDR" }, { "name": "ClusterName", "type": "string", "required": true, "description": "集群名称，可使用中文或英文字符，最大长度32个字符", "example": "gz测试TDR" }, { "name": "VpcId", "type": "string", "required": true, "description": "集群所绑定的私有网络实例ID，形如：vpc-f49l6u0z", "example": "vpc-kppg4pm1" }, { "name": "SubnetId", "type": "string", "required": true, "description": "集群所绑定的子网实例ID，形如：subnet-pxir56ns", "example": "subnet-3sww53pa" }, { "name": "Password", "type": "string", "required": true, "description": "集群访问密码，必须是a-zA-Z0-9的字符,且必须包含数字和大小写字母", "example": "84ea4cbf06573ED" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "集群标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "tagkey" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagvalue" } ] }, { "name": "Ipv6Enable", "type": "integer", "required": false, "description": "集群是否开启IPv6功能", "example": "0" }, { "name": "ServerList", "type": "array", "required": false, "description": "独占集群占用的svr机器", "example": "无", "item_type": "object", "children": [ { "name": "MachineType", "type": "string", "required": true, "description": "机器类型", "example": "proxy" }, { "name": "MachineNum", "type": "integer", "required": true, "description": "机器数量", "example": "100" } ] }, { "name": "ProxyList", "type": "array", "required": false, "description": "独占集群占用的proxy机器", "example": "无", "item_type": "object", "children": [ { "name": "MachineType", "type": "string", "required": true, "description": "机器类型", "example": "proxy" }, { "name": "MachineNum", "type": "integer", "required": true, "description": "机器数量", "example": "100" } ] }, { "name": "ClusterType", "type": "integer", "required": false, "description": "集群类型1共享2独占", "example": "1" }, { "name": "AuthType", "type": "integer", "required": false, "description": "密码认证类型，0 静态认证， 1 签名认证", "example": "1" } ], "required": [ "IdlType", "ClusterName", "VpcId", "SubnetId", "Password" ] }, { "name": "CreateSnapshots", "description": "构造表格过去时间点的快照", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格所属集群id", "example": "1" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "快照列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "所属表格组ID", "example": "19822" }, { "name": "TableName", "type": "string", "required": true, "description": "表名称", "example": "testname" }, { "name": "SnapshotName", "type": "string", "required": true, "description": "快照名称", "example": "snapshotname" }, { "name": "SnapshotTime", "type": "string", "required": true, "description": "快照时间点", "example": "2023-10-10 10:10:10" }, { "name": "SnapshotDeadTime", "type": "string", "required": true, "description": "快照过期时间点", "example": "2023-10-11 10:10:10" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "CreateTableGroup", "description": "在TcaplusDB集群下创建表格组", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格组所属集群ID", "example": "18744" }, { "name": "TableGroupName", "type": "string", "required": true, "description": "表格组名称，可以采用中文、英文或数字字符，最大长度32个字符", "example": "groupname" }, { "name": "TableGroupId", "type": "string", "required": false, "description": "表格组ID，可以由用户指定，但在同一个集群内不能重复，如果不指定则采用自增的模式", "example": "17565" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "表格组标签列表", "example": "{}", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "tagkey" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagvalue" } ] } ], "required": [ "ClusterId", "TableGroupName" ] }, { "name": "CreateTables", "description": "根据选择的IDL文件列表，批量创建表格", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待创建表格所属集群ID", "example": " 123" }, { "name": "IdlFiles", "type": "array", "required": true, "description": "用户选定的建表格IDL文件列表", "example": " {}", "item_type": "object", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "文件名称，不包含扩展名", "example": "fieldName" }, { "name": "FileType", "type": "string", "required": true, "description": "数据描述语言（IDL）类型", "example": "1" }, { "name": "FileExtType", "type": "string", "required": true, "description": "文件扩展名", "example": "proto" }, { "name": "FileSize", "type": "integer", "required": true, "description": "文件大小（Bytes）", "example": "137545" }, { "name": "FileId", "type": "integer", "required": false, "description": "文件ID，对于已上传的文件有意义", "example": "243445" }, { "name": "FileContent", "type": "string", "required": false, "description": "文件内容，对于本次新上传的文件有意义", "example": "filecontent" } ] }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待创建表格信息列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] }, { "name": "ResourceTags", "type": "array", "required": false, "description": "表格标签列表", "example": "{}", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "tagkey" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagvalue" } ] } ], "required": [ "ClusterId", "IdlFiles", "SelectedTables" ] }, { "name": "DeleteBackupRecords", "description": "删除手工备份", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待删除备份记录的所在集群ID", "example": "5674209986" }, { "name": "BackupRecords", "type": "array", "required": true, "description": "待删除备份记录的详情", "example": "无", "item_type": "object", "children": [ { "name": "ZoneId", "type": "integer", "required": true, "description": "表格组ID", "example": "0" }, { "name": "TableName", "type": "string", "required": true, "description": "表名称", "example": "0" }, { "name": "BackupType", "type": "string", "required": true, "description": "备份源", "example": "0" }, { "name": "FileTag", "type": "string", "required": true, "description": "文件标签：TCAPLUS_FULL或OSDATA", "example": "0" }, { "name": "ShardCount", "type": "integer", "required": true, "description": "分片数量", "example": "0" }, { "name": "BackupBatchTime", "type": "string", "required": true, "description": "备份批次日期", "example": "0" }, { "name": "BackupFileSize", "type": "integer", "required": true, "description": "备份文件汇总大小", "example": "0" }, { "name": "BackupSuccRate", "type": "string", "required": true, "description": "备份成功率", "example": "0" }, { "name": "BackupExpireTime", "type": "string", "required": true, "description": "备份文件过期时间", "example": "0" }, { "name": "AppId", "type": "integer", "required": true, "description": "业务ID", "example": "0" } ] } ], "required": [ "ClusterId", "BackupRecords" ] }, { "name": "DeleteCluster", "description": "删除TcaplusDB集群，必须在集群所属所有资源（包括表格组，表）都已经释放的情况下才会成功。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待删除的集群ID", "example": "18767" } ], "required": [ "ClusterId" ] }, { "name": "DeleteIdlFiles", "description": "指定集群ID和待删除IDL文件的信息，删除目标文件，如果文件正在被表关联则删除失败。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "IDL所属集群ID", "example": "187656" }, { "name": "IdlFiles", "type": "array", "required": true, "description": "待删除的IDL文件信息列表", "example": "{}", "item_type": "object", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "文件名称，不包含扩展名", "example": "fieldName" }, { "name": "FileType", "type": "string", "required": true, "description": "数据描述语言（IDL）类型", "example": "1" }, { "name": "FileExtType", "type": "string", "required": true, "description": "文件扩展名", "example": "proto" }, { "name": "FileSize", "type": "integer", "required": true, "description": "文件大小（Bytes）", "example": "137545" }, { "name": "FileId", "type": "integer", "required": false, "description": "文件ID，对于已上传的文件有意义", "example": "243445" }, { "name": "FileContent", "type": "string", "required": false, "description": "文件内容，对于本次新上传的文件有意义", "example": "filecontent" } ] } ], "required": [ "ClusterId", "IdlFiles" ] }, { "name": "DeleteSnapshots", "description": "删除表格的快照", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格所属集群id", "example": "1" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "删除的快照列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "所属表格组ID", "example": "184232" }, { "name": "TableName", "type": "string", "required": true, "description": "表名称", "example": "testname" }, { "name": "SnapshotName", "type": "string", "required": true, "description": "快照名称", "example": "snapshotname" }, { "name": "SnapshotDeadTime", "type": "string", "required": false, "description": "快照过期时间点", "example": "2020-10-10 10:10:10" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "DeleteTableDataFlow", "description": "删除表格的数据订阅", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格所属集群实例ID", "example": "5674209986" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待删除分布式索引的表格列表", "example": "无", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "DeleteTableGroup", "description": "删除表格组", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格组所属的集群ID", "example": "17568" }, { "name": "TableGroupId", "type": "string", "required": true, "description": "表格组ID", "example": "14234" } ], "required": [ "ClusterId", "TableGroupId" ] }, { "name": "DeleteTableIndex", "description": "删除表格的分布式索引", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格所属集群实例ID", "example": "897858" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待删除分布式索引的表格列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "DeleteTables", "description": "删除指定的表,第一次调用此接口代表将表移动至回收站，再次调用代表将此表格从回收站中彻底删除。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待删除表所在集群ID", "example": "8978978" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待删除表信息列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "DescribeApplications", "description": "获取审批管理的申请单", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID，用于获取指定集群的单据", "example": "10001" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页，限制当前返回多少条记录，大于等于10", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页，从多少条数据开始返回", "example": "12" }, { "name": "CensorStatus", "type": "integer", "required": false, "description": "申请单状态，用于过滤，0-待审核 1-已经审核并提交任务 2-已驳回", "example": "0" }, { "name": "TableGroupId", "type": "string", "required": false, "description": "表格组id，用于过滤", "example": "32424" }, { "name": "TableName", "type": "string", "required": false, "description": "表格名，用于过滤", "example": "testname" }, { "name": "Applicant", "type": "string", "required": false, "description": "申请人uin，用于过滤", "example": "2131" }, { "name": "ApplyType", "type": "integer", "required": false, "description": "申请类型，用于过滤，0加表 1删除表 2清理表 3修改表 4表重建 5存储层扩缩容 6接入层扩缩容 7复制表数据 8key回档", "example": "0" } ], "required": [] }, { "name": "DescribeBackupRecords", "description": "查询备份记录 查询集群级别时， 将TableGroupId设置为\"-1\", 将TableName设置为\"-1\" 查询集群+表格组级别时， 将TableName设置为\"-1\" 查询集群+表格组+表格级别时， 都不能设置为“-1”", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID，用于获取指定集群的单据", "example": "10001" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页", "example": "12" }, { "name": "TableGroupId", "type": "string", "required": false, "description": "表格组id，用于过滤", "example": "7867" }, { "name": "TableName", "type": "string", "required": false, "description": "表格名，用于过滤", "example": "testname" } ], "required": [] }, { "name": "DescribeClusterTags", "description": "获取集群关联的标签列表", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": true, "description": "集群ID列表", "example": "879789", "item_type": "string" } ], "required": [ "ClusterIds" ] }, { "name": "DescribeClusters", "description": "查询TcaplusDB集群列表，包含集群详细信息。", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": false, "description": "指定查询的集群ID列表", "example": "10001", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "查询过滤条件", "example": "{}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤字段名", "example": "\"name\"" }, { "name": "Value", "type": "string", "required": false, "description": "过滤字段值", "example": "\"value\"" }, { "name": "Values", "type": "array", "required": false, "description": "过滤字段值", "example": "[\"value1\", \"value2\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询列表偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询列表返回记录数，默认值20", "example": "0" }, { "name": "Ipv6Enable", "type": "integer", "required": false, "description": "是否启用Ipv6", "example": "0" } ], "required": [] }, { "name": "DescribeIdlFileInfos", "description": "查询表描述文件详情", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "文件所属集群ID", "example": "1876767" }, { "name": "TableGroupIds", "type": "array", "required": false, "description": "文件所属表格组ID", "example": "1214765", "item_type": "string" }, { "name": "IdlFileIds", "type": "array", "required": false, "description": "指定文件ID列表", "example": "testfield", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询列表偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询列表返回记录数", "example": "10" } ], "required": [ "ClusterId" ] }, { "name": "DescribeMachine", "description": "查询独占集群可以申请的剩余机器", "status": "online", "parameters": [ { "name": "Ipv6Enable", "type": "integer", "required": false, "description": "不为0，表示查询支持ipv6的机器", "example": "1" } ], "required": [] }, { "name": "DescribeRegions", "description": "查询TcaplusDB服务支持的地域列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSnapshots", "description": "查询快照列表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格所属集群id", "example": "18685341856" }, { "name": "TableGroupId", "type": "string", "required": false, "description": "所属表格组ID", "example": "1" }, { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "cl_generic" }, { "name": "SnapshotName", "type": "string", "required": false, "description": "快照名称", "example": "SnapshotName" }, { "name": "SelectedTables", "type": "array", "required": false, "description": "批量拉取快照的表格列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId" ] }, { "name": "DescribeTableGroupTags", "description": "获取表格组关联的标签列表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待查询标签表格组所属集群ID", "example": "345332" }, { "name": "TableGroupIds", "type": "array", "required": true, "description": "待查询标签表格组ID列表", "example": "435342", "item_type": "string" } ], "required": [ "ClusterId", "TableGroupIds" ] }, { "name": "DescribeTableGroups", "description": "查询表格组列表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格组所属集群ID", "example": "7867686" }, { "name": "TableGroupIds", "type": "array", "required": false, "description": "表格组ID列表", "example": "\"1\"", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，本接口支持：TableGroupName，TableGroupId", "example": "{}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤字段名", "example": "\"name\"" }, { "name": "Value", "type": "string", "required": false, "description": "过滤字段值", "example": "\"value\"" }, { "name": "Values", "type": "array", "required": false, "description": "过滤字段值", "example": "[\"value1\", \"value2\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询列表偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询列表返回记录数", "example": "0" } ], "required": [ "ClusterId" ] }, { "name": "DescribeTableTags", "description": "获取表格标签", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格所属集群ID", "example": "456546" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "表格列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "DescribeTables", "description": "查询表详情", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": false, "description": "待查询表格所属集群ID", "example": "5674209986" }, { "name": "TableGroupIds", "type": "array", "required": false, "description": "待查询表格所属表格组ID列表", "example": "1", "item_type": "string" }, { "name": "SelectedTables", "type": "array", "required": false, "description": "待查询表格信息列表，用户不用关注，过滤请使用filter", "example": "无", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，本接口支持：TableName，TableInstanceId", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤字段名", "example": "\"name\"" }, { "name": "Value", "type": "string", "required": false, "description": "过滤字段值", "example": "\"value\"" }, { "name": "Values", "type": "array", "required": false, "description": "过滤字段值", "example": "[\"value1\", \"value2\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询结果偏移量", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果返回记录数量", "example": "1" } ], "required": [] }, { "name": "DescribeTablesInRecycle", "description": "查询回收站中的表详情", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": false, "description": "待查询表格所属集群ID", "example": "5456454" }, { "name": "TableGroupIds", "type": "array", "required": false, "description": "待查询表格所属表格组ID列表", "example": "13755", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，本接口支持：TableName，TableInstanceId", "example": "{}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤字段名", "example": "\"name\"" }, { "name": "Value", "type": "string", "required": false, "description": "过滤字段值", "example": "\"value\"" }, { "name": "Values", "type": "array", "required": false, "description": "过滤字段值", "example": "[\"value1\", \"value2\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询结果偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询结果返回记录数量", "example": "0" } ], "required": [] }, { "name": "DescribeTasks", "description": "查询任务列表", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": false, "description": "需要查询任务所属的集群ID列表", "example": "176784", "item_type": "string" }, { "name": "TaskIds", "type": "array", "required": false, "description": "需要查询的任务ID列表", "example": "1345345", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，本接口支持：Content，TaskType, Operator, Time", "example": "{}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤字段名", "example": "\"name\"" }, { "name": "Value", "type": "string", "required": false, "description": "过滤字段值", "example": "\"value\"" }, { "name": "Values", "type": "array", "required": false, "description": "过滤字段值", "example": "[\"value1\", \"value2\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询列表偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询列表返回记录数", "example": "10" } ], "required": [] }, { "name": "DescribeUinInWhitelist", "description": "查询本用户是否在白名单中，控制是否能创建TDR类型的APP或表", "status": "online", "parameters": [], "required": [] }, { "name": "DisableRestProxy", "description": "当restful api为关闭状态时，可以通过此接口关闭restful api", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "对应appid", "example": "4534634" } ], "required": [ "ClusterId" ] }, { "name": "EnableRestProxy", "description": "当restful api为关闭状态时，可以通过此接口开启restful api。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群 ID。", "example": "5674209986" } ], "required": [ "ClusterId" ] }, { "name": "ImportSnapshots", "description": "将快照数据导入到新表或当前表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格所属的集群id", "example": "346673" }, { "name": "Snapshots", "type": "object", "required": true, "description": "用于导入的快照信息", "example": "{}", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "所属表格组ID", "example": "19822" }, { "name": "TableName", "type": "string", "required": true, "description": "表名称", "example": "testname" }, { "name": "SnapshotName", "type": "string", "required": true, "description": "快照名称", "example": "snapshotname" }, { "name": "SnapshotTime", "type": "string", "required": true, "description": "快照时间点", "example": "2023-10-10 10:10:10" }, { "name": "SnapshotDeadTime", "type": "string", "required": true, "description": "快照过期时间点", "example": "2023-10-11 10:10:10" } ] }, { "name": "ImportSpecialKey", "type": "string", "required": true, "description": "是否导入部分记录，TRUE表示导入部分记录，FALSE表示全表导入", "example": "testkey" }, { "name": "ImportOriginTable", "type": "string", "required": true, "description": "是否导入到当前表，TRUE表示导入到当前表，FALSE表示导入到新表", "example": "testname" }, { "name": "KeyFile", "type": "object", "required": false, "description": "部分记录的key文件", "example": "{}", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "key文件名称", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": true, "description": "key文件扩展名", "example": "txt" }, { "name": "FileContent", "type": "string", "required": true, "description": "key文件内容", "example": "filecontent" }, { "name": "FileSize", "type": "integer", "required": false, "description": "key文件大小", "example": "154564" } ] }, { "name": "NewTableGroupId", "type": "string", "required": false, "description": "如果导入到新表，此为新表所属的表格组id", "example": "56336" }, { "name": "NewTableName", "type": "string", "required": false, "description": "如果导入到新表，此为新表的表名，系统会以该名称自动创建一张结构相同的空表", "example": "testnewname" } ], "required": [ "ClusterId", "Snapshots", "ImportSpecialKey", "ImportOriginTable" ] }, { "name": "MergeTablesData", "description": "合并指定表格", "status": "online", "parameters": [ { "name": "SelectedTables", "type": "array", "required": true, "description": "选取的表格", "example": "{}", "item_type": "object", "children": [ { "name": "MergeTables", "type": "object", "required": true, "description": "合服的表格信息", "example": "{}", "children": [ { "name": "SrcTableClusterId", "type": "string", "required": false, "description": "源表格的集群id", "example": "75685" }, { "name": "SrcTableGroupId", "type": "string", "required": false, "description": "源表格的表格组id", "example": "18755" }, { "name": "SrcTableName", "type": "string", "required": false, "description": "源表格的表名", "example": "srcname" }, { "name": "DstTableClusterId", "type": "string", "required": false, "description": "目标表格的集群id", "example": "75685" }, { "name": "DstTableGroupId", "type": "string", "required": false, "description": "目标表格的表格组id", "example": "18755" }, { "name": "DstTableName", "type": "string", "required": false, "description": "目标表格的表名", "example": "dstname" }, { "name": "SrcTableInstanceId", "type": "string", "required": false, "description": "源表格的实例id", "example": "tcap-1232" }, { "name": "DstTableInstanceId", "type": "string", "required": false, "description": "目标表格的实例id", "example": "tcap-2586" } ] }, { "name": "CheckIndex", "type": "boolean", "required": true, "description": "是否检查索引", "example": "false" } ] }, { "name": "IsOnlyCompare", "type": "boolean", "required": true, "description": "true只做对比，false既对比又执行", "example": "false" } ], "required": [ "SelectedTables", "IsOnlyCompare" ] }, { "name": "ModifyCensorship", "description": "修改集群审批状态", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "2143435" }, { "name": "Censorship", "type": "integer", "required": true, "description": "集群是否开启审核 0-关闭 1-开启", "example": "0" }, { "name": "Uins", "type": "array", "required": false, "description": "审批人uin列表", "example": "54654,4544564", "item_type": "string" } ], "required": [ "ClusterId", "Censorship" ] }, { "name": "ModifyClusterMachine", "description": "修改独占集群机器", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "16585" }, { "name": "ServerList", "type": "array", "required": true, "description": "svr占用的机器", "example": "{}", "item_type": "object", "children": [ { "name": "MachineType", "type": "string", "required": true, "description": "机器类型", "example": "proxy" }, { "name": "MachineNum", "type": "integer", "required": true, "description": "机器数量", "example": "100" } ] }, { "name": "ProxyList", "type": "array", "required": true, "description": "proxy占用的机器", "example": "{}", "item_type": "object", "children": [ { "name": "MachineType", "type": "string", "required": true, "description": "机器类型", "example": "proxy" }, { "name": "MachineNum", "type": "integer", "required": true, "description": "机器数量", "example": "100" } ] }, { "name": "ClusterType", "type": "integer", "required": true, "description": "集群类型1共享集群2独占集群", "example": "2" } ], "required": [ "ClusterId", "ServerList", "ProxyList", "ClusterType" ] }, { "name": "ModifyClusterName", "description": "修改指定的集群名称", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "需要修改名称的集群ID", "example": "1865675" }, { "name": "ClusterName", "type": "string", "required": true, "description": "需要修改的集群名称，可使用中文或英文字符，最大长度32个字符", "example": "testname" } ], "required": [ "ClusterId", "ClusterName" ] }, { "name": "ModifyClusterPassword", "description": "修改指定集群的密码，后台将在旧密码失效之前同时支持TcaplusDB SDK使用旧密码和新密码访问数据库。在旧密码失效之前不能提交新的密码修改请求，在旧密码失效之后不能提交修改旧密码过期时间的请求。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "需要修改密码的集群ID", "example": "23311894780" }, { "name": "OldPassword", "type": "string", "required": true, "description": "集群旧密码", "example": "canmkdmk1215LM" }, { "name": "OldPasswordExpireTime", "type": "string", "required": true, "description": "集群旧密码预期失效时间", "example": "2019-08-26%2017%3A25%3A00" }, { "name": "NewPassword", "type": "string", "required": true, "description": "集群新密码，密码必须是a-zA-Z0-9的字符,且必须包含数字和大小写字母", "example": "99c59cb345c61063db" }, { "name": "Mode", "type": "string", "required": false, "description": "更新模式： `1` 更新密码；`2` 更新旧密码失效时间，默认为`1` 模式", "example": "1" } ], "required": [ "ClusterId", "OldPassword", "OldPasswordExpireTime", "NewPassword" ] }, { "name": "ModifyClusterTags", "description": "修改集群标签", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待修改标签的集群ID", "example": "932312" }, { "name": "ReplaceTags", "type": "array", "required": false, "description": "待增加或修改的标签列表", "example": "{}", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "tagkey" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagvalue" } ] }, { "name": "DeleteTags", "type": "array", "required": false, "description": "待删除的标签", "example": "{}", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "tagkey" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagvalue" } ] } ], "required": [ "ClusterId" ] }, { "name": "ModifySnapshots", "description": "修改表格快照的过期时间", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格所属集群id", "example": "1" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "快照列表", "example": "无", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "所属表格组ID", "example": "184232" }, { "name": "TableName", "type": "string", "required": true, "description": "表名称", "example": "testname" }, { "name": "SnapshotName", "type": "string", "required": true, "description": "快照名称", "example": "snapshotname" }, { "name": "SnapshotDeadTime", "type": "string", "required": false, "description": "快照过期时间点", "example": "2020-10-10 10:10:10" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "ModifyTableGroupName", "description": "修改TcaplusDB表格组名称", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表格组所属的集群ID", "example": "1656785" }, { "name": "TableGroupId", "type": "string", "required": true, "description": "待修改名称的表格组ID", "example": "14564" }, { "name": "TableGroupName", "type": "string", "required": true, "description": "新的表格组名称，可以使用中英文字符和符号", "example": "groupname" } ], "required": [ "ClusterId", "TableGroupId", "TableGroupName" ] }, { "name": "ModifyTableGroupTags", "description": "修改表格组标签", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待修改标签表格组所属集群ID", "example": "15474" }, { "name": "TableGroupId", "type": "string", "required": true, "description": "待修改标签表格组ID", "example": "4545" }, { "name": "ReplaceTags", "type": "array", "required": false, "description": "待增加或修改的标签列表", "example": "{}", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "tagkey" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagvalue" } ] }, { "name": "DeleteTags", "type": "array", "required": false, "description": "待删除的标签", "example": "{}", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "tagkey" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagvalue" } ] } ], "required": [ "ClusterId", "TableGroupId" ] }, { "name": "ModifyTableMemos", "description": "修改表备注信息", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表所属集群实例ID", "example": "574845" }, { "name": "TableMemos", "type": "array", "required": true, "description": "选定表详情列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId", "TableMemos" ] }, { "name": "ModifyTableQuotas", "description": "表格扩缩容", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "带扩缩容表所属集群ID", "example": "675656" }, { "name": "TableQuotas", "type": "array", "required": true, "description": "已选中待修改的表配额列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId", "TableQuotas" ] }, { "name": "ModifyTableTags", "description": "修改表格标签", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待修改标签表格所属集群ID", "example": "76784564" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待修改标签表格列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] }, { "name": "ReplaceTags", "type": "array", "required": false, "description": "待增加或修改的标签列表", "example": "{}", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "tagkey" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagvalue" } ] }, { "name": "DeleteTags", "type": "array", "required": false, "description": "待删除的标签列表", "example": "{}", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "tagkey" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "tagvalue" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "ModifyTables", "description": "根据用户选定的表定义IDL文件，批量修改指定的表", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待修改表格所在集群ID", "example": "565335" }, { "name": "IdlFiles", "type": "array", "required": true, "description": "选中的改表IDL文件", "example": "{}", "item_type": "object", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "文件名称，不包含扩展名", "example": "fieldName" }, { "name": "FileType", "type": "string", "required": true, "description": "数据描述语言（IDL）类型", "example": "1" }, { "name": "FileExtType", "type": "string", "required": true, "description": "文件扩展名", "example": "proto" }, { "name": "FileSize", "type": "integer", "required": true, "description": "文件大小（Bytes）", "example": "137545" }, { "name": "FileId", "type": "integer", "required": false, "description": "文件ID，对于已上传的文件有意义", "example": "243445" }, { "name": "FileContent", "type": "string", "required": false, "description": "文件内容，对于本次新上传的文件有意义", "example": "filecontent" } ] }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待改表格列表", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId", "IdlFiles", "SelectedTables" ] }, { "name": "RecoverRecycleTables", "description": "恢复回收站中，用户自行删除的表。对欠费待释放的表无效。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表所在集群ID", "example": "635363" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待恢复表信息", "example": "{}", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "1213" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "testname" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-21312" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "1" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "1" }, { "name": "ListElementNum", "type": "integer", "required": false, "description": "LIST表元素个数", "example": "1024" }, { "name": "ReservedVolume", "type": "integer", "required": false, "description": "表格预留容量（GB）", "example": "1" }, { "name": "ReservedReadQps", "type": "integer", "required": false, "description": "表格预留读CU", "example": "1000" }, { "name": "ReservedWriteQps", "type": "integer", "required": false, "description": "表格预留写CU", "example": "1000" }, { "name": "Memo", "type": "string", "required": false, "description": "表格备注信息", "example": "memo" }, { "name": "FileName", "type": "string", "required": false, "description": "Key回档文件名，回档专用", "example": "filename" }, { "name": "FileExtType", "type": "string", "required": false, "description": "Key回档文件扩展名，回档专用", "example": "txt" }, { "name": "FileSize", "type": "integer", "required": false, "description": "Key回档文件大小，回档专用", "example": "10234" }, { "name": "FileContent", "type": "string", "required": false, "description": "Key回档文件内容，回档专用", "example": "filecontent" } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "SetBackupExpireRule", "description": "新增、删除、修改备份过期策略， ClusterId必须为具体的集群Id（appid）", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表所属集群实例ID", "example": "5674209986" }, { "name": "BackupExpireRules", "type": "array", "required": true, "description": "淘汰策略数组", "example": "无", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "所属表格组ID", "example": "0" }, { "name": "TableName", "type": "string", "required": true, "description": "表名称", "example": "0" }, { "name": "FileTag", "type": "integer", "required": true, "description": "文件标签，见上面描述", "example": "0" }, { "name": "ExpireDay", "type": "integer", "required": true, "description": "淘汰天数，见上面描述", "example": "0" }, { "name": "OperType", "type": "integer", "required": true, "description": "操作类型，见上面描述", "example": "0" } ] } ], "required": [ "ClusterId", "BackupExpireRules" ] }, { "name": "SetTableDataFlow", "description": "新增、修改表格数据订阅", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表所属集群实例ID", "example": "5674209986" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待创建分布式索引表格列表", "example": "无", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "101" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "tb_example" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-1f224454" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "PROTO" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "GENERIC" }, { "name": "SelectedFields", "type": "array", "required": false, "description": "待创建索引、缓写、数据订阅的字段列表", "example": "无", "item_type": "object", "children": [ { "name": "FieldName", "type": "string", "required": true, "description": "表格字段名称", "example": "fieldName" }, { "name": "IsPrimaryKey", "type": "string", "required": true, "description": "字段是否是主键字段", "example": "0" }, { "name": "FieldType", "type": "string", "required": false, "description": "字段类型", "example": "1" }, { "name": "FieldSize", "type": "integer", "required": false, "description": "字段长度", "example": "32012" } ] }, { "name": "ShardNum", "type": "integer", "required": false, "description": "索引分片数", "example": "3" }, { "name": "KafkaInfo", "type": "object", "required": false, "description": "ckafka实例信息", "example": "无", "children": [ { "name": "Address", "type": "string", "required": false, "description": "Kafka address", "example": "ckafka-3azrwxvw.ap-shanghai.ckafka.tencentcloudmq.com:6006" }, { "name": "Topic", "type": "string", "required": false, "description": "Kafka topic", "example": "tcapstream" }, { "name": "User", "type": "string", "required": false, "description": "kafka username", "example": "ckafka-3azrwxvw#tcaplusDev" }, { "name": "Password", "type": "string", "required": false, "description": "kafka password", "example": "tcaplusDev123321" }, { "name": "Instance", "type": "string", "required": false, "description": "ckafka实例", "example": "ckafka-l4xpzgpz" }, { "name": "IsVpc", "type": "integer", "required": false, "description": "是否走VPC", "example": "0" } ] } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "SetTableIndex", "description": "设置表格分布式索引", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "表所属集群实例ID", "example": "5674209986" }, { "name": "SelectedTables", "type": "array", "required": true, "description": "待创建分布式索引表格列表", "example": "无", "item_type": "object", "children": [ { "name": "TableGroupId", "type": "string", "required": true, "description": "表所属表格组ID", "example": "101" }, { "name": "TableName", "type": "string", "required": true, "description": "表格名称", "example": "tb_example" }, { "name": "TableInstanceId", "type": "string", "required": false, "description": "表实例ID", "example": "tcaplus-1f224454" }, { "name": "TableIdlType", "type": "string", "required": false, "description": "表格描述语言类型：`PROTO`或`TDR`", "example": "PROTO" }, { "name": "TableType", "type": "string", "required": false, "description": "表格数据结构类型：`GENERIC`或`LIST`", "example": "GENERIC" }, { "name": "SelectedFields", "type": "array", "required": false, "description": "待创建索引、缓写、数据订阅的字段列表", "example": "无", "item_type": "object", "children": [ { "name": "FieldName", "type": "string", "required": true, "description": "表格字段名称", "example": "fieldName" }, { "name": "IsPrimaryKey", "type": "string", "required": true, "description": "字段是否是主键字段", "example": "0" }, { "name": "FieldType", "type": "string", "required": false, "description": "字段类型", "example": "1" }, { "name": "FieldSize", "type": "integer", "required": false, "description": "字段长度", "example": "32012" } ] }, { "name": "ShardNum", "type": "integer", "required": false, "description": "索引分片数", "example": "3" }, { "name": "KafkaInfo", "type": "object", "required": false, "description": "ckafka实例信息", "example": "无", "children": [ { "name": "Address", "type": "string", "required": false, "description": "Kafka address", "example": "ckafka-3azrwxvw.ap-shanghai.ckafka.tencentcloudmq.com:6006" }, { "name": "Topic", "type": "string", "required": false, "description": "Kafka topic", "example": "tcapstream" }, { "name": "User", "type": "string", "required": false, "description": "kafka username", "example": "ckafka-3azrwxvw#tcaplusDev" }, { "name": "Password", "type": "string", "required": false, "description": "kafka password", "example": "tcaplusDev123321" }, { "name": "Instance", "type": "string", "required": false, "description": "ckafka实例", "example": "ckafka-l4xpzgpz" }, { "name": "IsVpc", "type": "integer", "required": false, "description": "是否走VPC", "example": "0" } ] } ] } ], "required": [ "ClusterId", "SelectedTables" ] }, { "name": "UpdateApply", "description": "更新申请单状态", "status": "online", "parameters": [ { "name": "ApplyStatus", "type": "array", "required": true, "description": "申请单状态", "example": "无", "item_type": "object", "children": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "集群id-申请单id", "example": "1-10001" }, { "name": "ApplicationStatus", "type": "integer", "required": true, "description": "处理状态-1-撤回 1-通过 2-驳回，非0状态的申请单不可改变状态。", "example": "0" }, { "name": "ApplicationType", "type": "integer", "required": true, "description": "申请单类型", "example": "0" }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群Id", "example": "10001" } ] } ], "required": [ "ApplyStatus" ] }, { "name": "VerifyIdlFiles", "description": "上传并校验创建表格文件，返回校验合法的表格定义", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "待创建表格的集群ID", "example": "176567" }, { "name": "TableGroupId", "type": "string", "required": false, "description": "待创建表格的表格组ID", "example": "15452" }, { "name": "ExistingIdlFiles", "type": "array", "required": false, "description": "曾经上传过的IDL文件信息列表，与NewIdlFiles至少有一者", "example": "{}", "item_type": "object", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "文件名称，不包含扩展名", "example": "fieldName" }, { "name": "FileType", "type": "string", "required": true, "description": "数据描述语言（IDL）类型", "example": "1" }, { "name": "FileExtType", "type": "string", "required": true, "description": "文件扩展名", "example": "proto" }, { "name": "FileSize", "type": "integer", "required": true, "description": "文件大小（Bytes）", "example": "137545" }, { "name": "FileId", "type": "integer", "required": false, "description": "文件ID，对于已上传的文件有意义", "example": "243445" }, { "name": "FileContent", "type": "string", "required": false, "description": "文件内容，对于本次新上传的文件有意义", "example": "filecontent" } ] }, { "name": "NewIdlFiles", "type": "array", "required": false, "description": "待上传的IDL文件信息列表，与ExistingIdlFiles至少有一者", "example": "{}", "item_type": "object", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "文件名称，不包含扩展名", "example": "fieldName" }, { "name": "FileType", "type": "string", "required": true, "description": "数据描述语言（IDL）类型", "example": "1" }, { "name": "FileExtType", "type": "string", "required": true, "description": "文件扩展名", "example": "proto" }, { "name": "FileSize", "type": "integer", "required": true, "description": "文件大小（Bytes）", "example": "137545" }, { "name": "FileId", "type": "integer", "required": false, "description": "文件ID，对于已上传的文件有意义", "example": "243445" }, { "name": "FileContent", "type": "string", "required": false, "description": "文件内容，对于本次新上传的文件有意义", "example": "filecontent" } ] } ], "required": [ "ClusterId" ] } ] }