数据结构
最近更新时间: 2024-09-03 18:49:57
ShardBriefInfo
实例分片信息
被如下接口引用：DescribeDCDBInstanceDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cpu | 是 | 否 | Int64 | 分片Cpu核数 |
| CreateTime | 是 | 否 | Datetime | 分片创建时间 |
| LogDisk | 是 | 否 | Int64 | 分片日志磁盘空间大小，单位GB |
| Memory | 是 | 否 | Int64 | 分片内存大小，单位GB |
| NodeCount | 是 | 否 | Int64 | 分片节点个数 |
| ProxyVersion | 是 | 否 | String | 分片Proxy版本信息 |
| ShardInstanceId | 是 | 否 | String | 分片ID，形如shard-7vg1o339 |
| ShardMasterZone | 是 | 否 | String | 分片主DB可用区 |
| ShardSerialId | 是 | 否 | String | 分片SerialId |
| ShardSlaveZones | 是 | 否 | Array of String | 分片从DB可用区 |
| Status | 是 | 否 | Int64 | 分片运行状态 |
| StatusDesc | 是 | 否 | String | 分片运行状态描述 |
| Storage | 是 | 否 | Int64 | 分片磁盘大小，单位GB |
| StorageUsage | 是 | 否 | Float | 分片磁盘空间使用率 |
| NodesInfo | 是 | 是 | Array of NodeInfo | DB节点信息 |
BriefNodeInfo
描述分片DB节点信息
被如下接口引用：DescribeDCDBInstanceNodeInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NodeId | 是 | 否 | String | DB节点ID |
| Role | 是 | 否 | String | DB节点角色，取值为master或者slave |
| ShardId | 是 | 否 | String | 节点所属分片的分片ID |
LogFileInfo
拉取的日志信息
被如下接口引用：DescribeDBLogFiles
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FileName | 是 | 否 | String | 文件名 |
| Length | 是 | 否 | Uint64 | 文件长度 |
| Mtime | 是 | 否 | Uint64 | Log最后修改时间 |
| Uri | 是 | 否 | String | 下载Log时用到的统一资源标识符 |
ShardZoneChooseInfo
分片节点可用区选择
被如下接口引用：DescribeDCDBSaleInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MasterZone | 是 | 否 | ZonesInfo | 主可用区 |
| SlaveZones | 是 | 否 | Array of ZonesInfo | 可选的从可用区 |
Database
数据库信息
被如下接口引用：DescribeDatabases
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DbName | 是 | 否 | String | 数据库名称 |
ParamModifyResult
修改参数结果
被如下接口引用：ModifyDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Code | 是 | 否 | Int64 | 参数修改结果。0表示修改成功；-1表示修改失败；-2表示该参数值非法 |
| Param | 是 | 否 | String | 修改参数名字 |
ReservedNetResource
保留网络资源
被如下接口引用：DescribeDCDBInstanceDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 否 | 否 | String | 私有网络ID |
| SubnetId | 否 | 否 | String | 子网ID |
| Vip | 否 | 否 | String | 保留的私有网络ip |
| Vports | 否 | 否 | Array of Int64 | 保留的端口号 |
| RecycleTime | 否 | 否 | String | 回收时间 |
SecurityGroup
安全组规则
被如下接口引用：DescribeDBSecurityGroups、DescribeProjectSecurityGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreateTime | 是 | 否 | String | 创建时间，时间格式：yyyy-mm-dd hh:mm:ss。 |
| Inbound | 是 | 否 | Array of Inbound | 入站规则。 |
| Outbound | 是 | 否 | Array of Outbound | 出站规则。 |
| ProjectId | 是 | 否 | Uint64 | 项目ID。 |
| SecurityGroupId | 是 | 否 | String | 安全组ID。 |
| SecurityGroupName | 是 | 否 | String | 安全组名称。 |
| SecurityGroupRemark | 是 | 否 | String | 安全组备注。 |
DBParamValue
云数据库参数信息。
被如下接口引用：CreateHourDCDBInstance、InitDCDBInstances、ModifyDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Param | 是 | 否 | String | 参数名称 |
| Value | 是 | 否 | String | 参数值 |
ExpandShardConfig
升级实例 -- 扩容分片类型
被如下接口引用：UpgradeHourDCDBInstance
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ShardInstanceIds | 是 | 否 | Array of String | 分片ID数组 |
| ShardMemory | 是 | 否 | Int64 | 分片内存大小，单位 GB |
| ShardStorage | 是 | 否 | Int64 | 分片存储大小，单位 GB |
| ShardCpu | 否 | 否 | Int64 | 分片cpu大小，单位：核，可以通过 DescribeShardSpec 查询实例规格获得。 |
| ShardNodeCount | 否 | 是 | Int64 | 分片节点数 |
DatabaseFunction
数据库函数信息
被如下接口引用：DescribeDatabaseObjects
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Func | 是 | 否 | String | 函数名称 |
Project
项目信息描述
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 否 | Int64 | 应用Id |
| CreateTime | 是 | 否 | Datetime | 创建时间 |
| CreatorUin | 是 | 否 | Int64 | 创建者uin |
| Info | 是 | 否 | String | 描述信息 |
| IsDefault | 是 | 否 | Int64 | 是否默认项目，1 是，0 不是 |
| Name | 是 | 否 | String | 项目名称 |
| OwnerUin | 是 | 否 | Int64 | 资源拥有者（主账号）uin |
| ProjectId | 是 | 否 | Int64 | 项目ID |
| SrcAppId | 是 | 否 | Int64 | 来源AppId |
| SrcPlat | 是 | 否 | String | 来源平台 |
| Status | 是 | 否 | Int64 | 项目状态,0正常，-1关闭。默认项目为3 |
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代表的协议和端口集合。 |
ShardInfo
分片信息
被如下接口引用：DescribeDCDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cpu | 是 | 否 | Uint64 | Cpu核数 |
| Createtime | 是 | 否 | String | 创建时间 |
| Memory | 是 | 否 | Int64 | 内存大小，单位 GB |
| NodeCount | 是 | 否 | Int64 | 节点数，2 为一主一从， 3 为一主二从 |
| Pid | 是 | 否 | Int64 | 产品类型 Id（过时字段，请勿依赖该值） |
| ShardId | 是 | 否 | Int64 | 分片数字ID |
| ShardInstanceId | 是 | 否 | String | 分片ID |
| ShardSerialId | 是 | 否 | String | 分片Set ID |
| Status | 是 | 否 | Int64 | 状态：0 创建中，1 流程处理中， 2 运行中，3 分片未初始化，-2 分片已删除 |
| Storage | 是 | 否 | Int64 | 存储大小，单位 GB |
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 | 实例可用区 |
| EncryptStatus | 是 | 否 | Int64 | KMS开启状态，0-未开启，1-已开启 |
Rsip
拉取实例后端RS信息，返回IP和PORT结构体数组
被如下接口引用：DescribeDBInstanceRsip
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip | 是 | 否 | String | Ip地址 |
| Port | 是 | 否 | Int64 | 端口 |
TablePrivilege
表权限
被如下接口引用：ModifyAccountPrivileges
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Database | 是 | 否 | String | 数据库 |
| Table | 是 | 否 | String | 表名 |
| Privileges | 是 | 否 | Array of String | 权限集合 |
DatabaseTable
数据库表信息
被如下接口引用：DescribeDatabaseObjects
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Table | 是 | 否 | String | 表名 |
RegionInfo
售卖可用区信息
被如下接口引用：DescribeDCDBSaleInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AvailableChoice | 是 | 否 | Array of ShardZoneChooseInfo | 可选择的主可用区和从可用区 |
| Region | 是 | 否 | String | 地域英文ID |
| RegionId | 是 | 否 | Int64 | 地域数字ID |
| RegionName | 是 | 否 | String | 地域中文名 |
| ZoneList | 是 | 否 | Array of ZonesInfo | 可用区列表 |
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 | 可用区 |
InstanceShardInfo
TDSQL实例的分片信息
被如下接口引用：DescribeInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ShardInstanceId | 是 | 否 | String | 分片ID |
| ShardSerialId | 是 | 否 | String | 分片的SerialId |
| Status | 是 | 否 | Int64 | 分片的运行状态 |
Permission
描述对资源权限，仅内部使用。
被如下接口引用：AuthenticateCAM
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IsPermitted | 是 | 否 | Int64 | 是否有权限，1 - 有权限， 0 - 无权限 |
| Resource | 是 | 否 | String | 资源对象 |
DBCharsetItem
DB字符集信息
被如下接口引用：DescribeDBCharsets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Version | 否 | 否 | String | DB版本号 |
| DefaultCharset | 否 | 否 | String | DB默认字符集 |
| OptionalCharsets | 否 | 否 | String | DB可选字符集 |
ConstraintRange
约束类型值的范围
被如下接口引用：DescribeDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Max | 是 | 否 | String | 约束类型为section时的最大值 |
| Min | 是 | 否 | String | 约束类型为section时的最小值 |
AddShardConfig
升级实例 -- 新增分片类型
被如下接口引用：UpgradeHourDCDBInstance
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ShardCount | 是 | 否 | Int64 | 新增分片的数量 |
| ShardMemory | 是 | 否 | Int64 | 分片内存大小，单位 GB |
| ShardStorage | 是 | 否 | Int64 | 分片存储大小，单位 GB |
| ShardCpu | 否 | 否 | Int64 | 分片cpu大小，单位：核，可以通过 DescribeShardSpec 查询实例规格获得。 |
ParamConstraint
参数约束
被如下接口引用：DescribeDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Enum | 是 | 否 | String | 约束类型为enum时的可选值列表 |
| Range | 是 | 是 | ConstraintRange | 约束类型为section时的范围 |
| String | 是 | 否 | String | 约束类型为string时的可选值列表 |
| Type | 是 | 否 | String | 约束类型,如枚举enum，区间section |
SpecConfig
按机型分类的规格配置
被如下接口引用：DescribeShardSpec
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Machine | 是 | 否 | String | 规格机型 |
| SpecConfigInfos | 是 | 否 | Array of SpecConfigInfo | 规格列表 |
DBAccount
云数据库账号信息
被如下接口引用：DescribeAccounts
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreateTime | 是 | 否 | Datetime | 创建时间 |
| DelayThresh | 是 | 否 | Int64 | 如果备机延迟超过本参数设置值，系统将认为备机发生故障建议该参数值大于10。当ReadOnly选择1、2时该参数生效。 |
| Description | 是 | 否 | String | 用户备注信息 |
| Host | 是 | 否 | String | 用户可以从哪台主机登录（对应 MySQL 用户的 host 字段，UserName + Host 唯一标识一个用户，IP形式，IP段以%结尾；支持填入%；为空默认等于%） |
| ReadOnly | 是 | 否 | Int64 | 只读标记，0：否， 1：该账号的sql请求优先选择备机执行，备机不可用时选择主机执行，2：优先选择备机执行，备机不可用时操作失败。 |
| UpdateTime | 是 | 否 | Datetime | 最后更新时间 |
| UserName | 是 | 否 | String | 用户名 |
ResourceTag
标签对象，包含tagKey & tagValue
被如下接口引用：CreateHourDCDBInstance、DescribeDCDBInstanceDetail、DescribeDCDBRollbackInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 否 | 否 | String | 标签键key |
| TagValue | 否 | 否 | String | 标签值value |
ColumnPrivilege
字段局权限
被如下接口引用：ModifyAccountPrivileges
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Database | 是 | 否 | String | 数据库 |
| Table | 是 | 否 | String | 表名 |
| Column | 是 | 否 | String | 列名 |
| Privileges | 是 | 否 | Array of String | 权限集合 |
DatabaseView
数据库视图信息
被如下接口引用：DescribeDatabaseObjects
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| View | 是 | 否 | String | 视图名称 |
UserTaskInfo
用户任务信息
被如下接口引用：DescribeUserTasks
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Id | 是 | 否 | Int64 | 任务ID |
| AppId | 是 | 否 | Int64 | 用户账户ID |
| Status | 是 | 否 | Int64 | 任务状态，0-任务初始化中；1-任务运行中；2-任务成功；3-任务失败 |
| UserTaskType | 是 | 否 | Int64 | 任务类型，0-实例回档；1-实例创建；2-实例扩容；3-实例迁移；4-实例删除；5-实例重启 |
| CreateTime | 是 | 否 | Datetime | 任务创建时间 |
| EndTime | 是 | 否 | Datetime | 任务结束时间 |
| ErrMsg | 是 | 否 | String | 任务错误信息 |
| InputData | 是 | 否 | String | 客户端参数 |
| InstanceId | 是 | 否 | String | 实例ID |
| InstanceName | 是 | 否 | String | 实例名称 |
| RegionId | 是 | 否 | Int64 | 地域ID |
FenceInfoItem
独享资源池信息
被如下接口引用：DescribeAvailableExclusiveGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FenceId | 是 | 否 | String | 独享资源池ID |
| FenceName | 否 | 否 | String | 资源池名称 |
| Visibility | 否 | 否 | Int64 | 资源池是否所有人可见。0-所有人不可见；1-所有人可见 |
TableColumn
数据库列信息
被如下接口引用：DescribeDatabaseTable
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Col | 是 | 否 | String | 列名称 |
| Type | 是 | 否 | String | 列类型 |
ParamDesc
DB参数描述
被如下接口引用：DescribeDBParameters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Constraint | 是 | 否 | ParamConstraint | 参数限制 |
| Default | 是 | 否 | String | 系统默认值 |
| HaveSetValue | 是 | 否 | Bool | 是否有设置过值，false:没有设置过值，true:有设置过值。 |
| Param | 是 | 否 | String | 参数名字 |
| SetValue | 是 | 是 | String | 设置过的值，参数生效后，该值和value一样。未设置过就不返回该字段。 |
| Value | 是 | 否 | String | 当前参数值 |
SpecConfigInfo
实例可售卖规格详细信息，创建实例和扩容实例时 NodeCount、Memory 确定售卖规格，硬盘大小可用区间为[MinStorage,MaxStorage]
被如下接口引用：DescribeShardSpec
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cpu | 是 | 否 | Int64 | CPU核数 |
| MaxStorage | 是 | 否 | Int64 | 数据盘规格最大值，单位 GB |
| Memory | 是 | 否 | Int64 | 内存大小，单位 GB |
| MinStorage | 是 | 否 | Int64 | 数据盘规格最小值，单位 GB |
| NodeCount | 是 | 否 | Uint64 | 节点个数，2 表示一主一从，3 表示一主二从 |
| Pid | 是 | 否 | Int64 | 产品类型 Id |
| Qps | 是 | 否 | Int64 | 最大 Qps 值 |
| SuitInfo | 是 | 否 | String | 推荐的使用场景 |
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代表的协议和端口集合。 |
DCDBShardInfo
描述分布式数据库分片信息。
被如下接口引用：DescribeDCDBShards
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Cpu | 是 | 否 | Int64 | CPU核数 |
| CreateTime | 是 | 否 | Datetime | 创建时间 |
| InstanceId | 是 | 否 | String | 所属实例Id |
| Memory | 是 | 否 | Int64 | 内存大小，单位 GB |
| MemoryUsage | 是 | 否 | Float | 内存使用率，单位为 % |
| NodeCount | 是 | 否 | Int64 | 节点数，2 为一主一从， 3 为一主二从 |
| Paymode | 是 | 是 | String | 付费模型 |
| PeriodEndTime | 是 | 否 | Datetime | 到期时间 |
| Pid | 是 | 否 | Int64 | 产品ProductID |
| ProjectId | 是 | 否 | Int64 | 项目ID |
| ProxyVersion | 是 | 否 | String | Proxy版本 |
| Region | 是 | 否 | String | 地域 |
| ShardId | 是 | 否 | Int64 | 数字分片Id（过时字段，请勿依赖该值） |
| ShardInstanceId | 是 | 否 | String | 全局唯一的分片Id |
| ShardMasterZone | 是 | 是 | String | 分片的主可用区 |
| ShardSerialId | 是 | 否 | String | 分片SQL透传Id，用于将sql透传到指定分片执行 |
| ShardSlaveZones | 是 | 是 | Array of String | 分片的从可用区列表 |
| Status | 是 | 否 | Int64 | 状态：0 创建中，1 流程处理中， 2 运行中，3 分片未初始化 |
| StatusDesc | 是 | 否 | String | 状态中文描述 |
| Storage | 是 | 否 | Int64 | 存储大小，单位 GB |
| StorageUsage | 是 | 否 | Float | 存储使用率，单位为 % |
| SubnetId | 是 | 否 | String | 字符串格式的私有网络子网Id |
| VpcId | 是 | 否 | String | 字符串格式的私有网络Id |
| Zone | 是 | 否 | String | 可用区 |
| Range | 是 | 否 | String | 分片ShardKey的范围（总共64个哈希值），例如： 0-31，32-63 |
| CpuArch | 否 | 否 | String | cpu架构 |
DatabaseProcedure
数据库存储过程信息
被如下接口引用：DescribeDatabaseObjects
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Proc | 是 | 否 | String | 存储过程名称 |
InstanceBackupFileItem
实例备份文件详情
被如下接口引用：DescribeBackupFiles
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 否 | 否 | String | 实例ID |
| InstanceName | 否 | 否 | String | 实例名称 |
| InstanceStatus | 否 | 否 | Int64 | 实例状态 |
| ShardId | 否 | 否 | String | 实例内的分片ID |
| FilePath | 否 | 否 | String | 文件路径 |
| FileName | 否 | 否 | String | 文件名称 |
| Url | 否 | 否 | String | 文件下载链接 |
| FileSize | 否 | 否 | Int64 | 文件大小 |
| BackupType | 否 | 否 | String | 备份文件类型 |
| ManualBackup | 否 | 否 | Int64 | 手动备份(仅用于冷备) |
| StartTime | 否 | 否 | String | 开始时间 |
| EndTime | 否 | 否 | String | 结束时间 |
DatabasePrivilege
数据库权限
被如下接口引用：ModifyAccountPrivileges
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Database | 是 | 否 | String | 数据库 |
| Privileges | 是 | 否 | Array of String | 权限集合 |
InstanceResource
数据库实例信息
被如下接口引用：DescribeInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 否 | Int64 | 账户的应用ID |
| ClusterName | 是 | 否 | String | 实例所属集群的名字 |
| DbVersion | 是 | 否 | String | 实例的数据库版本 |
| Id | 是 | 否 | Int64 | 数据库实例的数字ID |
| InstanceId | 是 | 否 | String | 实例ID，形如 dcdbt-ifzc58fh或者tdsqlshard-ifzc58fh |
| InstanceName | 是 | 否 | String | 实例名称 |
| NodeCount | 是 | 否 | Int64 | 实例的节点个数 |
| OriginSerialId | 是 | 否 | String | 实例的原始SerialId |
| Region | 是 | 否 | String | 实例所在地域 |
| SerialId | 是 | 否 | String | 实例的当前SerialId |
| ShardDetail | 是 | 否 | Array of InstanceShardInfo | 分片信息 |
| Status | 是 | 否 | Int64 | 实例运行状态 |
| SubnetId | 是 | 否 | Int64 | 实例所属子网的数字ID |
| UniqueSubnetId | 是 | 否 | String | 实例所属子网的字符串唯一ID |
| UniqueVpcId | 是 | 否 | String | 实例所属VPC的字符串唯一ID |
| Vip | 是 | 否 | String | 实例Vip |
| VpcId | 是 | 否 | Int64 | 实例所属VPC的数字ID |
| Vport | 是 | 否 | Int64 | 实例Vport |
| ZkName | 是 | 否 | String | 实例所属Zk的名字 |
| Zone | 是 | 否 | String | 实例所在可用区 |
| MonitorType | 是 | 否 | Int64 | 表示实例监控页面如何展示 |
ProxyConfigParam
网关配置参数
被如下接口引用：DescribeInstanceProxyConfig
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Param | 是 | 否 | String | 配置参数名称 |
| Value | 是 | 否 | String | 配置参数值 |
DCDBRollbackInstance
回档实例描述
被如下接口引用：DescribeDCDBRollbackInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 否 | 否 | String | 实例ID |
| InstanceName | 否 | 否 | String | 实例名称 |
| Status | 否 | 否 | Uint64 | 实例状态 |
| StatusDesc | 否 | 否 | String | 状态描述 |
| Region | 否 | 否 | String | 地域描述 |
| Zone | 否 | 否 | String | 可用区描述 |
| ProjectId | 否 | 否 | Uint64 | 项目ID |
| NodeCount | 否 | 否 | Uint64 | 节点数，2 为一主一从， 3 为一主二从。 |
| Cpu | 否 | 否 | Uint64 | Cpu核数。 |
| Memory | 否 | 否 | Uint64 | 内存大小，单位 GB。 |
| Storage | 否 | 否 | Uint64 | 存储大小，单位 GB。 |
| VpcId | 否 | 否 | String | 字符串型的私有网络ID。 |
| SubnetId | 否 | 否 | String | 字符串型的私有网络子网ID。 |
| Vip | 否 | 否 | String | 内网IP。 |
| Vport | 否 | 否 | Uint64 | 内网端口。 |
| Ipv6Flag | 否 | 否 | Uint64 | 实例IPv6标志。 |
| Vipv6 | 否 | 否 | String | 内网IPv6。 |
| PayMode | 否 | 否 | String | 付费模式。 |
| RollbackTime | 否 | 否 | String | 回档时间。 |
| PeriodEndTime | 否 | 否 | String | 到期时间。 |
| CreateTime | 否 | 否 | String | 实例创建时间。 |
| IsTmp | 否 | 否 | Uint64 | 1：非临时实例，0：临时实例。 |
| ResourceTags | 否 | 否 | Array of ResourceTag | 实例标签信息。 |
Account
用户信息
被如下接口引用：ModifyAccountPrivileges
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| User | 是 | 否 | String | 用户名 |
| Host | 是 | 否 | String | 用户允许的访问 host，用户名+host唯一确定一个账号。 |
DCDBInstanceInfo
分布式数据库实例信息
被如下接口引用：DescribeDCDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 否 | Int64 | 应用ID |
| AutoRenewFlag | 是 | 否 | Int64 | 自动续费标志 |
| Cpu | 是 | 否 | Uint64 | Cpu核数 |
| CreateTime | 是 | 否 | Datetime | 创建时间 |
| 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 |
| InstanceName | 是 | 否 | String | 实例名称 |
| Ipv6Flag | 是 | 是 | Uint64 | 实例IPv6标志 |
| IsAuditSupported | 是 | 否 | Uint64 | 该实例是否支持审计。1-支持；0-不支持 |
| IsTmp | 是 | 否 | Int64 | 临时实例标记，0 为非临时实例 |
| IsolatedTimestamp | 是 | 否 | Datetime | 隔离时间 |
| Locker | 是 | 是 | Int64 | 实例处于异步任务状态时，表示异步任务流程ID |
| Memory | 是 | 否 | Int64 | 内存大小，单位 GB |
| NodeCount | 是 | 否 | Int64 | 节点数，2 为一主一从， 3 为一主二从 |
| Paymode | 是 | 否 | String | 付费模式 |
| PeriodEndTime | 是 | 否 | Datetime | 到期时间 |
| Pid | 是 | 否 | Int64 | 产品类型 ID（过时字段，请勿依赖该值） |
| ProjectId | 是 | 否 | Int64 | 项目ID |
| Region | 是 | 否 | String | 地域 |
| ShardCount | 是 | 否 | Int64 | 分片个数 |
| ShardDetail | 是 | 否 | Array of ShardInfo | 分片详情 |
| Status | 是 | 否 | Int64 | 状态 |
| StatusDesc | 是 | 否 | String | 状态中文描述 |
| Storage | 是 | 否 | Int64 | 存储大小，单位 GB |
| SubnetId | 是 | 否 | Int64 | Subnet数字ID |
| Uin | 是 | 否 | String | 账号ID |
| UniqueSubnetId | 是 | 否 | String | 字符串型的私有网络子网ID |
| UniqueVpcId | 是 | 否 | String | 字符串型的私有网络ID |
| UpdateTime | 是 | 否 | Datetime | 实例最后更新时间，格式为 2006-01-02 15:04:05 |
| Vip | 是 | 否 | String | 内网IP |
| Vipv6 | 是 | 是 | String | 内网IPv6 |
| VpcId | 是 | 否 | Int64 | VPC数字ID |
| 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 | 可用区 |
| InstanceType | 是 | 是 | Int64 | 1： 主实例（独享型）, 2: 主实例, 3： 灾备实例, 4： 灾备实例（独享型） |
| CpuArch | 否 | 否 | String | Cpu架构 |
| ExclusterName | 否 | 否 | String | 资源池名称 |
DBEngineInfo
数据库引擎信息
被如下接口引用：DescribeDBEngines
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Description | 是 | 否 | String | 引擎描述 |
| Name | 是 | 否 | String | 引擎名称，eg. 基于MariaDB 10.1.9 分支 |
| Type | 是 | 否 | String | 引擎类型，MariaDB|Percona |
| Version | 是 | 否 | String | 引擎版本，eg. 10.1.9 |
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 | 帐号 |
MonitorShardInfo
分片信息
被如下接口引用：DescribeDCDBInstanceShardInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ShardId | 是 | 否 | String | 分片ID |
NodeInfo
描述DB节点信息
被如下接口引用：DescribeDCDBInstanceDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NodeId | 是 | 否 | String | DB节点ID |
| Role | 是 | 否 | String | DB节点角色，取值为master或者slave |
ZonesInfo
可用区信息
被如下接口引用：DescribeDCDBSaleInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Zone | 是 | 否 | String | 可用区英文ID |
| ZoneId | 是 | 否 | Int64 | 可用区数字ID |
| ZoneName | 是 | 否 | String | 可用区中文名 |
SplitShardConfig
升级实例 -- 切分分片类型
被如下接口引用：UpgradeHourDCDBInstance
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ShardInstanceIds | 是 | 否 | Array of String | 分片ID数组 |
| ShardMemory | 是 | 否 | Int64 | 分片内存大小，单位 GB |
| ShardStorage | 是 | 否 | Int64 | 分片存储大小，单位 GB |
| SplitRate | 是 | 否 | Int64 | 数据切分比例 |
| ShardCpu | 否 | 否 | Int64 | 分片cpu大小，单位：核，可以通过 DescribeShardSpec 查询实例规格获得。 |
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 | 实例所在可用区 |