API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

Account

数据库账号信息

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
User String 账户的名称
Host String 账户的域名

ColumnPrivilege

列权限信息

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
Table String 数据库表名
Column String 数据库列名
Privileges Array of String 权限信息

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 该字段对只读帐号有意义,表示选择主备延迟小于该值的备机
注意:此字段可能返回 null,表示取不到有效值。
SlaveConst Integer 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。

DBBackupTimeConfig

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

被如下接口引用:DescribeBackupTime。

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

DBInstance

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

被如下接口引用:DescribeDBInstances。

名称 类型 描述
InstanceId String 实例 ID,唯一标识一个 TDSQL 实例
InstanceName String 实例名称,用户可修改
AppId Integer 实例所属应用 ID
ProjectId Integer 实例所属项目 ID
Region String 实例所在地域名称,如 ap-shanghai
Zone String 实例所在可用区名称,如 ap-shanghai-1
VpcId Integer 私有网络 ID,基础网络时为 0
SubnetId Integer 子网 ID,基础网络时为 0
Status Integer 实例状态:0 创建中,1 流程处理中, 2 运行中,3 实例未初始化,-1 实例已隔离,4 实例初始化中,5 实例删除中,6 实例重启中,7 数据迁移中
Vip String 内网 IP 地址
Vport Integer 内网端口
WanDomain String 外网访问的域名,公网可解析
WanVip String 外网 IP 地址,公网可访问
WanPort Integer 外网端口
CreateTime Timestamp 实例创建时间,格式为 2006-01-02 15:04:05
UpdateTime Timestamp 实例最后更新时间,格式为 2006-01-02 15:04:05
AutoRenewFlag Integer 自动续费标志:0 否,1 是
PeriodEndTime Timestamp 实例到期时间,格式为 2006-01-02 15:04:05
Uin String 实例所属账号
TdsqlVersion String TDSQL 版本信息
Memory Integer 实例内存大小,单位 GB
Storage Integer 实例存储大小,单位 GB
UniqueVpcId String 字符串型的私有网络ID
UniqueSubnetId String 字符串型的私有网络子网ID
OriginSerialId String 原始实例ID(过时字段,请勿依赖该值)
NodeCount Integer 节点数,2为一主一从,3为一主二从
IsTmp Integer 是否临时实例,0为否,非0为是
ExclusterId String 独享集群ID,为空表示为普通实例
Id Integer 数字实例ID(过时字段,请勿依赖该值)
Pid Integer 产品类型 ID
Qps Integer 最大 Qps 值
Paymode String 付费模式
注意:此字段可能返回 null,表示取不到有效值。
Locker Integer 实例处于异步任务时的异步任务流程ID
注意:此字段可能返回 null,表示取不到有效值。
StatusDesc String 实例目前运行状态描述
注意:此字段可能返回 null,表示取不到有效值。
WanStatus Integer 外网状态,0-未开通;1-已开通;2-关闭;3-开通中
IsAuditSupported Integer 该实例是否支持审计。1-支持;0-不支持
Machine String 机器型号
IsEncryptSupported 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,表示取不到有效值。
DbEngine String 数据库引擎
注意:此字段可能返回 null,表示取不到有效值。
DbVersion String 数据库版本
注意:此字段可能返回 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,表示取不到有效值。

DBParamValue

云数据库参数信息。

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

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

DCNReplicaConfig

dcn 配置情况

被如下接口引用:DescribeDcnDetail。

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

DCNReplicaStatus

DCN的状态信息

被如下接口引用:DescribeDcnDetail。

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

Database

数据库信息

被如下接口引用:DescribeDatabases。

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

DatabaseFunction

数据库函数信息

被如下接口引用:DescribeDatabaseObjects。

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

DatabasePrivilege

数据库权限

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Privileges Array of String 权限信息
Database String 数据库名

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: 灾备实例(独享型)
ReplicaConfig DCNReplicaConfig DCN复制的配置信息;对于主实例,此字段为null
注意:此字段可能返回 null,表示取不到有效值。
ReplicaStatus DCNReplicaStatus DCN复制的状态;对于主实例,此字段为null
注意:此字段可能返回 null,表示取不到有效值。
EncryptStatus Integer 是否开启了 kms

Deal

订单信息

被如下接口引用:DescribeOrders。

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

FunctionPrivilege

函数权限信息

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
FunctionName String 数据库函数名
Privileges Array of String 权限信息

InstanceSpec

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

被如下接口引用:DescribeDBInstanceSpecs。

名称 类型 必选 描述
Machine String 设备型号
SpecInfos Array of SpecConfigInfo 该机型对应的可售卖规格列表

LogFileInfo

拉取的日志信息

被如下接口引用:DescribeDBLogFiles。

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

NodeInfo

描述实例的各个DB节点信息

被如下接口引用:DescribeInstanceNodeInfo。

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

ParamModifyResult

修改参数结果

被如下接口引用:ModifyDBParameters。

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

ProcedurePrivilege

存储过程权限信息

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
Procedure String 数据库存储过程名
Privileges Array of String 权限信息

RegionInfo

售卖可用区信息

被如下接口引用:DescribeSaleInfo。

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

ResourceTag

标签对象,包含tagKey & tagValue

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

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

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

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 账户的域名

SpecConfigInfo

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

被如下接口引用:DescribeDBInstanceSpecs。

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

TableColumn

数据库列信息

被如下接口引用:DescribeDatabaseTable。

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

TablePrivilege

数据库表权限

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
Table String 数据库表名
Privileges Array of String 权限信息

ViewPrivileges

视图权限信息

被如下接口引用:ModifyAccountPrivileges。

名称 类型 必选 描述
Database String 数据库名
View String 数据库视图名
Privileges Array of String 权限信息

ZoneChooseInfo

分片节点可用区选择

被如下接口引用:DescribeSaleInfo。

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

ZonesInfo

可用区信息

被如下接口引用:DescribeSaleInfo。

名称 类型 描述
Zone String 可用区英文ID
ZoneId Integer 可用区数字ID
ZoneName String 可用区中文名
OnSale Boolean 是否在售
目录