数据结构
最近更新时间: 2024-10-18 10:38:32
ParamModifyResult
修改参数结果
被如下接口引用：ModifyDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Code | 是 | 否 | Int64 | 参数修改结果。0表示修改成功；-1表示修改失败；-2表示该参数值非法 |
| Param | 是 | 否 | String | 修改参数名字 |
Permission
描述对资源权限，仅内部使用。
被如下接口引用：AuthenticateCAM
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IsPermitted | 是 | 否 | Int64 | 是否有权限，1 - 有权限， 0 - 无权限 |
| Resource | 是 | 否 | String | 资源对象 |
DstExtraInfo
展示同步任务详情时，表示目标实例的一些额外信息。
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DirectConnectGatewayId | 是 | 是 | String | 如果目标实例通过专线接入的话，表示接入的专线ID |
| Ip | 是 | 是 | String | 目标实例的IP地址 |
| Port | 是 | 是 | Int64 | 目标实例的端口地址 |
| SubnetId | 是 | 是 | String | 私用网络ID |
| User | 是 | 是 | String | 目标实例登录用户名 |
| VpcId | 是 | 是 | String | 子网ID |
Rsip
拉取实例后端RS信息，返回IP和PORT结构体数组
被如下接口引用：DescribeDBInstanceRsip
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip | 是 | 否 | String | Ip地址 |
| Port | 是 | 否 | Int64 | 端口 |
TableColumn
数据库列信息
被如下接口引用：DescribeDatabaseTable
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Col | 是 | 否 | String | 列名称 |
| Type | 是 | 否 | String | 列类型 |
SlowLogData
慢查询条目信息
被如下接口引用：DescribeDBSlowLogs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CheckSum | 是 | 否 | String | 语句校验和，用于查询详情 |
| Db | 是 | 否 | String | 数据库名称 |
| ExampleSql | 是 | 是 | String | 样例Sql |
| 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 | 帐号 |
TmpInstance
临时实例
被如下接口引用：DescribeDBTmpInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 是 | Int64 | 应用ID |
| CreateTime | 是 | 是 | Datetime | 创建时间 |
| InstanceId | 是 | 是 | String | 实例 ID，形如：tdsql-ow728lmc。 |
| InstanceRemark | 是 | 是 | String | 实例备注 |
| Ipv6Flag | 是 | 是 | Uint64 | 实例IPv6标志 |
| PeriodEndTime | 是 | 是 | Datetime | 有效期结束时间 |
| Region | 是 | 是 | String | 实例所在地域 |
| SrcInstanceId | 是 | 是 | String | 源实例 ID，形如：tdsql-ow728lmc。 |
| Status | 是 | 是 | Int64 | 实例状态,0:待初始化,1:流程处理中,2:有效状态,-1:已隔离，-2：已下线 |
| StatusDesc | 是 | 是 | String | 实例状态描述 |
| TempType | 是 | 是 | Int64 | 0:非临时实例 ,1:无效临时实例, 2:回档成功的有效临时实例 |
| Vip | 是 | 是 | String | 实例虚IP |
| Vipv6 | 是 | 是 | String | 实例虚IPv6 |
| Vport | 是 | 是 | Int64 | 实例虚端口 |
| Zone | 是 | 是 | String | 实例所在可用区 |
DatabaseFunction
数据库函数信息
被如下接口引用：DescribeDatabaseObjects
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Func | 是 | 否 | String | 函数名称 |
MonitorFloatData
浮点监控数据
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Data | 是 | 否 | Float | 监控数据 |
| EndTime | 是 | 否 | Datetime | 结束时间 |
| StartTime | 是 | 否 | Datetime | 起始时间 |
DCNReplicaStatus
描述只读实例的复制状态
被如下接口引用：DescribeDBInstanceDetail、DescribeDcnDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Status | 是 | 否 | String | 该只读实例当前的复制状态，枚举值：RUNNING（正在复制中）、PAUSED（已暂停复制）、REACHED_DUE_TIME（已复制到指定时间点） |
| Delay | 是 | 否 | Int64 | 该只读实例相对于主实例的延迟情况，单位为秒 |
DBEngineInfo
数据库引擎信息
被如下接口引用：DescribeDBEngines
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Description | 是 | 否 | String | 引擎描述 |
| Name | 是 | 否 | String | 引擎名称，eg. 基于MariaDB 10.1.9 分支 |
| Type | 是 | 否 | String | 引擎类型，MariaDB|Percona |
| Version | 是 | 否 | String | 引擎版本，eg. 10.1.9 |
SaleZone
售卖可用区信息
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Zone | 是 | 否 | String | 可用区英文名 |
| ZoneId | 是 | 否 | Int64 | 可用区数字ID |
| ZoneZh | 是 | 否 | String | 可用区中文名 |
DBBackupTimeConfig
云数据库实例备份时间配置信息
被如下接口引用：DescribeBackupTime
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EndBackupTime | 是 | 否 | String | 每天备份执行的区间的结束时间，格式 mm:ss，形如 23:00 |
| InstanceId | 是 | 否 | String | 实例 ID |
| StartBackupTime | 是 | 否 | String | 每天备份执行的区间的开始时间，格式 mm:ss，形如 22:00 |
Inbound
安全组入站规则
被如下接口引用：DescribeDBSecurityGroups、DescribeProjectSecurityGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 策略，ACCEPT或者DROP。 |
| AddressModule | 是 | 否 | String | 地址组id代表的地址集合。 |
| CidrIp | 是 | 否 | String | 来源Ip或Ip段，例如192.168.0.0/16。 |
| Desc | 是 | 否 | String | 描述。 |
| Id | 是 | 否 | String | 安全组id代表的地址集合。 |
| IpProtocol | 是 | 否 | String | 网络协议，支持udp、tcp等。 |
| PortRange | 是 | 否 | String | 端口。 |
| ServiceModule | 是 | 否 | String | 服务组id代表的协议和端口集合。 |
Flow
任务
被如下接口引用：DescribeUserTasks
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 否 | Int64 | 应用ID |
| CreateTime | 是 | 否 | String | 创建时间 |
| EndTime | 是 | 否 | String | 结束时间 |
| ErrMsg | 是 | 否 | String | 错误信息 |
| Id | 是 | 否 | Int64 | 任务ID |
| InputData | 是 | 否 | String | 输入数据 |
| InstanceId | 是 | 否 | String | 实例 ID，形如：tdsql-ow728lmc |
| InstanceName | 是 | 否 | String | 实例名称 |
| RegionId | 是 | 否 | Int64 | 地域ID |
| Status | 是 | 否 | Int64 | 状态 |
| UserTaskType | 是 | 否 | Int64 | 用户任务类型 |
ParamConstraint
参数约束
被如下接口引用：DescribeDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Enum | 否 | 否 | String | 约束类型为enum时的可选值列表 |
| Range | 否 | 是 | ConstraintRange | 约束类型为section时的范围 |
| String | 是 | 否 | String | 约束类型为string时的可选值列表 |
| Type | 是 | 否 | String | 约束类型,如枚举enum，区间section |
Project
描述一个项目的基本信息。
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 否 | 否 | Int64 | 应用ID |
| CreateTime | 是 | 否 | Datetime | 创建时间 |
| CreatorUin | 是 | 否 | Int64 | 创建者Id |
| Info | 是 | 否 | String | 描述信息 |
| IsDefault | 是 | 否 | Int64 | 是否默认项目，1 是，0 不是 |
| Name | 否 | 否 | String | 项目名称 |
| OwnerUin | 是 | 否 | Int64 | 主账号Id |
| ProjectId | 否 | 否 | Int64 | 项目ID |
| SrcAppId | 是 | 否 | Int64 | 来源AppId |
| SrcPlat | 是 | 否 | String | 来源平台 |
| Status | 否 | 否 | Int64 | 项目状态,0正常，-1关闭。默认项目为3 |
TemplateParamConstraint
参数模板参数约束条件
被如下接口引用：DescribeConfigTemplate、DescribeDefaultConfigTemplate
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Enum | 是 | 否 | String | 约束枚举 |
| Range | 是 | 是 | TemplateConstraintRange | 约束范围 |
| Str | 是 | 否 | String | 约束字符串 |
| Type | 是 | 否 | String | 约束类型 |
ParamDesc
DB参数描述
被如下接口引用：DescribeDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Constraint | 是 | 否 | ParamConstraint | 参数限制 |
| Default | 是 | 否 | String | 系统默认值 |
| HaveSetValue | 是 | 否 | Bool | 是否有设置过值，false:没有设置过值，true:有设置过值。 |
| Param | 是 | 否 | String | 参数名字 |
| SetValue | 是 | 是 | String | 设置过的值，参数生效后，该值和value一样。 |
| Value | 是 | 否 | String | 当前参数值 |
SaleSpecSet
售卖规格返回集
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 地域名称，如ap-guangzhou |
McLog
前台日志
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 用户请求action(用户操作) |
| AppId | 是 | 否 | String | 应用Id |
| ArgData | 是 | 否 | String | 参数数据 |
| BrowserType | 是 | 否 | String | 浏览器类型 |
| ClientIp | 是 | 否 | String | 客户端Ip |
| ErrCode | 是 | 否 | String | 错误码 |
| ErrMsg | 是 | 否 | String | 错误信息 |
| Id | 是 | 否 | Int64 | ID |
| InstanceId | 是 | 否 | String | 实例 ID，形如：tdsql-ow728lmc |
| InstanceName | 是 | 否 | String | 实例名称 |
| OperateTime | 是 | 否 | String | 操作时间 |
| OwnerUin | 是 | 否 | String | 主账户Uin |
| RegionId | 是 | 否 | Int64 | 地域Id |
| Uin | 是 | 否 | String | 账户Uin |
DBCharsetItem
DB字符集信息
被如下接口引用：DescribeDBCharsets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Version | 否 | 否 | String | DB版本号 |
| DefaultCharset | 否 | 否 | String | DB默认字符集 |
| OptionalCharsets | 否 | 否 | String | DB可选字符集 |
FenceInfoItem
独享资源池信息
被如下接口引用：DescribeAvailableExclusiveGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FenceId | 是 | 否 | String | 独享资源池ID |
DatabaseView
数据库视图信息
被如下接口引用：DescribeDatabaseObjects
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| View | 是 | 否 | String | 视图名称 |
ConstraintRange
约束类型值的范围
被如下接口引用：DescribeDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Max | 是 | 否 | String | 约束类型为section时的最大值 |
| Min | 是 | 否 | String | 约束类型为section时的最小值 |
RegionInfo
售卖可用区信息
被如下接口引用：DescribeSaleInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AvailableChoice | 是 | 否 | Array of ZoneChooseInfo | 可选择的主可用区和从可用区 |
| Region | 是 | 否 | String | 地域英文ID |
| RegionId | 是 | 否 | Int64 | 地域数字ID |
| RegionName | 是 | 否 | String | 地域中文名 |
| ZoneList | 是 | 否 | Array of ZonesInfo | 可用区列表 |
ConfTemplate
参数模板
被如下接口引用：DescribeConfigTemplates
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 否 | Int64 | 应用id |
| ConfigTemplateId | 是 | 否 | Int64 | 参数模板Id |
| TemplateDefault | 是 | 否 | String | 默认模板 |
| TemplateDesc | 是 | 否 | String | 参数模板描述 |
| TemplateName | 是 | 否 | String | 参数模板名称 |
DatabaseTable
数据库表信息
被如下接口引用：DescribeDatabaseObjects
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Table | 是 | 否 | String | 表名 |
SecurityGroup
安全组详情
被如下接口引用：DescribeDBSecurityGroups、DescribeProjectSecurityGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreateTime | 是 | 否 | String | 创建时间，时间格式：yyyy-mm-dd hh:mm:ss |
| Inbound | 是 | 否 | Array of Inbound | 入站规则。 |
| Outbound | 是 | 否 | Array of Outbound | 出站规则。 |
| ProjectId | 是 | 否 | Int64 | 项目ID |
| SecurityGroupId | 是 | 否 | String | 安全组ID |
| SecurityGroupName | 是 | 否 | String | 安全组名称 |
| SecurityGroupRemark | 是 | 否 | String | 安全组备注 |
CommonDBInstance
https://git.code.oa.com/QCloudCDB-Platform/working-dashboard/issues/66
被如下接口引用：DescribeCommonDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 是 | Int64 | 应用Id |
| CreateTime | 是 | 是 | String | 实例创建时间 |
| InstanceId | 是 | 是 | String | 实例ID |
| InstanceName | 是 | 是 | String | 实例名称 |
| NetType | 是 | 是 | Int64 | 0-基础网络，1-VPC网络 |
| PayMode | 是 | 是 | Int64 | 计费类型，1-包年包月，0-按量计费 |
| ProjectId | 是 | 是 | Int64 | 项目Id |
| Region | 是 | 是 | String | 地域 |
| Status | 是 | 是 | String | 实例状态信息，0-创建中,1-运行中，2-隔离中,下线后无法拉取实例信息 |
| SubnetId | 是 | 是 | String | 子网统一Id |
| Vips | 是 | 是 | Array of String | VPC网络IP |
| VpcId | 是 | 是 | String | VPC网络统一Id |
| Vport | 是 | 是 | Int64 | VPC网络端口 |
| Zone | 是 | 是 | String | 可用区 |
DBParamValue
云数据库参数信息。
被如下接口引用：CreateHourDBInstance、InitDBInstances、ModifyDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Param | 是 | 否 | String | 参数名称 |
| Value | 是 | 否 | String | 参数值 |
SpecConfigInfo
实例可售卖规格详细信息，创建实例和扩容实例时 Pid+MemSize 唯一确定一种售卖规格，磁盘大小可用区间为[MinDataDisk,MaxDataDisk]
被如下接口引用：DescribeDBInstanceSpecs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cpu | 是 | 否 | Int64 | Cpu核数 |
| Machine | 是 | 否 | String | 设备型号 |
| MaxStorage | 是 | 否 | Int64 | 数据盘规格最大值，单位 GB |
| Memory | 是 | 否 | Int64 | 内存大小，单位 GB |
| MinStorage | 是 | 否 | Int64 | 数据盘规格最小值，单位 GB |
| NodeCount | 是 | 否 | Int64 | 节点个数，2 表示一主一从，3 表示一主二从 |
| Pid | 是 | 否 | Int64 | 产品类型 Id |
| Qps | 是 | 否 | Int64 | 最大 Qps 值 |
| SuitInfo | 是 | 否 | String | 推荐的使用场景 |
ProxyConfigParam
网关配置参数
被如下接口引用：DescribeInstanceProxyConfig
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Param | 是 | 否 | String | 配置参数名称 |
| Value | 是 | 否 | String | 配置参数值 |
ZoneChooseInfo
分片节点可用区选择
被如下接口引用：DescribeSaleInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MasterZone | 是 | 否 | ZonesInfo | 主可用区 |
| SlaveZones | 是 | 否 | Array of ZonesInfo | 可选的从可用区 |
ZonesInfo
可用区信息
被如下接口引用：DescribeSaleInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Zone | 是 | 否 | String | 可用区英文ID |
| ZoneId | 是 | 否 | Int64 | 可用区数字ID |
| ZoneName | 是 | 否 | String | 可用区中文名 |
DcnDetailItem
DCN详情条目
被如下接口引用：DescribeDcnDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DcnFlag | 是 | 否 | Int64 | 实例DCN标志，1-主，2-备 |
| DcnStatus | 是 | 否 | Int64 | 实例DCN状态，0-无，1-创建中，2-同步中，3-已断开 |
| InstanceId | 是 | 否 | String | 实例ID |
| InstanceName | 是 | 否 | String | 实例名称 |
| Region | 是 | 否 | String | 实例地域 |
| Status | 是 | 否 | Int64 | 实例状态 |
| StatusDesc | 是 | 否 | String | 实例状态描述 |
| Vip | 是 | 否 | String | 实例IP地址 |
| Vipv6 | 是 | 否 | String | 实例IPv6地址 |
| Vport | 是 | 否 | Int64 | 实例端口 |
| Zone | 是 | 否 | String | 实例可用区 |
| ReplicaConfig | 否 | 是 | DCNReplicaConfig | 只读实例复制配置信息，仅当实例为DCN备时有效 |
| ReplicaStatus | 否 | 是 | DCNReplicaStatus | 只读实例复制状态，仅当实例为DCN备时有效 |
| EncryptStatus | 是 | 否 | Int64 | KMS开启状态，0-未开启，1-已开启 |
InstanceInfo
实例信息
被如下接口引用：DescribeInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 否 | Int64 | 实例对应的AppId |
| ClusterName | 是 | 否 | String | 实例集群名称 |
| DbVersion | 是 | 否 | String | 数据库版本 |
| Id | 是 | 否 | Int64 | 实例数字ID |
| InstanceId | 是 | 否 | String | 实例短ID，形如tdsql-hdbirf67 |
| InstanceName | 是 | 否 | String | 实例名称 |
| NodeCount | 是 | 否 | Int64 | 实例是一主一从还是一主两从。2-一主一从；3-一主两从 |
| OriginSerialId | 是 | 否 | String | 实例最初的SerialId，实例扩容后SerialId会变，OriginSerialId表示实例最初的SerialId，不会改变 |
| Region | 是 | 否 | String | 实例地域 |
| SerialId | 是 | 否 | String | 实例SerialId |
| Status | 是 | 否 | Int64 | 实例状态信息 |
| SubnetId | 是 | 否 | Int64 | 实例是VPC网络的话，表示实例所属子网ID，数字ID |
| UniqueSubnetId | 是 | 否 | String | 实例是VPC网络的话，表示实例子网ID，英文短ID |
| UniqueVpcId | 是 | 否 | String | 实例是VPC网络的话，表示实例VPC网络ID，英文短ID |
| Vip | 是 | 否 | String | 实例Vip |
| VpcId | 是 | 否 | Int64 | 实例是VPC网络的话，表示实例VPC网络ID，数字ID |
| Vport | 是 | 否 | Int64 | 实例端口 |
| ZkName | 是 | 否 | String | 实例对应的ZK名称 |
| Zone | 是 | 否 | String | 实例可用区 |
| MonitorType | 是 | 否 | Int64 | 表示这个实例监控页面如何展示 |
InstanceSpec
按机型归类的实例可售卖规格信息
被如下接口引用：DescribeDBInstanceSpecs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Machine | 是 | 否 | String | 设备型号 |
| SpecInfos | 是 | 否 | Array of SpecConfigInfo | 该机型对应的可售卖规格列表 |
SyncDbInfo
多源同步详情
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DstInfo | 是 | 否 | String | 同步目标信息 |
| OrgInfo | 是 | 否 | String | 同步源信息 |
DatabaseProcedure
数据库存储过程信息
被如下接口引用：DescribeDatabaseObjects
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Proc | 是 | 否 | String | 存储过程名称 |
ConfigParam
配置模板参数
被如下接口引用：CreateConfigTemplate、ModifyConfigTemplate
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Param | 是 | 否 | String | 参数名 |
| Value | 是 | 否 | String | 参数值 |
Database
数据库信息
被如下接口引用：DescribeDatabases
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DbName | 是 | 否 | String | 数据库名称 |
InstanceConfig
实例配置
被如下接口引用：DescribeConfigHistories
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Int64 | 实例配置ID，形如：1 |
| ModTime | 是 | 否 | String | 修改时间 |
| ParamName | 是 | 否 | String | 参数名称 |
| ParamNewValue | 是 | 否 | String | 修改后参数值 |
| ParamOldValue | 是 | 否 | String | 修改前参数值 |
| Status | 是 | 否 | Int64 | 修改状态, 0:成功, -1:失败, -2:值非法 |
DBAccount
云数据库账号信息
被如下接口引用：DescribeAccounts
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreateTime | 是 | 否 | Datetime | 创建时间 |
| DelayThresh | 是 | 是 | Int64 | 该字段对只读帐号有意义，表示选择主备延迟小于该值的备机 |
| Description | 是 | 否 | String | 用户备注信息 |
| Host | 是 | 否 | String | 用户可以从哪台主机登录（对应 MySQL 用户的 host 字段，UserName + Host 唯一标识一个用户，IP形式，IP段以%结尾；支持填入%；为空默认等于%） |
| ReadOnly | 是 | 否 | Int64 | 只读标记，0：否， 1：该账号的sql请求优先选择备机执行，备机不可用时选择主机执行，2：优先选择备机执行，备机不可用时操作失败。 |
| UpdateTime | 是 | 否 | Datetime | 最后更新时间 |
| UserName | 是 | 否 | String | 用户名 |
DBInstance
描述云数据库实例的详细信息。
被如下接口引用：DescribeDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 否 | Int64 | 实例所属应用 ID |
| AutoRenewFlag | 是 | 否 | Int64 | 自动续费标志：0 否，1 是 |
| Cpu | 是 | 否 | Int64 | 实例CPU核数 |
| CreateTime | 是 | 否 | Datetime | 实例创建时间，格式为 2006-01-02 15:04:05 |
| DbEngine | 是 | 是 | String | 数据库引擎 |
| DbVersion | 是 | 是 | String | 数据库版本 |
| DcnDstNum | 是 | 是 | Int64 | DCN灾备实例数 |
| DcnFlag | 是 | 是 | Int64 | DCN标志，0-无，1-主实例，2-灾备实例 |
| DcnStatus | 是 | 是 | Int64 | DCN状态，0-无，1-创建中，2-同步中，3-已断开 |
| ExclusterId | 是 | 否 | String | 独享集群ID，为空表示为普通实例 |
| Id | 是 | 否 | Uint64 | 数字实例ID（过时字段，请勿依赖该值） |
| InstanceId | 是 | 否 | String | 实例 ID，唯一标识一个 TDSQL 实例 |
| InstanceName | 是 | 否 | String | 实例名称，用户可修改 |
| Ipv6Flag | 是 | 是 | Uint64 | 实例IPv6标志 |
| IsAuditSupported | 是 | 否 | Uint64 | 该实例是否支持审计。1-支持；0-不支持 |
| IsEncryptSupported | 是 | 否 | Int64 | 是否支持数据加密。1-支持；0-不支持 |
| IsTmp | 是 | 否 | Uint64 | 是否临时实例，0为否，非0为是 |
| Locker | 是 | 是 | Int64 | 实例处于异步任务时的异步任务流程ID |
| Machine | 是 | 否 | String | 机器型号 |
| Memory | 是 | 否 | Int64 | 实例内存大小，单位 GB |
| NodeCount | 是 | 否 | Uint64 | 节点数，2为一主一从，3为一主二从 |
| OriginSerialId | 是 | 否 | String | 原始实例ID（过时字段，请勿依赖该值） |
| Paymode | 是 | 是 | String | 付费模式 |
| PeriodEndTime | 是 | 否 | Datetime | 实例到期时间，格式为 2006-01-02 15:04:05 |
| Pid | 是 | 否 | Int64 | 产品类型 ID |
| ProjectId | 是 | 否 | Int64 | 实例所属项目 ID |
| Qps | 是 | 否 | Int64 | 最大 Qps 值 |
| Region | 是 | 否 | String | 实例所在地域名称，如 ap-shanghai |
| Status | 是 | 否 | Int64 | 实例状态：0 创建中，1 流程处理中， 2 运行中，3 实例未初始化，-1 实例已隔离，-2 实例已删除 |
| StatusDesc | 是 | 是 | String | 实例目前运行状态描述 |
| Storage | 是 | 否 | Int64 | 实例存储大小，单位 GB |
| SubnetId | 是 | 否 | Int64 | 子网 ID，基础网络时为 0 |
| TdsqlVersion | 是 | 否 | String | TDSQL 版本信息 |
| Uin | 是 | 否 | String | 实例所属账号 |
| UniqueSubnetId | 是 | 否 | String | 字符串型的私有网络子网ID |
| UniqueVpcId | 是 | 否 | String | 字符串型的私有网络ID |
| UpdateTime | 是 | 否 | Datetime | 实例最后更新时间，格式为 2006-01-02 15:04:05 |
| Vip | 是 | 否 | String | 内网 IP 地址 |
| Vipv6 | 是 | 是 | String | 内网IPv6 |
| VpcId | 是 | 否 | Int64 | 私有网络 ID，基础网络时为 0 |
| Vport | 是 | 否 | Int64 | 内网端口 |
| WanDomain | 是 | 否 | String | 外网访问的域名，公网可解析 |
| WanPort | 是 | 否 | Int64 | 外网端口 |
| WanPortIpv6 | 是 | 是 | Uint64 | 外网IPv6端口 |
| WanStatus | 是 | 否 | Int64 | 外网状态，0-未开通；1-已开通；2-关闭；3-开通中 |
| WanStatusIpv6 | 是 | 是 | Uint64 | 外网IPv6状态 |
| WanVip | 是 | 否 | String | 外网 IP 地址，公网可访问 |
| WanVipv6 | 是 | 是 | String | 外网IPv6 |
| Zone | 是 | 否 | String | 实例所在可用区名称，如 ap-shanghai-1 |
| InstanceType | 是 | 是 | Int64 | 1： 主实例（独享型）, 2: 主实例, 3： 灾备实例, 4： 灾备实例（独享型） |
| CpuArch | 否 | 否 | String | cpu架构 |
MonitorIntData
整形监控数据
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Data | 是 | 否 | Int64 | 监控数据 |
| EndTime | 是 | 否 | Datetime | 结束时间 |
| StartTime | 是 | 否 | Datetime | 起始时间 |
ResourceTag
标签对象，包含tagKey & tagValue
被如下接口引用：CreateHourDBInstance、DescribeDBInstanceDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 否 | String | 标签键key |
| TagValue | 是 | 否 | String | 标签值value |
ShardZoneChooseInfo
分片节点可用区选择
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MasterZone | 是 | 否 | ZonesInfo | 主可用区 |
| SlaveZones | 是 | 否 | Array of ZonesInfo | 可选的从可用区 |
TemplateConstraintRange
参数模板中数值型参数的范围约束
被如下接口引用：DescribeConfigTemplate、DescribeDefaultConfigTemplate
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Max | 是 | 否 | String | 约束范围最大值 |
| Min | 是 | 否 | String | 约束范围最小值 |
TemplateParam
参数模板参数
被如下接口引用：DescribeConfigTemplate、DescribeDefaultConfigTemplate
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Constraint | 是 | 否 | TemplateParamConstraint | 参数约束条件 |
| Default | 是 | 否 | String | 参数默认值 |
| Param | 是 | 否 | String | 参数名 |
| Value | 是 | 否 | String | 参数值 |
LogFileInfo
拉取的日志信息
被如下接口引用：DescribeDBLogFiles
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FileName | 是 | 否 | String | 文件名 |
| Length | 是 | 否 | Uint64 | 文件长度 |
| Mtime | 是 | 否 | Uint64 | Log最后修改时间 |
| Uri | 是 | 否 | String | 下载Log时用到的统一资源标识符 |
Outbound
安全组出站规则
被如下接口引用：DescribeDBSecurityGroups、DescribeProjectSecurityGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 策略，ACCEPT或者DROP。 |
| AddressModule | 是 | 否 | String | 地址组id代表的地址集合。 |
| CidrIp | 是 | 否 | String | 来源Ip或Ip段，例如192.168.0.0/16。 |
| Desc | 是 | 否 | String | 描述。 |
| Id | 是 | 否 | String | 安全组id代表的地址集合。 |
| IpProtocol | 是 | 否 | String | 网络协议，支持udp、tcp等。 |
| PortRange | 是 | 否 | String | 端口。 |
| ServiceModule | 是 | 否 | String | 服务组id代表的协议和端口集合。 |
DCNReplicaConfig
只读实例的复制配置信息
被如下接口引用：DescribeDBInstanceDetail、DescribeDcnDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RoReplicationMode | 是 | 否 | String | 只读实例的复制模式，枚举值为：START、STOP |
| DelayReplicationType | 是 | 否 | String | 延迟复制类型。当RoReplicationMode为 START 时有意义，枚举值为 DEFAULT（按照延迟复制时间进行复制，即界面上显示的正常启动）、DUE_TIME（回放到指定时间点）。 |
| DueTime | 是 | 否 | Datetime | 延迟复制类型为 DUE_TIME 有意义，回放的时间点 |
| ReplicationDelay | 是 | 否 | Int64 | 复制延迟，单位为秒 |
NodeInfo
描述实例的各个DB节点信息
被如下接口引用：DescribeDBInstanceDetail、DescribeInstanceNodeInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NodeId | 是 | 否 | String | DB节点ID |
| Role | 是 | 否 | String | DB节点角色，取值为master或者slave |