数据结构

最近更新时间:2024-09-11 01:32:55

我的收藏

Account

数据库账号信息

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
User String 账户的名称
示例值:test
Host String 账户的域名
示例值:%

AddShardConfig

升级实例 -- 新增分片类型

被如下接口引用:DescribeDCDBUpgradePrice, UpgradeDCDBInstance, UpgradeDedicatedDCDBInstance, UpgradeHourDCDBInstance。

名称 类型 必选 描述
ShardCount Integer 新增分片的数量
示例值:1
ShardMemory Integer 分片内存大小,单位 GB
示例值:2
ShardStorage Integer 分片存储大小,单位 GB
示例值:10

BackupConfig

数据库超期备份配置

被如下接口引用:DescribeBackupConfigs。

名称 类型 描述
EnableBackupPolicy Boolean 备份策略是否启用。
示例值:true
BeginDate String 超期保留开始日期,早于开始日期的超期备份不保留,格式:yyyy-mm-dd。
示例值:2023-05-30
MaxRetentionDays Integer 超期备份保留时长,超出保留时间的超期备份将被删除,可填写1-3650整数。
示例值:180
Frequency String 备份模式,可选择按年月周模式保存
* 按年:annually
* 按月:monthly
* 按周:weekly
示例值:monthly
WeekDays Array of String Frequency等于weekly时生效。
表示保留特定工作日备份。可选择周一到周日,支持多选,取星期英文:
* 星期一 :Monday
* 星期二 :Tuesday
* 星期三:Wednesday
* 星期四:Thursday
* 星期五:Friday
* 星期六:Saturday
* 星期日:Sunday
示例值:Monday
BackupCount Integer 保留备份个数,Frequency等于monthly或weekly时生效。
备份模式选择按月时,可填写1-28整数;
备份模式选择年时,可填写1-336整数。
示例值:10

BriefNodeInfo

描述分片DB节点信息

被如下接口引用:DescribeDCDBInstanceNodeInfo。

名称 类型 描述
NodeId String DB节点ID
Role String DB节点角色,取值为master或者slave
ShardId String 节点所属分片的分片ID

ColumnPrivilege

列权限信息

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
示例值:test
Table String 数据库表名
示例值:test
Column String 数据库列名
示例值:test
Privileges Array of String 权限信息
示例值:[]

ConfigValue

配置信息。包含配置项Config,配置值Value

被如下接口引用:ModifyAccountConfig。

名称 类型 必选 描述
Config String 配置项的名称,支持填写max_user_connections
示例值:max_user_connections
Value String 配置值
示例值:1024

ConstraintRange

约束类型值的范围

被如下接口引用:DescribeDBParameters。

名称 类型 描述
Min String 约束类型为section时的最小值
Max String 约束类型为section时的最大值

DBAccount

云数据库账号信息

被如下接口引用:DescribeAccounts。

名称 类型 描述
UserName String 用户名
Host String 用户可以从哪台主机登录(对应 MySQL 用户的 host 字段,UserName + Host 唯一标识一个用户,IP形式,IP段以%结尾;支持填入%;为空默认等于%)
Description String 用户备注信息
CreateTime Timestamp 创建时间
UpdateTime Timestamp 最后更新时间
ReadOnly Integer 只读标记,0:否, 1:该账号的sql请求优先选择备机执行,备机不可用时选择主机执行,2:优先选择备机执行,备机不可用时操作失败。
DelayThresh Integer 如果备机延迟超过本参数设置值,系统将认为备机发生故障
建议该参数值大于10。当ReadOnly选择1、2时该参数生效。
SlaveConst Integer 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。
MaxUserConnections Integer 用户最大连接数,0代表无限制

DBParamValue

云数据库参数信息。

被如下接口引用:CreateDCDBInstance, CreateDedicatedClusterDCDBInstance, CreateHourDCDBInstance, InitDCDBInstances, ModifyDBParameters。

名称 类型 必选 描述
Param String 参数名称
Value String 参数值

DCDBInstanceInfo

分布式数据库实例信息

被如下接口引用:DescribeDCDBInstances。

名称 类型 描述
InstanceId String 实例ID
示例值:暂无
InstanceName String 实例名称
示例值:暂无
AppId Integer 应用ID
示例值:暂无
ProjectId Integer 项目ID
示例值:暂无
Region String 地域
示例值:暂无
Zone String 可用区
示例值:暂无
VpcId Integer VPC数字ID
示例值:暂无
SubnetId Integer Subnet数字ID
示例值:暂无
StatusDesc String 状态中文描述
示例值:暂无
Status Integer 实例状态:0 创建中,1 流程处理中, 2 运行中,3 实例未初始化,-1 实例已隔离,4 实例初始化中,5 实例删除中,6 实例重启中,7 数据迁移中
示例值:暂无
Vip String 内网IP
示例值:暂无
Vport Integer 内网端口
示例值:暂无
CreateTime Timestamp 创建时间
示例值:暂无
AutoRenewFlag Integer 自动续费标志
示例值:暂无
Memory Integer 内存大小,单位 GB
示例值:暂无
Storage Integer 存储大小,单位 GB
示例值:暂无
ShardCount Integer 分片个数
示例值:暂无
PeriodEndTime Timestamp 到期时间
示例值:暂无
IsolatedTimestamp Timestamp 隔离时间
示例值:暂无
Uin String 账号ID
示例值:暂无
ShardDetail Array of ShardInfo 分片详情
示例值:暂无
NodeCount Integer 节点数,2 为一主一从, 3 为一主二从
示例值:暂无
IsTmp Integer 临时实例标记,0 为非临时实例
示例值:暂无
ExclusterId String 独享集群ID,为空表示非独享集群实例
示例值:暂无
UniqueVpcId String 字符串型的私有网络ID
示例值:暂无
UniqueSubnetId String 字符串型的私有网络子网ID
示例值:暂无
Id Integer 数字实例ID(过时字段,请勿依赖该值)
示例值:暂无
WanDomain String 外网访问的域名,公网可解析
示例值:暂无
WanVip String 外网 IP 地址,公网可访问
示例值:暂无
WanPort Integer 外网端口
示例值:暂无
Pid Integer 产品类型 ID(过时字段,请勿依赖该值)
示例值:暂无
UpdateTime Timestamp 实例最后更新时间,格式为 2006-01-02 15:04:05
示例值:暂无
DbEngine String 数据库引擎
示例值:暂无
DbVersion String 数据库引擎版本
示例值:暂无
Paymode String 付费模式
示例值:暂无
Locker Integer 实例处于异步任务状态时,表示异步任务流程ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
WanStatus Integer 外网状态,0-未开通;1-已开通;2-关闭;3-开通中
示例值:暂无
IsAuditSupported Integer 该实例是否支持审计。1-支持;0-不支持
示例值:暂无
Cpu Integer Cpu核数
示例值:暂无
Ipv6Flag Integer 实例IPv6标志
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
Vipv6 String 内网IPv6
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
WanVipv6 String 外网IPv6
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
WanPortIpv6 Integer 外网IPv6端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
WanStatusIpv6 Integer 外网IPv6状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
DcnFlag Integer DCN标志,0-无,1-主实例,2-灾备实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
DcnStatus Integer DCN状态,0-无,1-创建中,2-同步中,3-已断开
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
DcnDstNum Integer DCN灾备实例数
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
InstanceType Integer 1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型)
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
ResourceTags Array of ResourceTag 实例标签信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无
DbVersionId String 数据库引擎版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:暂无

DCDBShardInfo

描述分布式数据库分片信息。

被如下接口引用:DescribeDCDBShards。

名称 类型 描述
InstanceId String 所属实例Id
ShardSerialId String 分片SQL透传Id,用于将sql透传到指定分片执行
ShardInstanceId String 全局唯一的分片Id
Status Integer 状态:0 创建中,1 流程处理中, 2 运行中,3 分片未初始化
StatusDesc String 状态中文描述
CreateTime Timestamp 创建时间
VpcId String 字符串格式的私有网络Id
SubnetId String 字符串格式的私有网络子网Id
ProjectId Integer 项目ID
Region String 地域
Zone String 可用区
Memory Integer 内存大小,单位 GB
Storage Integer 存储大小,单位 GB
PeriodEndTime Timestamp 到期时间
NodeCount Integer 节点数,2 为一主一从, 3 为一主二从
StorageUsage Float 存储使用率,单位为 %
MemoryUsage Float 内存使用率,单位为 %
ShardId Integer 数字分片Id(过时字段,请勿依赖该值)
Pid Integer 产品ProductID
ProxyVersion String Proxy版本
Paymode String 付费模型
注意:此字段可能返回 null,表示取不到有效值。
ShardMasterZone String 分片的主可用区
注意:此字段可能返回 null,表示取不到有效值。
ShardSlaveZones Array of String 分片的从可用区列表
注意:此字段可能返回 null,表示取不到有效值。
Cpu Integer CPU核数
Range String 分片ShardKey的范围(总共64个哈希值),例如: 0-31,32-63

Database

数据库信息

被如下接口引用:DescribeDatabases。

名称 类型 描述
DbName String 数据库名称

DatabaseFunction

数据库函数信息

被如下接口引用:DescribeDatabaseObjects。

名称 类型 描述
Func String 函数名称

DatabasePrivilege

数据库权限

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Privileges Array of String 权限信息
示例值:[]
Database String 数据库名
示例值:test

DatabaseProcedure

数据库存储过程信息

被如下接口引用:DescribeDatabaseObjects。

名称 类型 描述
Proc String 存储过程名称

DatabaseTable

数据库表信息

被如下接口引用:DescribeDatabaseObjects。

名称 类型 描述
Table String 表名

DatabaseView

数据库视图信息

被如下接口引用:DescribeDatabaseObjects。

名称 类型 描述
View String 视图名称

DcnDetailItem

DCN详情条目

被如下接口引用:DescribeDcnDetail。

名称 类型 描述
InstanceId String 实例ID
示例值:暂无
InstanceName String 实例名称
示例值:暂无
Region String 实例地域
示例值:暂无
Zone String 实例可用区
示例值:暂无
Vip String 实例IP地址
示例值:暂无
Vipv6 String 实例IPv6地址
示例值:暂无
Vport Integer 实例端口
示例值:暂无
Status Integer 实例状态
示例值:暂无
StatusDesc String 实例状态描述
示例值:暂无
DcnFlag Integer 实例DCN标志,1-主,2-备
示例值:暂无
DcnStatus Integer 实例DCN状态,0-无,1-创建中,2-同步中,3-已断开
示例值:暂无
Cpu Integer 实例CPU核数
示例值:暂无
Memory Integer 实例内存大小,单位 GB
示例值:暂无
Storage Integer 实例存储大小,单位 GB
示例值:暂无
PayMode Integer 付费模式
示例值:暂无
CreateTime String 实例创建时间,格式为 2006-01-02 15:04:05
示例值:暂无
PeriodEndTime String 实例到期时间,格式为 2006-01-02 15:04:05
示例值:暂无
InstanceType Integer 1: 主实例(独享型), 2: 主实例, 3: 灾备实例, 4: 灾备实例(独享型)
示例值:暂无
EncryptStatus Integer 是否开启了 kms
示例值:暂无
DcnStatusDesc String 实例DCN状态描述信息
示例值:暂无
PolarisInstanceId String DCN实例绑定的北极星服务所属的北极星实例Id,若未绑定则为空
示例值:暂无
PolarisInstanceName String DCN实例绑定的北极星服务所属的北极星实例名,若未绑定则为空
示例值:暂无
PolarisNamespace String DCN实例绑定的北极星服务所属的北极星命名空间,若未绑定则为空
示例值:暂无
PolarisService String DCN实例绑定的北极星服务,若未绑定则为空
示例值:暂无
PolarisServiceStatus Integer DCN实例在北极星服务中的状态 0:未开启; 1:已开启; 2:已隔离; 3:切换中
示例值:暂无
PolarisServiceStatusDesc String DCN实例在北极星服务中的状态的描述信息
示例值:暂无
PolarisRegion String 北极星管控地域
示例值:暂无
IsDcnSwitchSupported Integer 是否支持DCN切换
示例值:暂无

Deal

订单信息

被如下接口引用:DescribeOrders。

名称 类型 描述
DealName String 订单号
示例值:20221108006001219915661
OwnerUin String 所属账号
示例值:3078115006
Count Integer 商品数量
示例值:1
FlowId Integer 关联的流程 Id,可用于查询流程执行状态
示例值:68000008
InstanceIds Array of String 只有创建实例且已完成发货的订单会填充该字段,表示该订单创建的实例的 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:["tdsqlshard-c06stiq3"]
PayMode Integer 付费模式,0后付费/1预付费
示例值:0

ExpandShardConfig

升级实例 -- 扩容分片类型

被如下接口引用:DescribeDCDBUpgradePrice, UpgradeDCDBInstance, UpgradeDedicatedDCDBInstance, UpgradeHourDCDBInstance。

名称 类型 必选 描述
ShardInstanceIds Array of String 分片ID数组
示例值:["shard-xxxx"]
ShardMemory Integer 分片内存大小,单位 GB
示例值:2
ShardStorage Integer 分片存储大小,单位 GB
示例值:10
ShardNodeCount Integer 分片节点数
示例值:2

InstanceBackupFileItem

实例备份文件信息

被如下接口引用:DescribeBackupFiles。

名称 类型 描述
InstanceId String 实例ID
示例值:tdsqlshard-xxx
InstanceName String 实例名称
示例值:tdsqlshard-xxx
InstanceStatus Integer 实例状态
示例值:2
ShardId String 分片ID
示例值:shard-xxx
FilePath String 文件路径
示例值:/backup/xxx.lz4
FileName String 文件名
示例值:xxx.lz4
FileSize Integer 文件大小
示例值:1
BackupType String 备份类型,Data:数据备份,Binlog:Binlog备份,Errlog:错误日志,Slowlog:慢日志
示例值:Binlog
ManualBackup Integer 手动备份,0:否,1:是
示例值:0
StartTime String 备份开始时间
示例值:2022-05-10 12:00:00
EndTime String 备份结束时间
示例值:2022-05-10 12:00:00
StorageClass String 对象的存储类型,枚举值:STANDARD(标准存储)、ARCHIVE(归档存储)。
示例值:STANDARD

LogFileInfo

拉取的日志信息

被如下接口引用:DescribeDBLogFiles。

名称 类型 描述
Mtime Integer Log最后修改时间
Length Integer 文件长度
Uri String 下载Log时用到的统一资源标识符
FileName String 文件名

NewBackupConfig

数据库超期备份配置

被如下接口引用:ModifyBackupConfigs。

名称 类型 必选 描述
EnableBackupPolicy Boolean 备份策略是否启用。
示例值:true
BeginDate String 超期保留开始日期,早于开始日期的超期备份不保留,格式:yyyy-mm-dd。
示例值:2023-05-30
MaxRetentionDays Integer 超期备份保留时长,超出保留时间的超期备份将被删除,可填写1-3650整数。
示例值:180
Frequency String 备份模式,可选择按年月周模式保存
* 按年:annually
* 按月:monthly
* 按周:weekly
示例值:monthly
WeekDays Array of String Frequency等于weekly时生效。
表示保留特定工作日备份。可选择周一到周日,支持多选,取星期英文:
* 星期一 :Monday
* 星期二 :Tuesday
* 星期三:Wednesday
* 星期四:Thursday
* 星期五:Friday
* 星期六:Saturday
* 星期日:Sunday
示例值:Monday
BackupCount Integer 保留备份个数,Frequency等于monthly或weekly时生效。
备份模式选择按月时,可填写1-28整数;
备份模式选择年时,可填写1-336整数。
示例值:10

NodeInfo

描述DB节点信息

被如下接口引用:DescribeDCDBInstanceDetail。

名称 类型 描述
NodeId String DB节点ID
Role String DB节点角色,取值为master或者slave

ParamConstraint

参数约束

被如下接口引用:DescribeDBParameters。

名称 类型 描述
Type String 约束类型,如枚举enum,区间section
Enum String 约束类型为enum时的可选值列表
Range ConstraintRange 约束类型为section时的范围
注意:此字段可能返回 null,表示取不到有效值。
String String 约束类型为string时的可选值列表

ParamDesc

DB参数描述

被如下接口引用:DescribeDBParameters。

名称 类型 描述
Param String 参数名字
示例值:long_query_time
Value String 当前参数值
示例值:1
SetValue String 设置过的值,参数生效后,该值和value一样。未设置过就不返回该字段。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
Default String 系统默认值
示例值:1
Constraint ParamConstraint 参数限制
HaveSetValue Boolean 是否有设置过值,false:没有设置过值,true:有设置过值。
示例值:true
NeedRestart Boolean 是否需要重启生效,false:不需要重启,
true:需要重启
示例值:false

ParamModifyResult

修改参数结果

被如下接口引用:ModifyDBParameters。

名称 类型 描述
Param String 修改参数名字
Code Integer 参数修改结果。0表示修改成功;-1表示修改失败;-2表示该参数值非法

Project

项目信息描述

被如下接口引用:DescribeProjects。

名称 类型 描述
ProjectId Integer 项目ID
OwnerUin Integer 资源拥有者(主账号)uin
AppId Integer 应用Id
Name String 项目名称
CreatorUin Integer 创建者uin
SrcPlat String 来源平台
SrcAppId Integer 来源AppId
Status Integer 项目状态,0正常,-1关闭。默认项目为3
CreateTime Timestamp 创建时间
IsDefault Integer 是否默认项目,1 是,0 不是
Info String 描述信息

RegionInfo

售卖可用区信息

被如下接口引用:DescribeDCDBSaleInfo。

名称 类型 描述
Region String 地域英文ID
RegionId Integer 地域数字ID
RegionName String 地域中文名
ZoneList Array of ZonesInfo 可用区列表
AvailableChoice Array of ShardZoneChooseInfo 可选择的主可用区和从可用区

ReservedNetResource

保留的网络资源信息

被如下接口引用:DescribeDCDBInstanceDetail。

名称 类型 描述
VpcId String 私有网络
示例值:vpc-1iy15ozp
SubnetId String 子网
示例值:subnet-l9bprnz2
Vip String VpcId,SubnetId下保留的内网ip
示例值:10.107.76.25
Vports Array of Integer Vip下的端口
示例值:[3306,3307]
RecycleTime String Vip的回收时间
示例值:2023-02-23 10:36:17

ResourceTag

标签对象,包含tagKey & tagValue

被如下接口引用:CreateDCDBInstance, CreateDedicatedClusterDCDBInstance, CreateHourDCDBInstance, DescribeDCDBInstanceDetail, DescribeDCDBInstances。

名称 类型 必选 描述
TagKey String 标签键key
TagValue String 标签值value

SecurityGroup

安全组详情

被如下接口引用:DescribeDBSecurityGroups, DescribeProjectSecurityGroups。

名称 类型 描述
ProjectId Integer 项目ID
CreateTime String 创建时间,时间格式:yyyy-mm-dd hh:mm:ss
SecurityGroupId String 安全组ID
SecurityGroupName String 安全组名称
SecurityGroupRemark String 安全组备注
Inbound Array of SecurityGroupBound 入站规则
Outbound Array of SecurityGroupBound 出站规则

SecurityGroupBound

安全出入口规则

被如下接口引用:DescribeDBSecurityGroups, DescribeProjectSecurityGroups。

名称 类型 描述
CidrIp String 来源 IP 或 IP 段,例如192.168.0.0/16
Action String 策略,ACCEPT 或者 DROP
PortRange String 端口
IpProtocol String 网络协议,支持 UDP、TCP 等

ShardBriefInfo

DCDB分片信息

被如下接口引用:DescribeDCDBInstanceDetail。

名称 类型 描述
ShardSerialId String 分片SerialId
示例值:set_1612751240_1
ShardInstanceId String 分片ID,形如shard-7vg1o339
示例值:shard-lbt0utcz
Status Integer 分片运行状态
示例值:2
StatusDesc String 分片运行状态描述
示例值:运行中
CreateTime Timestamp 分片创建时间
示例值:2021-02-08 10:25:08
Memory Integer 分片内存大小,单位GB
示例值:2
Storage Integer 分片磁盘大小,单位GB
示例值:10
LogDisk Integer 分片日志磁盘空间大小,单位GB
示例值:8
NodeCount Integer 分片节点个数
示例值:3
StorageUsage Float 分片磁盘空间使用率
示例值:0.007
ProxyVersion String 分片Proxy版本信息
示例值:1.14.63-M-V2R667D003
ShardMasterZone String 分片主DB可用区
示例值:ap-guangzhou-1
ShardSlaveZones Array of String 分片从DB可用区
示例值:["ap-guangzhou-1", "ap-guangzhou-2"]
Cpu Integer 分片Cpu核数
示例值:1
NodesInfo Array of NodeInfo DB节点信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:null

ShardInfo

分片信息

被如下接口引用:DescribeDCDBInstances。

名称 类型 描述
ShardInstanceId String 分片ID
ShardSerialId String 分片Set ID
Status Integer 状态:0 创建中,1 流程处理中, 2 运行中,3 分片未初始化,-2 分片已删除
Createtime String 创建时间
Memory Integer 内存大小,单位 GB
Storage Integer 存储大小,单位 GB
ShardId Integer 分片数字ID
NodeCount Integer 节点数,2 为一主一从, 3 为一主二从
Pid Integer 产品类型 Id(过时字段,请勿依赖该值)
Cpu Integer Cpu核数

ShardZoneChooseInfo

分片节点可用区选择

被如下接口引用:DescribeDCDBSaleInfo。

名称 类型 描述
MasterZone ZonesInfo 主可用区
SlaveZones Array of ZonesInfo 可选的从可用区

SlowLogData

慢查询条目信息

被如下接口引用:DescribeDBSlowLogs。

名称 类型 描述
CheckSum String 语句校验和,用于查询详情
Db String 数据库名称
FingerPrint String 抽象的SQL语句
LockTimeAvg String 平均的锁时间
LockTimeMax String 最大锁时间
LockTimeMin String 最小锁时间
LockTimeSum String 锁时间总和
QueryCount String 查询次数
QueryTimeAvg String 平均查询时间
QueryTimeMax String 最大查询时间
QueryTimeMin String 最小查询时间
QueryTimeSum String 查询时间总和
RowsExaminedSum String 扫描行数
RowsSentSum String 发送行数
TsMax String 最后执行时间
TsMin String 首次执行时间
User String 账号
ExampleSql String 样例Sql
注意:此字段可能返回 null,表示取不到有效值。
Host String 账户的域名
注意:此字段可能返回 null,表示取不到有效值。
示例值:%

SpecConfig

按机型分类的规格配置

被如下接口引用:DescribeShardSpec。

名称 类型 描述
Machine String 规格机型
SpecConfigInfos Array of SpecConfigInfo 规格列表

SpecConfigInfo

实例可售卖规格详细信息,创建实例和扩容实例时 NodeCount、Memory 确定售卖规格,硬盘大小可用区间为[MinStorage,MaxStorage]

被如下接口引用:DescribeShardSpec。

名称 类型 描述
NodeCount Integer 节点个数,2 表示一主一从,3 表示一主二从
Memory Integer 内存大小,单位 GB
MinStorage Integer 数据盘规格最小值,单位 GB
MaxStorage Integer 数据盘规格最大值,单位 GB
SuitInfo String 推荐的使用场景
Pid Integer 产品类型 Id
Qps Integer 最大 Qps 值
Cpu Integer CPU核数

SplitShardConfig

升级实例 -- 切分分片类型

被如下接口引用:DescribeDCDBUpgradePrice, UpgradeDCDBInstance, UpgradeDedicatedDCDBInstance, UpgradeHourDCDBInstance。

名称 类型 必选 描述
ShardInstanceIds Array of String 分片ID数组
示例值:["shard-xxxx"]
SplitRate Integer 数据切分比例,固定50%
示例值:50
ShardMemory Integer 分片内存大小,单位 GB
示例值:2
ShardStorage Integer 分片存储大小,单位 GB
示例值:10

TableColumn

数据库列信息

被如下接口引用:DescribeDatabaseTable。

名称 类型 描述
Col String 列名称
Type String 列类型

TablePrivilege

数据库表权限

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
示例值:test
Table String 数据库表名
示例值:test
Privileges Array of String 权限信息
示例值:['SELECT']

Tag

标签

被如下接口引用:DescribeDCDBInstances。

名称 类型 必选 描述
TagKey String 标签键
示例值:name
TagValue String 标签值
示例值:liu

TmpInstance

临时实例

被如下接口引用:DescribeDBTmpInstances。

名称 类型 描述
AppId Integer 应用ID
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Timestamp 创建时间
注意:此字段可能返回 null,表示取不到有效值。
InstanceRemark String 实例备注
注意:此字段可能返回 null,表示取不到有效值。
TempType Integer 0:非临时实例 ,1:无效临时实例, 2:回档成功的有效临时实例
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 实例状态,0:待初始化,1:流程处理中,2:有效状态,-1:已隔离,-2:已下线
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 实例 ID,形如:tdsql-ow728lmc。
注意:此字段可能返回 null,表示取不到有效值。
Vip String 实例虚IP
注意:此字段可能返回 null,表示取不到有效值。
Vport Integer 实例虚端口
注意:此字段可能返回 null,表示取不到有效值。
PeriodEndTime Timestamp 有效期结束时间
注意:此字段可能返回 null,表示取不到有效值。
SrcInstanceId String 源实例 ID,形如:tdsql-ow728lmc。
注意:此字段可能返回 null,表示取不到有效值。
StatusDesc String 实例状态描述
注意:此字段可能返回 null,表示取不到有效值。
Region String 实例所在地域
注意:此字段可能返回 null,表示取不到有效值。
Zone String 实例所在可用区
注意:此字段可能返回 null,表示取不到有效值。
Vipv6 String 实例虚IPv6
注意:此字段可能返回 null,表示取不到有效值。
Ipv6Flag Integer 实例IPv6标志
注意:此字段可能返回 null,表示取不到有效值。

UserTaskInfo

用户任务信息

被如下接口引用:DescribeUserTasks。

名称 类型 描述
Id Integer 任务ID
AppId Integer 用户账户ID
Status Integer 任务状态,0-任务初始化中;1-任务运行中;2-任务成功;3-任务失败
UserTaskType Integer 任务类型,0-实例回档;1-实例创建;2-实例扩容;3-实例迁移;4-实例删除;5-实例重启
CreateTime Timestamp 任务创建时间
EndTime Timestamp 任务结束时间
ErrMsg String 任务错误信息
InputData String 客户端参数
InstanceId String 实例ID
InstanceName String 实例名称
RegionId Integer 地域ID

ViewPrivileges

视图权限信息

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
示例值:test
View String 数据库视图名
示例值:test
Privileges Array of String 权限信息
示例值:[]

ZonesInfo

可用区信息

被如下接口引用:DescribeDCDBSaleInfo。

名称 类型 描述
Zone String 可用区英文ID
示例值:ap-guangzhou-1
ZoneId Integer 可用区数字ID
示例值:100001
ZoneName String 可用区中文名
示例值:广州一区
OnSale Boolean 是否在售
示例值:true