云数据库 MariaDB
开发与运维产品文档捉虫活动邀您参加！> HOT
文档中心>云数据库 MariaDB>API 文档>数据结构

数据结构

最近更新时间：2024-12-25 01:47:09

我的收藏

本页目录：

Account

数据库账号信息

被如下接口引用：ModifyAccountPrivileges。

名称 类型 必选 描述
User String 是 账户的名称
示例值：db_user
Host String 是 账户的域名
示例值：%

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

ColumnPrivilege

列权限信息

被如下接口引用：ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 是 数据库名
示例值：pre_oss
Table String 是 数据库表名
示例值：work_flow
Column String 是 数据库列名
示例值：input
Privileges Array of String 是 权限信息
示例值：["SELECT", "ALTER","CREATE"]

ConstraintRange

约束类型值的范围

被如下接口引用：DescribeDBParameters。

名称 类型 描述
Min String 约束类型为section时的最小值
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
Max String 约束类型为section时的最大值
注意：此字段可能返回 null，表示取不到有效值。
示例值：65535

DBAccount

云数据库账号信息

被如下接口引用：DescribeAccounts。

名称 类型 描述
UserName String 用户名
示例值：oss_user
Host String 用户可以从哪台主机登录（对应 MySQL 用户的 host 字段，UserName + Host 唯一标识一个用户，IP形式，IP段以%结尾；支持填入%；为空默认等于%）
示例值：%
Description String 用户备注信息
示例值：oss测试账号
CreateTime Timestamp 创建时间
示例值：2024-11-19 15:04:00
UpdateTime Timestamp 最后更新时间
示例值：2024-11-19 15:05:00
ReadOnly Integer 只读标记，0：否， 1：该账号的sql请求优先选择备机执行，备机不可用时选择主机执行，2：优先选择备机执行，备机不可用时操作失败。
示例值：2
DelayThresh Integer 该字段对只读账号有意义，表示选择主备延迟小于该值的备机
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
SlaveConst Integer 针对只读账号，设置策略是否固定备机，0：不固定备机，即备机不满足条件与客户端不断开连接，Proxy选择其他可用备机，1：备机不满足条件断开连接，确保一个连接固定备机。
示例值：0
MaxUserConnections Integer 用户最大连接数，0代表无限制
示例值：1000

DBBackupTimeConfig

云数据库实例备份时间配置信息

被如下接口引用：DescribeBackupTime。

名称 类型 描述
InstanceId String 实例 ID
示例值：tdsql-fortdsql
StartBackupTime String 每天备份执行的区间的开始时间，格式 mm:ss，形如 22:00
示例值：22:00
EndBackupTime String 每天备份执行的区间的结束时间，格式 mm:ss，形如 23:00
示例值：23:00

DBInstance

描述云数据库实例的详细信息。

被如下接口引用：DescribeDBInstances。

名称 类型 描述
InstanceId String 实例 ID，唯一标识一个 TDSQL 实例
示例值：tdsql-qs2bd7qb
InstanceName String 实例名称，用户可修改
示例值：billing_item
AppId Integer 实例所属应用 ID
示例值：1253044601
ProjectId Integer 实例所属项目 ID
示例值：10243
Region String 实例所在地域名称，如 ap-shanghai
示例值：ap-guangzhou
Zone String 实例所在可用区名称，如 ap-shanghai-1
示例值：ap-guangzhou-3
VpcId Integer 私有网络 ID，基础网络时为 0
示例值：8554331
SubnetId Integer 子网 ID，基础网络时为 0
示例值：1024106
Status Integer 实例状态：0 创建中，1 流程处理中， 2 运行中，3 实例未初始化，-1 实例已隔离，4 实例初始化中，5 实例删除中，6 实例重启中，7 数据迁移中
示例值：2
Vip String 内网 IP 地址
示例值：10.2.4.19
Vport Integer 内网端口
示例值：3306
WanDomain String 外网访问的域名，公网可解析
示例值：gz.tdsql-qs2bd7qb.sql.tencentcdb.com
WanVip String 外网 IP 地址，公网可访问
示例值：22.1.*
WanPort Integer 外网端口
示例值：24450
CreateTime Timestamp 实例创建时间，格式为 2006-01-02 15:04:05
示例值：2024-11-07 14:53:53
UpdateTime Timestamp 实例最后更新时间，格式为 2006-01-02 15:04:05
示例值：2024-11-07 14:53:53
AutoRenewFlag Integer 自动续费标志：0 否，1 是
示例值：1
PeriodEndTime Timestamp 实例到期时间，格式为 2006-01-02 15:04:05
示例值：2024-12-07 14:53:53
Uin String 实例所属账号
示例值：3372036805
TdsqlVersion String TDSQL 版本信息
示例值：基于MySQL 8.0设计(兼容Mysql 8.0)
Memory Integer 实例内存大小，单位 GB
示例值：32
Storage Integer 实例存储大小，单位 GB
示例值：300
UniqueVpcId String 字符串型的私有网络ID
示例值：subnet-g24it74w
UniqueSubnetId String 字符串型的私有网络子网ID
示例值：vpc-g24it74w
OriginSerialId String 原始实例ID（过时字段，请勿依赖该值）
示例值：set_1728632901_1953969
NodeCount Integer 节点数，2为一主一从，3为一主二从
示例值：4
IsTmp Integer 是否临时实例，0为否，非0为是
示例值：0
ExclusterId String 独享集群ID，为空表示为普通实例
示例值：dbdc-tdsql589
Id Integer 数字实例ID（过时字段，请勿依赖该值）
示例值：15168
Pid Integer 产品类型 ID
示例值：1002231
Qps Integer 最大 Qps 值
示例值：2100
Paymode String 付费模式
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
Locker Integer 实例处于异步任务时的异步任务流程ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
StatusDesc String 实例目前运行状态描述
注意：此字段可能返回 null，表示取不到有效值。
示例值：运行中
WanStatus Integer 外网状态，0-未开通；1-已开通；2-关闭；3-开通中
示例值：1
IsAuditSupported Integer 该实例是否支持审计。1-支持；0-不支持
示例值：1
Machine String 机器型号
示例值：SH12
IsEncryptSupported Integer 是否支持数据加密。1-支持；0-不支持
示例值：1
Cpu Integer 实例CPU核数
示例值：4
Ipv6Flag Integer 实例IPv6标志
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
Vipv6 String 内网IPv6
注意：此字段可能返回 null，表示取不到有效值。
示例值：240d:c000:f05f:b200:f200:b20f
WanVipv6 String 外网IPv6
注意：此字段可能返回 null，表示取不到有效值。
示例值：140f:c010:*
WanPortIpv6 Integer 外网IPv6端口
注意：此字段可能返回 null，表示取不到有效值。
示例值：24450
WanStatusIpv6 Integer 外网IPv6状态
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
DbEngine String 数据库引擎
注意：此字段可能返回 null，表示取不到有效值。
示例值：MySQL
DbVersion String 数据库版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：8.0
DcnFlag Integer DCN标志，0-无，1-主实例，2-灾备实例
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
DcnStatus Integer DCN状态，0-无，1-创建中，2-同步中，3-已断开
注意：此字段可能返回 null，表示取不到有效值。
示例值：2
DcnDstNum Integer DCN灾备实例数
注意：此字段可能返回 null，表示取不到有效值。
示例值：2
InstanceType Integer 1： 主实例（独享型）, 2: 主实例, 3： 灾备实例, 4： 灾备实例（独享型）
注意：此字段可能返回 null，表示取不到有效值。
示例值：2
ResourceTags Array of ResourceTag 实例标签信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：[{"TagKey":"qta_tdsql54","TagValue":"other54"},{"TagKey":"qta_tdsql50","TagValue":"other50"}]
DbVersionId String 数据库版本
注意：此字段可能返回 null，表示取不到有效值。
示例值：8.0

DBParamValue

云数据库参数信息。

被如下接口引用：CreateDBInstance, CreateDedicatedClusterDBInstance, CreateHourDBInstance, InitDBInstances, ModifyDBParameters。

名称 类型 必选 描述
Param String 是 参数名称
示例值：autocommit
Value String 是 参数值
示例值：ON

DCNReplicaConfig

dcn 配置情况

被如下接口引用：DescribeDBInstanceDetail, DescribeDcnDetail。

名称 类型 描述
RoReplicationMode String DCN 运行状态，START为正常运行，STOP为暂停
注意：此字段可能返回 null，表示取不到有效值。
示例值：START
DelayReplicationType String 延迟复制的类型，DEFAULT为正常，DUE_TIME为指定时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：DEFAULT
DueTime String 延迟复制的指定时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2006-01-02 15:04:05
ReplicationDelay Integer 延迟复制时的延迟秒数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

DCNReplicaStatus

DCN的状态信息

被如下接口引用：DescribeDBInstanceDetail, DescribeDcnDetail。

名称 类型 描述
Status String DCN 的运行状态，START为正常运行，STOP为暂停，
注意：此字段可能返回 null，表示取不到有效值。
示例值：START
Delay Integer 当前延迟情况，取备实例的 master 节点的 delay 值
示例值：1

Database

数据库信息

被如下接口引用：DescribeDatabases。

名称 类型 描述
DbName String 数据库名称
示例值：pre_oss

DatabaseFunction

数据库函数信息

被如下接口引用：DescribeDatabaseObjects。

名称 类型 描述
Func String 函数名称
示例值：CountProc2

DatabasePrivilege

数据库权限

被如下接口引用：ModifyAccountPrivileges。

名称 类型 必选 描述
Privileges Array of String 是 权限信息
示例值：["ALTER", "INSERT", "CREATE", "SHOW VIEW"]
Database String 是 数据库名
示例值：pre_oss

DatabaseProcedure

数据库存储过程信息

被如下接口引用：DescribeDatabaseObjects。

名称 类型 描述
Proc String 存储过程名称
示例值：proc_tst

DatabaseTable

数据库表信息

被如下接口引用：DescribeDatabaseObjects。

名称 类型 描述
Table String 表名
示例值：bpmn_info

DatabaseView

数据库视图信息

被如下接口引用：DescribeDatabaseObjects。

名称 类型 描述
View String 视图名称
示例值：v_bpmn

DcnDetailItem

DCN详情条目

被如下接口引用：DescribeDcnDetail。

名称 类型 描述
InstanceId String 实例ID
示例值：tdsql-jk8as7yt
InstanceName String 实例名称
示例值：jk8as7yt-dcn
Region String 实例地域
示例值：ap-guangzhou
Zone String 实例可用区
示例值：ap-guangzhou-3
Vip String 实例IP地址
示例值：10.4.3.12
Vipv6 String 实例IPv6地址
示例值：240d:c000:f05f:b200:f200:b20f
Vport Integer 实例端口
示例值：3306
Status Integer 实例状态
示例值：2
StatusDesc String 实例状态描述
示例值：运行中
DcnFlag Integer 实例DCN标志，1-主，2-备
示例值：2
DcnStatus Integer 实例DCN状态，0-无，1-创建中，2-同步中，3-已断开
示例值：2
Cpu Integer 实例CPU核数
示例值：8
Memory Integer 实例内存大小，单位 GB
示例值：64
Storage Integer 实例存储大小，单位 GB
示例值：300
PayMode Integer 付费模式
示例值：1
CreateTime String 实例创建时间，格式为 2006-01-02 15:04:05
示例值：2024-11-19 15:44:03
PeriodEndTime String 实例到期时间，格式为 2006-01-02 15:04:05
示例值：2024-12-19 15:44:03
InstanceType Integer 1： 主实例（独享型）, 2: 主实例, 3： 灾备实例, 4： 灾备实例（独享型）
示例值：3
ReplicaConfig DCNReplicaConfig DCN复制的配置信息；对于主实例，此字段为null
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"DelayReplicationType":"DEFAULT","DueTime":"","ReplicationDelay":0,"RoReplicationMode":"START"}
ReplicaStatus DCNReplicaStatus DCN复制的状态；对于主实例，此字段为null
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"Delay":0,"Status":"RUNNING"}
EncryptStatus Integer 是否开启了 kms
示例值：0
DcnStatusDesc String 实例DCN状态描述信息
示例值：同步中
PolarisInstanceId String DCN实例绑定的北极星服务所属的北极星实例Id，若未绑定则为空
示例值：ins-e4f68d96
PolarisInstanceName String DCN实例绑定的北极星服务所属的北极星实例名，若未绑定则为空
示例值：ins-e4f68d96
PolarisNamespace String DCN实例绑定的北极星服务所属的北极星命名空间，若未绑定则为空
示例值：default
PolarisService String DCN实例绑定的北极星服务，若未绑定则为空
示例值：tdsql-pre-service
PolarisServiceStatus Integer DCN实例在北极星服务中的状态 0:未开启; 1:已开启; 2:已隔离; 3:切换中
示例值：1
PolarisServiceStatusDesc String DCN实例在北极星服务中的状态的描述信息
示例值：同步中
PolarisRegion String 北极星管控地址
示例值：ap-guangzhou
IsDcnSwitchSupported Integer 是否支持DCN切换
示例值：1

Deal

订单信息

被如下接口引用：DescribeOrders。

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

FunctionPrivilege

函数权限信息

被如下接口引用：ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 是 数据库名
示例值：pre_oss
FunctionName String 是 数据库函数名
示例值：work_func
Privileges Array of String 是 权限信息
示例值：["EXECUTE"]

InstanceBackupFileItem

实例备份文件信息

被如下接口引用：DescribeBackupFiles。

名称 类型 描述
InstanceId String 实例ID
示例值：tdsql-xxx
InstanceName String 实例名称
示例值：tdsql-xxx
InstanceStatus Integer 实例状态
示例值：2
ShardId String 分片ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：shard-54s3xede
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

InstanceSpec

按机型归类的实例可售卖规格信息

被如下接口引用：DescribeDBInstanceSpecs。

名称 类型 必选 描述
Machine String 是 设备型号
注意：此字段可能返回 null，表示取不到有效值。
示例值：SH12
SpecInfos Array of SpecConfigInfo 是 该机型对应的可售卖规格列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[{"Cpu":1,"Machine":"TS85","MaxStorage":3000,"Memory":2,"MinStorage":10,"NodeCount":5,"Pid":1002231,"Qps":2100,"SuitInfo":"日独立用户数上百人的小型应用"},{"Cpu":1,"Machine":"TS85","MaxStorage":3000,"Memory":2,"MinStorage":10,"NodeCount":6,"Pid":1002231,"Qps":2100,"SuitInfo":"日独立用户数上百人的小型应用"}]

LogFileInfo

拉取的日志信息

被如下接口引用：DescribeDBLogFiles。

名称 类型 描述
Mtime Integer Log最后修改时间
示例值：15054029
Length Integer 文件长度
示例值：1733814880
Uri String 下载Log时用到的统一资源标识符
示例值：cos_xtrabackup+1733814880+20241210+151440+471405052+xbstream.lz4
FileName String 文件名
示例值：/cos_backup%2Ftdsql%2Fset_1732784236_431669%2Fxtrabackup%2F2024-12-10%2Fcos_xtrabackup%2B1733814880%2B20241210%2B151440%2B471405052%2Bxbstream.lz4?q-sign-algorithm=sha1&q-ak=AKIDxxxx&q-sign-time=1733884388%3B1733885288&q-key-time=1733884388%3B1733885288&q-header-list=host&q-url-param-list=&q-signature=f978b91c6f7031d47fce45bb07b5164b7192b3d9

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节点信息

被如下接口引用：DescribeDBInstanceDetail, DescribeInstanceNodeInfo。

名称 类型 描述
NodeId String DB节点ID
示例值：870a9d34cd1f
Role String DB节点角色，取值为master或者slave
示例值：master

ParamConstraint

参数约束

被如下接口引用：DescribeDBParameters。

名称 类型 描述
Type String 约束类型,如枚举enum，区间section
示例值：section
Enum String 约束类型为enum时的可选值列表
示例值："ALL,OFF,FILTER"
Range ConstraintRange 约束类型为section时的范围
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"max":"65535","min":"1"}
String String 约束类型为string时的可选值列表
示例值："REAL_AS_FLOAT,PIPES_AS_CONCAT,ANSI_QUOTES,IGNORE_SPACE,IGNORE_BAD_TABLE_OPTIONS,ONLY_FULL_GROUP_BY,NO_UNSIGNED_SUBTRACTION,NO_DIR_IN_CREATE,NO_KEY_OPTIONS,NO_TABLE_OPTIONS,NO_FIELD_OPTIONS,NO_AUTO_VALUE_ON_ZERO,NO_BACKSLASH_ESCAPES,STRICT_TRANS_TABLES,STRICT_ALL_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ALLOW_INVALID_DATES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,HIGH_NOT_PRECEDENCE,NO_ENGINE_SUBSTITUTION,PAD_CHAR_TO_FULL_LENGTH"

ParamDesc

DB参数描述

被如下接口引用：DescribeDBParameters。

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

ParamModifyResult

修改参数结果

被如下接口引用：ModifyDBParameters。

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

ProcedurePrivilege

存储过程权限信息

被如下接口引用：ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 是 数据库名
示例值：pre_oss
Procedure String 是 数据库存储过程名
示例值：work_procedure
Privileges Array of String 是 权限信息
示例值：["SELECT","DELETE","CREATE"]

RegionInfo

售卖可用区信息

被如下接口引用：DescribeSaleInfo。

名称 类型 描述
Region String 地域英文ID
示例值：ap-guangzhou
RegionId Integer 地域数字ID
示例值：1
RegionName String 地域中文名
示例值：广州
ZoneList Array of ZonesInfo 可用区列表
示例值：[{"Zone":"ap-guangzhou-1","ZoneId":100001,"ZoneName":"广州一区","OnSale":true},{"Zone":"ap-guangzhou-2","ZoneId":100002,"ZoneName":"广州二区","OnSale":true}]
AvailableChoice Array of ZoneChooseInfo 可选择的主可用区和从可用区
示例值：[{ "MasterZone":{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }, "SlaveZones":[{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }, { "Zone":"ap-guangzhou-2", "ZoneId":100002, "ZoneName":"广州二区", "OnSale":true }] }, { "MasterZone":{ "Zone":"ap-guangzhou-2", "ZoneId":100002, "ZoneName":"广州二区", "OnSale":true }, "SlaveZones":[{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }, { "Zone":"ap-guangzhou-2", "ZoneId":100002, "ZoneName":"广州二区", "OnSale":true }] }]

ReservedNetResource

保留的网络资源信息

被如下接口引用：DescribeDBInstanceDetail。

名称 类型 描述
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

被如下接口引用：CreateDBInstance, CreateDedicatedClusterDBInstance, CreateHourDBInstance, DescribeDBInstanceDetail, DescribeDBInstances。

名称 类型 必选 描述
TagKey String 是 标签键key
示例值：project
TagValue String 是 标签值value
示例值：tdsql50

SecurityGroup

安全组详情

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

名称 类型 描述
ProjectId Integer 项目ID
示例值：10068
CreateTime String 创建时间，时间格式：yyyy-mm-dd hh:mm:ss
示例值：2024-11-13 20:20:05
SecurityGroupId String 安全组ID
示例值：sg-iry0kj68
SecurityGroupName String 安全组名称
示例值：TDSQL-for-tst
SecurityGroupRemark String 安全组备注
示例值：自定义
Inbound Array of SecurityGroupBound 入站规则
示例值：[ { "Action": "ACCEPT", "AddressModule": "", "CidrIp": "211.139.*", "Desc": "", "Id": "", "IpProtocol": "tcp", "PortRange": "80,443", "ServiceModule": "" }, { "Action": "ACCEPT", "AddressModule": "ipm-b0cywwyy", "CidrIp": "", "Desc": "成都出口IP", "Id": "", "IpProtocol": "tcp", "PortRange": "80,443", "ServiceModule": "" } ]
Outbound Array of SecurityGroupBound 出站规则
示例值：[ { "Action": "ACCEPT", "AddressModule": "", "CidrIp": "0.0.0.0/0", "Desc": "", "Id": "", "IpProtocol": "ALL", "PortRange": "ALL", "ServiceModule": "" }, { "Action": "ACCEPT", "AddressModule": "", "CidrIp": "", "Desc": "", "Id": "", "IpProtocol": "ALL", "PortRange": "ALL", "ServiceModule": "" } ]

SecurityGroupBound

安全出入口规则

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

名称 类型 描述
Action String 策略，ACCEPT 或者 DROP
示例值：111.206.0.0/16
CidrIp String 来源 IP 或 IP 段，例如192.168.0.0/16
示例值：ACCEPT
PortRange String 端口
示例值：36000,80,22,8081,8080,32000,30089,53000,30080
IpProtocol String 网络协议，支持 UDP、TCP 等
示例值：tcp

SlowLogData

慢查询条目信息

被如下接口引用：DescribeDBSlowLogs。

名称 类型 描述
CheckSum String 语句校验和，用于查询详情
示例值：166258302
Db String 数据库名称
示例值：pre_oss
FingerPrint String 抽象的SQL语句
示例值：select id, f?, sleep(?) from t? where id % ? = ?
LockTimeAvg String 平均的锁时间
示例值：0.000101
LockTimeMax String 最大锁时间
示例值：0.000101
LockTimeMin String 最小锁时间
示例值：0.000101
LockTimeSum String 锁时间总和
示例值：0.000101
QueryCount String 查询次数
示例值：1
QueryTimeAvg String 平均查询时间
示例值：2.00033
QueryTimeMax String 最大查询时间
示例值：2.00033
QueryTimeMin String 最小查询时间
示例值：2.00033
QueryTimeSum String 查询时间总和
示例值：2.00033
RowsExaminedSum String 扫描行数
示例值：4
RowsSentSum String 发送行数
示例值：2
TsMax String 最后执行时间
示例值：2022-03-09 19:37:35
TsMin String 首次执行时间
示例值：2022-03-09 19:37:35
User String 账号
示例值：user_00
ExampleSql String 样例Sql
注意：此字段可能返回 null，表示取不到有效值。
示例值：select id, f1, sleep(1) from t1 where id % 2 = 1
Host String 账户的域名
示例值：%

SpecConfigInfo

实例可售卖规格详细信息，创建实例和扩容实例时 Pid+MemSize 唯一确定一种售卖规格，磁盘大小可用区间为[MinDataDisk,MaxDataDisk]

被如下接口引用：DescribeDBInstanceSpecs。

名称 类型 必选 描述
Machine String 否 设备型号
示例值：SH12
Memory Integer 否 内存大小，单位 GB
示例值：8
MinStorage Integer 否 数据盘规格最小值，单位 GB
示例值：10
MaxStorage Integer 否 数据盘规格最大值，单位 GB
示例值：3000
SuitInfo String 否 推荐的使用场景
示例值：日独立用户数上千人的小型应用
Qps Integer 否 最大 Qps 值
示例值：6500
Pid Integer 否 产品类型 Id
示例值：1002231
NodeCount Integer 否 节点个数，2 表示一主一从，3 表示一主二从
示例值：1
Cpu Integer 否 Cpu核数
示例值：4

TableColumn

数据库列信息

被如下接口引用：DescribeDatabaseTable。

名称 类型 描述
Col String 列名称
示例值：name
Type String 列类型
示例值：varchar(255)

TablePrivilege

数据库表权限

被如下接口引用：ModifyAccountPrivileges。

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

Tag

标签

被如下接口引用：DescribeDBInstances。

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

TmpInstance

临时实例

被如下接口引用：DescribeDBTmpInstances。

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

ViewPrivileges

视图权限信息

被如下接口引用：ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 是 数据库名
示例值：pre_oss
View String 是 数据库视图名
示例值：work_view
Privileges Array of String 是 权限信息
示例值：["SELECT"]

ZoneChooseInfo

分片节点可用区选择

被如下接口引用：DescribeSaleInfo。

名称 类型 描述
MasterZone ZonesInfo 主可用区
示例值：{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }
SlaveZones Array of ZonesInfo 可选的从可用区
示例值：[{ "Zone":"ap-guangzhou-1", "ZoneId":100001, "ZoneName":"广州一区", "OnSale":true }, { "Zone":"ap-guangzhou-2", "ZoneId":100002, "ZoneName":"广州二区", "OnSale":true }]

ZonesInfo

可用区信息

被如下接口引用：DescribeSaleInfo。

名称 类型 描述
Zone String 可用区英文ID
示例值：ap-guangzhou-1
ZoneId Integer 可用区数字ID
示例值：100001
ZoneName String 可用区中文名
示例值：广州一区
OnSale Boolean 是否在售
示例值：true
中国站
文档活动
message-icon联系我们
目录