有奖捉虫:云通信与企业服务文档专题,速来> HOT

Account

数据库账号信息

被如下接口引用:CreateAccounts, DeleteAccounts, ModifyAccountDescription, ModifyAccountMaxUserConnections, ModifyAccountPassword, ModifyAccountPrivileges。

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

AccountInfo

账号详细信息

被如下接口引用:DescribeAccounts。

名称 类型 描述
Notes String 账号备注信息
示例值:your note
Host String 账号的域名
示例值:%
User String 账号的名称
示例值:root
ModifyTime Timestamp 账号信息修改时间
示例值:2020-09-09 16:40:30
ModifyPasswordTime Timestamp 修改密码的时间
示例值:2020-09-09 16:40:30
CreateTime Timestamp 该值已废弃
示例值:''
MaxUserConnections Integer 用户最大可用实例连接数
示例值:10240

AggregationCondition

审计日志聚合条件

被如下接口引用:AnalyzeAuditLogs。

名称 类型 必选 描述
AggregationField String 聚合字段。目前仅支持host-源IP、user-用户名、dbName-数据库名、sqlType-sql类型。
示例值:host
Offset Integer 偏移量。
Limit Integer 该聚合字段下要返回聚合桶的数量,最大100。

AuditFilter

审计规则过滤条件

被如下接口引用:CreateAuditRule, DescribeAuditRules, ModifyAuditRule。

名称 类型 必选 描述
Type String 过滤条件参数名称。目前支持:
SrcIp – 客户端 IP;
User – 数据库账户;
DB – 数据库名称;
Compare String 过滤条件匹配类型。目前支持:
INC – 包含;
EXC – 不包含;
EQ – 等于;
NEQ – 不等于;
Value String 过滤条件匹配值。

AuditInstanceFilters

查询审计实例的过滤条件

被如下接口引用:DescribeAuditInstanceList。

名称 类型 必选 描述
Name String 过滤条件名。支持InstanceId-实例ID,InstanceName-实例名称,ProjectId-项目ID,TagKey-标签键,Tag-标签(以竖线分割,例:Tagkey|Tagvalue)。
示例值:InstanceId
ExactMatch Boolean true表示精确查找,false表示模糊匹配。
示例值:true
Values Array of String 筛选值
示例值:cdb-euu5fkcj

AuditInstanceInfo

审计实例详情

被如下接口引用:DescribeAuditInstanceList。

名称 类型 描述
ProjectId Integer 项目ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:23414
TagList Array of TagInfoUnit 标签信息
注意:此字段可能返回 null,表示取不到有效值。
DbType String 数据库内核类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:MYSQL
DbVersion String 数据库内核版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:5.7

AuditLog

审计日志详细信息

被如下接口引用:DescribeAuditLogs。

名称 类型 描述
AffectRows Integer 影响行数。
示例值:0
ErrCode Integer 错误码。
示例值:0
SqlType String SQL 类型。
示例值:“SELECT”
PolicyName String 审计策略名称,逐步下线。
示例值:“sys_default”
DBName String 数据库名称。
示例值:“test_db”
Sql String SQL 语句。
示例值:“SELECT * FROM test LIMIT 1;"
Host String 客户端地址。
示例值:“10.0.10.3”
User String 用户名。
示例值:“Test”
ExecTime Integer 执行时间,微秒。
示例值:ExecTime
Timestamp String 时间。
示例值:"2023-06-17 17:50:05"
SentRows Integer 返回行数。
示例值:0
ThreadId Integer 线程ID。
示例值:1015
CheckRows Integer 扫描行数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CpuTime Float cpu执行时间,微秒。
注意:此字段可能返回 null,表示取不到有效值。
示例值:289.474
IoWaitTime Integer IO等待时间,微秒。
注意:此字段可能返回 null,表示取不到有效值。
示例值:11
LockWaitTime Integer 锁等待时间,微秒。
注意:此字段可能返回 null,表示取不到有效值。
示例值:57
NsTime Integer 开始时间,与timestamp构成一个精确到纳秒的时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:106483229
TrxLivingTime Integer 事物持续时间,微秒。
注意:此字段可能返回 null,表示取不到有效值。
TemplateInfo Array of LogRuleTemplateInfo 日志命中规则模板的基本信息
注意:此字段可能返回 null,表示取不到有效值。

AuditLogAggregationResult

审计日志分析结果

被如下接口引用:AnalyzeAuditLogs。

名称 类型 描述
AggregationField String 聚合维度
注意:此字段可能返回 null,表示取不到有效值。
示例值:host
Buckets Array of Bucket 聚合桶的结果集
注意:此字段可能返回 null,表示取不到有效值。

AuditLogFile

审计日志文件

被如下接口引用:DescribeAuditLogFiles。

名称 类型 描述
FileName String 审计日志文件名称
CreateTime String 审计日志文件创建时间。格式为 : "2019-03-20 17:09:13"。
Status String 文件状态值。可能返回的值为:
"creating" - 生成中;
"failed" - 创建失败;
"success" - 已生成;
FileSize Integer 文件大小,单位为 KB。
注意:此字段可能返回 null,表示取不到有效值。
DownloadUrl String 审计日志下载地址。
注意:此字段可能返回 null,表示取不到有效值。
ErrMsg String 错误信息。
注意:此字段可能返回 null,表示取不到有效值。

AuditLogFilter

审计日志过滤条件。查询审计日志时,用户过滤返回的审计日志。

被如下接口引用:AnalyzeAuditLogs, CreateAuditLogFile。

名称 类型 必选 描述
Host Array of String 客户端地址。
User Array of String 用户名。
DBName Array of String 数据库名称。
TableName Array of String 表名称。
PolicyName Array of String 审计策略名称。
Sql String SQL 语句。支持模糊匹配。
示例值:“”
SqlType String SQL 类型。目前支持:"SELECT", "INSERT", "UPDATE", "DELETE", "CREATE", "DROP", "ALTER", "SET", "REPLACE", "EXECUTE"。
ExecTime Integer 执行时间。单位为:ms。表示筛选执行时间大于该值的审计日志。
示例值:1
AffectRows Integer 影响行数。表示筛选影响行数大于该值的审计日志。
示例值:1
SqlTypes Array of String SQL 类型。支持多个类型同时查询。目前支持:"SELECT", "INSERT", "UPDATE", "DELETE", "CREATE", "DROP", "ALTER", "SET", "REPLACE", "EXECUTE"。
Sqls Array of String SQL 语句。支持传递多个sql语句。
AffectRowsSection String 影响行数,格式为M-N,例如:10-200
SentRowsSection String 返回行数,格式为M-N,例如:10-200
ExecTimeSection String 执行时间,格式为M-N,例如:10-200
LockWaitTimeSection String 锁等待时间,格式为M-N,例如:10-200
IoWaitTimeSection String IO等待时间,格式为M-N,例如:10-200
TransactionLivingTimeSection String 事务持续时间,格式为M-N,例如:10-200
ThreadId Array of String 线程ID
SentRows Integer 返回行数。表示筛选返回行数大于该值的审计日志。
示例值:1
ErrCode Array of Integer mysql错误码

AuditPolicy

审计策略

被如下接口引用:DescribeAuditPolicies。

名称 类型 描述
PolicyId String 审计策略 ID。
示例值:cdbpolicy-g78s8xn6
Status String 审计策略的状态。可能返回的值为:
"creating" - 创建中;
"running" - 运行中;
"paused" - 暂停中;
"failed" - 创建失败。
示例值:running
InstanceId String 数据库实例 ID。
示例值:cdb-pr1rb3j9
CreateTime String 审计策略创建时间。格式为 : "2019-03-20 17:09:13"。
示例值:2021-02-15 15:24:22
ModifyTime String 审计策略最后修改时间。格式为 : "2019-03-20 17:09:13"。
示例值:2022-01-15 15:24:22
PolicyName String 审计策略名称。
示例值:fullaudit
RuleId String 审计规则 ID。
示例值:cdbrule-11o5fvz2
RuleName String 审计规则名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:allrule
InstanceName String 数据库实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test

AuditRule

审计规则

被如下接口引用:DescribeAuditRules。

名称 类型 描述
RuleId String 审计规则 Id。
CreateTime String 审计规则创建时间。格式为 : "2019-03-20 17:09:13"。
ModifyTime String 审计规则最后修改时间。格式为 : "2019-03-20 17:09:13"。
RuleName String 审计规则名称。
注意:此字段可能返回 null,表示取不到有效值。
Description String 审计规则描述。
注意:此字段可能返回 null,表示取不到有效值。
RuleFilters Array of AuditFilter 审计规则过滤条件。
注意:此字段可能返回 null,表示取不到有效值。
AuditAll Boolean 是否开启全审计。

AuditRuleFilters

审计规则的过滤条件

被如下接口引用:ModifyAuditService, OpenAuditService。

名称 类型 必选 描述
RuleFilters Array of RuleFilters 单条审计规则。
注意:此字段可能返回 null,表示取不到有效值。

AuditRuleTemplateInfo

审计规则模板的详情

被如下接口引用:DescribeAuditRuleTemplates。

名称 类型 描述
RuleTemplateId String 规则模板ID。
示例值:cdb-art-dnpg9p3r
RuleTemplateName String 规则模板名称。
RuleFilters Array of RuleFilters 规则模板的过滤条件。
Description String 规则模板描述。
注意:此字段可能返回 null,表示取不到有效值。
CreateAt String 规则模板创建时间。
示例值:2022-11-15 11:11:11
AlarmLevel Integer 告警等级。1-低风险,2-中风险,3-高风险。
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
AlarmPolicy Integer 告警策略。0-不告警,1-告警。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AffectedInstances Array of String 规则模板应用在哪些在实例。
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 模板状态。0-无任务 ,1-修改中。
注意:此字段可能返回 null,表示取不到有效值。
UpdateAt String 模板更新时间。
注意:此字段可能返回 null,表示取不到有效值。

AutoStrategy

CPU弹性扩容的自动扩容策略

被如下接口引用:StartCpuExpand。

名称 类型 必选 描述
ExpandThreshold Integer 自动扩容阈值,可选值70、80、90,代表CPU利用率达到70%、80%、90%时后台进行自动扩容
示例值:70
ExpandPeriod Integer 自动扩容观测周期,单位s,可选值1、3、5、10、15、30。后台会按照配置的周期进行扩容判断。
示例值:1
ShrinkThreshold Integer 自动缩容阈值,可选值10、20、30,代表CPU利用率达到10%、20%、30%时后台进行自动缩容
示例值:10
ShrinkPeriod Integer 自动缩容观测周期,单位s,可选值5、10、15、30。后台会按照配置的周期进行缩容判断。
示例值:5

BackupConfig

ECDB第二个从库的配置信息,只有ECDB实例才有这个字段

被如下接口引用:DescribeDBInstanceConfig。

名称 类型 描述
ReplicationMode String 第二个从库复制方式,可能的返回值:async-异步,semisync-半同步
Zone String 第二个从库可用区的正式名称,如ap-shanghai-1
Vip String 第二个从库内网IP地址
Vport Integer 第二个从库访问端口

BackupInfo

备份详细信息

被如下接口引用:DescribeBackups。

名称 类型 描述
Name String 备份文件名
示例值:XXX
Size Integer 备份文件大小,单位:Byte
示例值:1024
Date String 备份快照时间,时间格式:2016-03-17 02:10:37
示例值:2016-03-17 02:10:37
IntranetUrl String 下载地址
示例值:https://XXX
InternetUrl String 下载地址
示例值:https://XXX
Type String 日志具体类型。可能的值有 "logical": 逻辑冷备, "physical": 物理冷备。
示例值:physical
BackupId Integer 备份子任务的ID,删除备份文件时使用
示例值:1000
Status String 备份任务状态。可能的值有 "SUCCESS": 备份成功, "FAILED": 备份失败, "RUNNING": 备份进行中。
示例值:SUCCESS
FinishTime String 备份任务的完成时间
示例值:2016-03-17 02:11:37
Creator String (该值将废弃,不建议使用)备份的创建者,可能的值:SYSTEM - 系统创建,Uin - 发起者Uin值。
示例值:SYSTEM
StartTime String 备份任务的开始时间
示例值:2016-03-17 02:00:37
Method String 备份方法。可能的值有 "full": 全量备份, "partial": 部分备份。
示例值:full
Way String 备份方式。可能的值有 "manual": 手动备份, "automatic": 自动备份。
示例值:automatic
ManualBackupName String 手动备份别名
示例值:""
SaveMode String 备份保留类型,save_mode_regular - 常规保存备份,save_mode_period - 定期保存备份
示例值:save_mode_regular
Region String 本地备份所在地域
示例值:ap-guangzhou
RemoteInfo Array of RemoteBackupInfo 异地备份详细信息
CosStorageType Integer 存储方式,0-常规存储,1-归档存储,默认为0
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
EncryptionFlag String 备份文件是否加密, on-加密, off-未加密
注意:此字段可能返回 null,表示取不到有效值。
示例值:on
ExecutedGTIDSet String 备份GTID点位
注意:此字段可能返回 null,表示取不到有效值。

BackupItem

创建备份时,指定需要备份的库表信息

被如下接口引用:CreateBackup。

名称 类型 必选 描述
Db String 需要备份的库名
Table String 需要备份的表名。 如果传该参数,表示备份该库中的指定表。如果不传该参数则备份该db库

BackupLimitVpcItem

备份文件限制下载来源VPC设置项

被如下接口引用:DescribeBackupDownloadRestriction, ModifyBackupDownloadRestriction。

名称 类型 必选 描述
Region String 限制下载来源的地域。目前仅支持当前地域。
示例值:ap-guangzhou
VpcList Array of String 限制下载的vpc列表。
示例值:["vpc-XX1", "vpc-XX2"]

BackupSummaryItem

实例备份统计项

被如下接口引用:DescribeBackupSummaries。

名称 类型 描述
InstanceId String 实例ID。
AutoBackupCount Integer 该实例自动数据备份的个数。
AutoBackupVolume Integer 该实例自动数据备份的容量。
ManualBackupCount Integer 该实例手动数据备份的个数。
ManualBackupVolume Integer 该实例手动数据备份的容量。
DataBackupCount Integer 该实例总的数据备份(包含自动备份和手动备份)个数。
DataBackupVolume Integer 该实例总的数据备份容量。
BinlogBackupCount Integer 该实例日志备份的个数。
BinlogBackupVolume Integer 该实例日志备份的容量。
BackupVolume Integer 该实例的总备份(包含数据备份和日志备份)占用容量。

BinlogInfo

二进制日志信息

被如下接口引用:DescribeBinlogs。

名称 类型 描述
Name String binlog 日志备份文件名
示例值:XXX
Size Integer 备份文件大小,单位:Byte
示例值:1024
Date Timestamp 文件存储时间,时间格式:2016-03-17 02:10:37
示例值:2016-03-17 02:11:37
IntranetUrl String 下载地址
示例值:https://XXX
InternetUrl String 下载地址
示例值:https://XXX
Type String 日志具体类型,可能的值有:binlog - 二进制日志
示例值:binlog
BinlogStartTime String binlog 文件起始时间
示例值:2016-03-17 02:08:37
BinlogFinishTime String binlog 文件截止时间
示例值:2016-03-17 02:10:37
Region String 本地binlog文件所在地域
示例值:ap-guangzhou
Status String 备份任务状态。可能的值有 "SUCCESS": 备份成功, "FAILED": 备份失败, "RUNNING": 备份进行中。
示例值:SUCCESS
RemoteInfo Array of RemoteBackupInfo binlog异地备份详细信息
CosStorageType Integer 存储方式,0-常规存储,1-归档存储,默认为0
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。

Bucket

聚合桶的信息

被如下接口引用:AnalyzeAuditLogs。

名称 类型 描述
Key String
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.0.0.8
Count Integer key值出现的次数。
示例值:26

CdbRegionSellConf

地域售卖配置

被如下接口引用:DescribeCdbZoneConfig。

名称 类型 描述
RegionName String 地域中文名称
示例值:广州
Area String 所属大区
示例值:华南地区
IsDefaultRegion Integer 是否为默认地域
示例值:1
Region String 地域名称
示例值:ap-guangzhou
RegionConfig Array of CdbZoneSellConf 地域的可用区售卖配置
示例值:[]

CdbSellConfig

售卖配置详情

被如下接口引用:DescribeCdbZoneConfig。

名称 类型 描述
Memory Integer 内存大小,单位为MB
示例值:1000
Cpu Integer CPU核心数
示例值:1
VolumeMin Integer 磁盘最小规格,单位为GB
示例值:50
VolumeMax Integer 磁盘最大规格,单位为GB
示例值:3000
VolumeStep Integer 磁盘步长,单位为GB
示例值:5
Iops Integer 每秒IO数量
示例值:6000
Info String 应用场景描述
示例值:***
Status Integer 状态值,0 表示该规格对外售卖
示例值:0
DeviceType String 实例类型,可能的取值范围有:UNIVERSAL (通用型), EXCLUSIVE (独享型), BASIC (基础型), BASIC_V2 (基础型v2)
注意:此字段可能返回 null,表示取不到有效值。
示例值:UNIVERSAL
EngineType String 引擎类型描述,可能的取值范围有:Innodb,RocksDB
示例值:InnoDB
Id Integer 售卖规格Id
示例值:1

CdbSellType

售卖实例类型

被如下接口引用:DescribeCdbZoneConfig。

名称 类型 描述
TypeName String 售卖实例名称。Z3是高可用类型对应规格中的DeviceType包含UNIVERSAL,EXCLUSIVE;CVM是基础版类型对应规格中的DeviceType是BASIC;TKE是基础型v2类型对应规格中的DeviceType是BASIC_V2。
示例值:Z3
EngineVersion Array of String 引擎版本号
示例值:["5.6","5.7"]
ConfigIds Array of Integer 售卖规格Id
示例值:[1,2,3]

CdbZoneDataResult

各地域可售卖的规格配置

被如下接口引用:DescribeCdbZoneConfig。

名称 类型 描述
Configs Array of CdbSellConfig 售卖规格所有集合
示例值:[]
Regions Array of CdbRegionSellConf 售卖地域可用区集合
示例值:[]

CdbZoneSellConf

可用区售卖配置

被如下接口引用:DescribeCdbZoneConfig。

名称 类型 描述
Status Integer 可用区状态。可能的返回值为:1-上线;3-停售;4-不展示
示例值:1
ZoneName String 可用区中文名称
示例值:广州二区
IsCustom Boolean 实例类型是否为自定义类型
示例值:true
IsSupportDr Boolean 是否支持灾备
示例值:true
IsSupportVpc Boolean 是否支持私有网络
示例值:true
HourInstanceSaleMaxNum Integer 小时计费实例最大售卖数量
示例值:100
IsDefaultZone Boolean 是否为默认可用区
示例值:true
IsBm Boolean 是否为黑石区
示例值:true
PayType Array of String 支持的付费类型。可能的返回值为:0-包年包月;1-小时计费;2-后付费
示例值:["0","1"]
ProtectMode Array of String 数据复制类型。0-异步复制;1-半同步复制;2-强同步复制
示例值:["0","1","2"]
Zone String 可用区名称
示例值:ap-guangzhou-2
ZoneConf ZoneConf 多可用区信息
示例值:{}
DrZone Array of String 可支持的灾备可用区信息
示例值:["ap-guangzhou-2"]
IsSupportRemoteRo Boolean 是否支持跨可用区只读
示例值:true
RemoteRoZone Array of String 可支持的跨可用区只读区信息
示例值:["ap-guangzhou-2"]
ExClusterStatus Integer 独享型可用区状态。可能的返回值为:1-上线;3-停售;4-不展示
示例值:1
ExClusterRemoteRoZone Array of String 独享型可支持的跨可用区只读区信息
示例值:["ap-guangzhou-2"]
ExClusterZoneConf ZoneConf 独享型多可用区信息
示例值:{}
SellType Array of CdbSellType 售卖实例类型数组,其中configIds的值与configs结构体中的id一一对应。
示例值:[]
ZoneId Integer 可用区id
示例值:200001
IsSupportIpv6 Boolean 是否支持ipv6
示例值:fasle
EngineType Array of String 可支持的售卖数据库引擎类型
示例值:["InnoDB","RocksDB"]

CloneItem

克隆任务记录。

被如下接口引用:DescribeCloneList。

名称 类型 描述
SrcInstanceId String 克隆任务的源实例Id。
示例值:""
DstInstanceId String 克隆任务的新产生实例Id。
示例值:""
CloneJobId Integer 克隆任务对应的任务列表Id。
示例值:1
RollbackStrategy String 克隆实例使用的策略, 包括以下类型: timepoint:指定时间点回档, backupset: 指定备份文件回档。
示例值:""
RollbackTargetTime String 克隆实例回档的时间点。
示例值:""
StartTime String 任务开始时间。
示例值:""
EndTime String 任务结束时间。
示例值:""
TaskStatus String 任务状态,包括以下状态:initial,running,wait_complete,success,failed
示例值:""
NewRegionId Integer 克隆实例所在地域Id
示例值:1
SrcRegionId Integer 源实例所在地域Id
示例值:2

ColumnPrivilege

列权限信息

被如下接口引用:DescribeAccountPrivileges, ModifyAccountPrivileges。

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

CommonTimeWindow

通用时间窗

被如下接口引用:DescribeBackupConfig, ModifyBackupConfig。

名称 类型 必选 描述
Monday String 周一的时间窗,格式如: 02:00-06:00
示例值:02:00-06:00
Tuesday String 周二的时间窗,格式如: 02:00-06:00
示例值:02:00-06:00
Wednesday String 周三的时间窗,格式如: 02:00-06:00
示例值:02:00-06:00
Thursday String 周四的时间窗,格式如: 02:00-06:00
示例值:02:00-06:00
Friday String 周五的时间窗,格式如: 02:00-06:00
示例值:02:00-06:00
Saturday String 周六的时间窗,格式如: 02:00-06:00
示例值:02:00-06:00
Sunday String 周日的时间窗,格式如: 02:00-06:00
示例值:02:00-06:00
BackupPeriodStrategy String 常规备份保留策略,weekly-按周备份,monthly-按月备份,默认为weekly
示例值:weekly
Days Array of Integer 如果设置为按月备份,需填入每月具体备份日期,相邻备份天数不得超过两天。例[1,4,7,9,11,14,17,19,22,25,28,30,31]
示例值:[1,4,7,9,11,14,17,19,22,25,28,30,31]
BackupPeriodTime String 月度备份时间窗,BackupPeriodStrategy为monthly时必填。格式如: 02:00-06:00
示例值:02:00-06:00

CustomConfig

proxy配置

被如下接口引用:DescribeProxyCustomConf。

名称 类型 描述
Device String 设备
注意:此字段可能返回 null,表示取不到有效值。
Type String 类型
注意:此字段可能返回 null,表示取不到有效值。
DeviceType String 设备类型
注意:此字段可能返回 null,表示取不到有效值。
Memory Integer 内存
注意:此字段可能返回 null,表示取不到有效值。
Cpu Integer 核数
注意:此字段可能返回 null,表示取不到有效值。

DBSwitchInfo

云数据库切换记录

被如下接口引用:DescribeDBSwitchRecords。

名称 类型 描述
SwitchTime Timestamp 切换时间,格式为:2017-09-03 01:34:31
SwitchType String 切换类型,可能的返回值为:TRANSFER - 数据迁移;MASTER2SLAVE - 主备切换;RECOVERY - 主从恢复

DatabasePrivilege

数据库权限

被如下接口引用:DescribeAccountPrivileges, ModifyAccountPrivileges。

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

DatabasesWithCharacterLists

数据库名以及字符集

被如下接口引用:DescribeDatabases。

名称 类型 描述
DatabaseName String 数据库名
示例值:""
CharacterSet String 字符集类型
示例值:""

DeployGroupInfo

置放群组信息

被如下接口引用:DescribeDeployGroupList。

名称 类型 描述
DeployGroupId String 置放群组 ID。
DeployGroupName String 置放群组名称。
CreateTime String 创建时间。
Quota Integer 置放群组实例配额,表示一个置放群组中可容纳的最大实例数目。
Affinity String 置放群组亲和性策略,目前仅支持策略1,即在物理机纬度打散实例的分布。
注意:此字段可能返回 null,表示取不到有效值。
LimitNum Integer 置放群组亲和性策略1中,同台物理机上同个置放群组实例的限制个数。
注意:此字段可能返回 null,表示取不到有效值。
Description String 置放群组详细信息。
DevClass String 置放群组物理机型属性。
注意:此字段可能返回 null,表示取不到有效值。

DeviceCpuInfo

CPU负载

被如下接口引用:DescribeDeviceMonitorInfo。

名称 类型 描述
Rate Array of DeviceCpuRateInfo 实例CPU平均使用率
Load Array of Integer 实例CPU监控数据

DeviceCpuRateInfo

实例CPU平均使用率

被如下接口引用:DescribeDeviceMonitorInfo。

名称 类型 描述
CpuCore Integer Cpu核编号
Rate Array of Integer Cpu使用率

DeviceDiskInfo

实例磁盘监控数据

被如下接口引用:DescribeDeviceMonitorInfo。

名称 类型 描述
IoRatioPerSec Array of Integer 平均每秒有百分之几的时间用于IO操作
IoWaitTime Array of Integer 平均每次设备I/O操作的等待时间*100,单位为毫秒。例如:该值为201,表示平均每次I/O操作等待时间为:201/100=2.1毫秒
Read Array of Integer 磁盘平均每秒完成的读操作次数总和*100。例如:该值为2002,表示磁盘平均每秒完成读操作为:2002/100=20.2次
Write Array of Integer 磁盘平均每秒完成的写操作次数总和*100。例如:该值为30001,表示磁盘平均每秒完成写操作为:30001/100=300.01次
CapacityRatio Array of Integer 磁盘空间容量,每两个一组,第一个为已使用容量,第二个为磁盘总容量

DeviceMemInfo

实例所在物理机内存监控信息

被如下接口引用:DescribeDeviceMonitorInfo。

名称 类型 描述
Total Array of Integer 总内存大小。free命令中Mem:一行total的值,单位:KB
Used Array of Integer 已使用内存。free命令中Mem:一行used的值,单位:KB

DeviceNetInfo

实例所在物理机网络监控信息

被如下接口引用:DescribeDeviceMonitorInfo。

名称 类型 描述
Conn Array of Integer tcp连接数
PackageIn Array of Integer 网卡入包量,单位:个/秒
PackageOut Array of Integer 网卡出包量,单位:个/秒
FlowIn Array of Integer 入流量,单位:kbps
FlowOut Array of Integer 出流量,单位:kbps

DrInfo

灾备实例信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
Status Integer 灾备实例状态
示例值:1
Zone String 可用区信息
示例值:ap-beijing-3
InstanceId String 实例ID
示例值:cdb-***
Region String 地域信息
示例值:ap-beijing
SyncStatus Integer 实例同步状态。可能的返回值为:
0 - 灾备未同步;
1 - 灾备同步中;
2 - 灾备同步成功;
3 - 灾备同步失败;
4 - 灾备同步修复中。
示例值:2
InstanceName String 实例名称
示例值:**
InstanceType Integer 实例类型
示例值:2

ErrlogItem

结构化的错误日志详情

被如下接口引用:DescribeErrorLogData。

名称 类型 描述
Timestamp Integer 错误发生时间。
注意:此字段可能返回 null,表示取不到有效值。
Content String 错误详情
注意:此字段可能返回 null,表示取不到有效值。

ImportRecord

导入任务记录

被如下接口引用:DescribeDBImportRecords。

名称 类型 描述
Status Integer 状态值
Code Integer 状态值
CostTime Integer 执行时间
InstanceId String 实例ID
WorkId String 后端任务ID
FileName String 导入文件名
Process Integer 执行进度
CreateTime Timestamp 任务创建时间
FileSize String 文件大小
Message String 任务执行信息
JobId Integer 任务ID
DbName String 导入库表名
AsyncRequestId String 异步任务的请求ID

Inbound

安全组入站规则

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

名称 类型 描述
Action String 策略,ACCEPT 或者 DROP
示例值:ACCEPT
CidrIp String 来源 IP 或 IP 段,例如192.168.0.0/16
示例值:192.168.0.0/16
PortRange String 端口
示例值:ALL
IpProtocol String 网络协议,支持 UDP、TCP 等
示例值:ALL
Dir String 规则限定的方向,进站规则为 INPUT
示例值:‘’
AddressModule String 地址模块
示例值:‘’
Desc String 规则描述
示例值:放通内网

InstanceAuditLogFilters

审计日志搜索过滤器

被如下接口引用:AnalyzeAuditLogs, CreateAuditLogFile, DescribeAuditLogs。

名称 类型 必选 描述
Type String 过滤项。目前支持以下搜索条件:

包含、不包含、包含(分词维度)、不包含(分词维度):
sql - SQL详情;alarmLevel - 告警等级;ruleTemplateId - 规则模板Id

等于、不等于、包含、不包含:
host - 客户端地址;
user - 用户名;
dbName - 数据库名称;

等于、不等于:
sqlType - SQL类型;
errCode - 错误码;
threadId - 线程ID;

范围搜索(时间类型统一为微秒):
execTime - 执行时间;
lockWaitTime - 执行时间;
ioWaitTime - IO等待时间;
trxLivingTime - 事物持续时间;
cpuTime - cpu时间;
checkRows - 扫描行数;
affectRows - 影响行数;
sentRows - 返回行数。
示例值:host
Compare String 过滤条件。支持以下条件:
WINC-包含(分词维度),
WEXC-不包含(分词维度),
INC - 包含,
EXC - 不包含,
EQS - 等于,
NEQ - 不等于,
RA - 范围。
示例值:EXC
Value Array of String 过滤的值。反向查询时,多个值之前是且的关系,正向查询多个值是或的关系
示例值:10.0.

InstanceDbAuditStatus

实例审计详情信息

被如下接口引用:DescribeAuditInstanceList。

名称 类型 描述
InstanceId String 实例ID。
示例值:cdb-euu5fkcj
AuditStatus String 审计状态。ON-表示审计已开启,OFF-表示审计关闭
示例值:ON
AuditTask Integer 任务状态。0-无任务;1-审计开启中,2-审计关闭中。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
LogExpireDay Integer 日志保留时长。
注意:此字段可能返回 null,表示取不到有效值。
示例值:30
HighLogExpireDay Integer 高频存储时长。
注意:此字段可能返回 null,表示取不到有效值。
示例值:7
LowLogExpireDay Integer 低频存储时长。
注意:此字段可能返回 null,表示取不到有效值。
示例值:23
BillingAmount Float 日志存储量。
注意:此字段可能返回 null,表示取不到有效值。
示例值:173749.248
HighRealStorage Float 高频存储量。
注意:此字段可能返回 null,表示取不到有效值。
示例值:45639.68
LowRealStorage Float 低频存储量。
注意:此字段可能返回 null,表示取不到有效值。
示例值:128109.568
AuditAll Boolean 是否为全审计。true-表示全审计。
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
CreateAt String 审计开通时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-10-12 11:41:42
InstanceInfo AuditInstanceInfo 实例相关信息
注意:此字段可能返回 null,表示取不到有效值。
RealStorage Float 总存储量。
注意:此字段可能返回 null,表示取不到有效值。
示例值:173749.248
OldRule Boolean 是否包含审计策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
RuleTemplateIds Array of String 实例所应用的规则模板。
注意:此字段可能返回 null,表示取不到有效值。

InstanceInfo

实例详细信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
WanStatus Integer 外网状态,可能的返回值为:0-未开通外网;1-已开通外网;2-已关闭外网
示例值:0
Zone String 可用区信息
示例值:ap-beijing-3
InitFlag Integer 初始化标志,可能的返回值为:0-未初始化;1-已初始化
示例值:1
RoVipInfo RoVipInfo 只读vip信息。单独开通只读实例访问的只读实例才有该字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
Memory Integer 内存容量,单位为 MB
示例值:1000
Status Integer 实例状态,可能的返回值:0-创建中;1-运行中;4-正在进行隔离操作;5-已隔离
示例值:1
VpcId Integer 私有网络 ID,例如:51102
示例值:51102
SlaveInfo SlaveInfo 备机信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
InstanceId String 实例 ID
示例值:cdb-***
Volume Integer 硬盘容量,单位为 GB
示例值:50
AutoRenew Integer 自动续费标志,可能的返回值:0-未开通自动续费;1-已开通自动续费;2-已关闭自动续费
示例值:1
ProtectMode Integer 数据复制方式。0 - 异步复制;1 - 半同步复制;2 - 强同步复制
示例值:0
RoGroups Array of RoGroup 只读组详细信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
SubnetId Integer 子网 ID,例如:2333
示例值:2333
InstanceType Integer 实例类型,可能的返回值:1-主实例;2-灾备实例;3-只读实例
示例值:1
ProjectId Integer 项目 ID
示例值:0
Region String 地域信息
示例值:ap-beijing
DeadlineTime Timestamp 实例到期时间
示例值:2020-09-29 08:37:33
DeployMode Integer 可用区部署方式。可能的值为:0 - 单可用区;1 - 多可用区
示例值:0
TaskStatus Integer 实例任务状态。0 - 没有任务 ,1 - 升级中,2 - 数据导入中,3 - 开放Slave中,4 - 外网访问开通中,5 - 批量操作执行中,6 - 回档中,7 - 外网访问关闭中,8 - 密码修改中,9 - 实例名修改中,10 - 重启中,12 - 自建迁移中,13 - 删除库表中,14 - 灾备实例创建同步中,15 - 升级待切换,16 - 升级切换中,17 - 升级切换完成
示例值:0
MasterInfo MasterInfo 主实例详细信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
DeviceType String 实例类型
示例值:UNIVERSAL
EngineVersion String 内核版本
示例值:5.7
InstanceName String 实例名称
示例值:**
DrInfo Array of DrInfo 灾备实例详细信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
WanDomain String 外网域名
示例值:''
WanPort Integer 外网端口号
示例值:0
PayType Integer 付费类型,可能的返回值:0-包年包月;1-按量计费
示例值:1
CreateTime String 实例创建时间
示例值:2020-08-29 08:37:33
Vip String 实例 IP
示例值:1.2.3.4
Vport Integer 端口号
示例值:3306
CdbError Integer 磁盘写入是否被锁定(实例数据写入量已经超过磁盘配额)。0 -未被锁定 1 -已被锁定
示例值:0
UniqVpcId String 私有网络描述符,例如:“vpc-5v8wn9mg”
示例值:vpc-5v8wn9mg
UniqSubnetId String 子网描述符,例如:“subnet-1typ0s7d”
示例值:subnet-1typ0s7d
PhysicalId String 物理 ID
示例值:''
Cpu Integer 核心数
示例值:1
Qps Integer 每秒查询数量
示例值:1000
ZoneName String 可用区中文名称
示例值:北京三区
DeviceClass String 物理机型
注意:此字段可能返回 null,表示取不到有效值。
示例值:‘’
DeployGroupId String 置放群组 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:‘’
ZoneId Integer 可用区 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:800003
InstanceNodes Integer 节点数
示例值:1
TagList Array of TagInfoItem 标签列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
EngineType String 引擎类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:InnoDB
MaxDelayTime Integer 最大延迟阈值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DiskType String 实例磁盘类型,仅云盘版实例才返回该值。可能的值为 CLOUD_SSD:SSD云硬盘, CLOUD_HSSD:增强型SSD云硬盘
示例值:CLOUD_SSD
ExpandCpu Integer 当前扩容的CPU核心数。
注意:此字段可能返回 null,表示取不到有效值。

InstanceRebootTime

实例预期重启时间

被如下接口引用:DescribeDBInstanceRebootTime。

名称 类型 描述
InstanceId String 实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同
TimeInSeconds Integer 预期重启时间

InstanceRollbackRangeTime

实例可回档时间范围

被如下接口引用:DescribeRollbackRangeTime。

名称 类型 描述
Code Integer 查询数据库错误码
Message String 查询数据库错误信息
InstanceId String 实例ID列表,单个实例Id的格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同
Times Array of RollbackTimeRange 可回档时间范围

LocalBinlogConfig

本地binlog保留配置

被如下接口引用:DescribeLocalBinlogConfig。

名称 类型 描述
SaveHours Integer 本地binlog保留时长,可取值范围:[72,168]。
示例值:70
MaxUsage Integer 本地binlog空间使用率,可取值范围:[30,50]。
示例值:30

LocalBinlogConfigDefault

本地binlog保留策略默认配置。

被如下接口引用:DescribeLocalBinlogConfig。

名称 类型 描述
SaveHours Integer 本地binlog保留时长,可取值范围:[72,168]。
示例值:70
MaxUsage Integer 本地binlog空间使用率,可取值范围:[30,50]。
示例值:30

LogRuleTemplateInfo

审计日志命中规则模板的基本信息

被如下接口引用:DescribeAuditLogs。

名称 类型 描述
RuleTemplateId String 模板ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdb-art-8qx2kcr7
RuleTemplateName String 规则模板名
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_rule
AlarmLevel String 告警等级。1-低风险,2-中风险,3-高风险。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
RuleTemplateStatus Integer 规则模板变更状态:0-未变更;1-已变更;2-已删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

LogToCLSConfig

DB实例慢日志、错误日志投递CLS配置

被如下接口引用:DescribeDBInstanceLogToCLS。

名称 类型 描述
Status String 投递状态打开或者关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:ON/OFF
LogSetId String CLS日志集ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:8dff8d62-fa10-4d6c-bee0-6e31a0ade975
LogTopicId String 日志主题ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:09c3c2d1-ac46-4e4e-b688-b73950e64682
ClsRegion String CLS服务所在地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou

MasterInfo

主实例信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
Region String 地域信息
示例值:ap-guangzhou
RegionId Integer 地域ID
示例值:1
ZoneId Integer 可用区ID
示例值:100003
Zone String 可用区信息
示例值:ap-guangzhou-3
InstanceId String 实例ID
示例值:cdb-***
ResourceId String 实例长ID
示例值:''
Status Integer 实例状态
示例值:1
InstanceName String 实例名称
示例值:***
InstanceType Integer 实例类型
示例值:1
TaskStatus Integer 任务状态
示例值:0
Memory Integer 内存容量
示例值:1000
Volume Integer 硬盘容量
示例值:50
DeviceType String 实例机型
示例值:UNIVERSAL
Qps Integer 每秒查询数
示例值:1000
VpcId Integer 私有网络ID
示例值:1533
SubnetId Integer 子网ID
示例值:12364
ExClusterId String 独享集群ID
示例值:''
ExClusterName String 独享集群名称
示例值:''

Outbound

安全组出站规则

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

名称 类型 描述
Action String 策略,ACCEPT 或者 DROP
示例值:ACCEPT
CidrIp String 目的 IP 或 IP 段,例如172.16.0.0/12
示例值:0.0.0.0/0
PortRange String 端口或者端口范围
示例值:ALL
IpProtocol String 网络协议,支持 UDP、TCP等
示例值:ALL
Dir String 规则限定的方向,进站规则为 OUTPUT
示例值:‘’
AddressModule String 地址模块
示例值:‘’
Desc String 规则描述
示例值:放通内网

ParamInfo

实例参数信息

被如下接口引用:CreateDBInstance, CreateDBInstanceHour, InitDBInstances。

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

ParamRecord

参数修改记录

被如下接口引用:DescribeInstanceParamRecords。

名称 类型 描述
InstanceId String 实例ID
示例值:""
ParamName String 参数名称
示例值:""
OldValue String 参数修改前的值
示例值:""
NewValue String 参数修改后的值
示例值:""
ModifyTime String 修改时间
示例值:""
IsSuccess Boolean 参数是否修改成功
示例值:true

ParamTemplateInfo

参数模板信息

被如下接口引用:DescribeParamTemplates。

名称 类型 描述
TemplateId Integer 参数模板ID
示例值:1
Name String 参数模板名称
示例值:test
Description String 参数模板描述
示例值:test
EngineVersion String 实例引擎版本
示例值:5.7
TemplateType String 参数模板类型
示例值:HIGH_STABILITY
EngineType String 参数模板引擎
注意:此字段可能返回 null,表示取不到有效值。
示例值:InnoDB

Parameter

数据库实例参数

被如下接口引用:CreateParamTemplate, ModifyInstanceParam, ModifyInstancePasswordComplexity, ModifyParamTemplate。

名称 类型 必选 描述
Name String 参数名称
CurrentValue String 参数值

ParameterDetail

实例参数的详细描述

被如下接口引用:DescribeDefaultParams, DescribeInstanceParams, DescribeParamTemplateInfo。

名称 类型 描述
Name String 参数名称
示例值:test
ParamType String 参数类型:integer,enum,float,string,func
示例值:string
Default String 参数默认值
示例值:OFF
Description String 参数描述
示例值:Controls the sensitivity of linear read-ahead that InnoDB uses t
CurrentValue String 参数当前值
示例值:56
NeedReboot Integer 修改参数后,是否需要重启数据库以使参数生效。可能的值包括:0-不需要重启;1-需要重启
示例值:1
Max Integer 参数允许的最大值
示例值:64
Min Integer 参数允许的最小值
示例值:1
EnumValue Array of String 参数的可选枚举值。如果为非枚举参数,则为空
示例值:[]
MaxFunc String 参数是公式类型时,该字段有效,表示公式类型最大值
示例值:64
MinFunc String 参数是公式类型时,该字段有效,表示公式类型最小值
示例值:1
IsNotSupportEdit Boolean 参数是否不支持修改
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

ProxyAddress

数据库代理地址信息

被如下接口引用:DescribeCdbProxyInfo。

名称 类型 描述
ProxyAddressId String 代理组地址ID
示例值:proxyaddr-ixw3ll2d
UniqVpcId String 私有网络ID
示例值:vpc-ixw3ll2d
UniqSubnetId String 私有子网ID
示例值:subnet-ixw3ll2d
Vip String IP地址
示例值:192.0.0.1
VPort Integer 端口
示例值:80
WeightMode String 权重分配模式;
系统自动分配:"system", 自定义:"custom"
注意:此字段可能返回 null,表示取不到有效值。
示例值:system
IsKickOut Boolean 是否开启延迟剔除,取值:"true" | "false"
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
MinCount Integer 最小保留数量,最小取值:0
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
MaxDelay Integer 延迟剔除阈值,最小取值:0
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
AutoAddRo Boolean 是否自动添加RO,取值:"true" | "false"
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ReadOnly Boolean 是否是只读,取值:"true" | "false"
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
TransSplit Boolean 是否开启事务分离
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
FailOver Boolean 是否开启故障转移
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ConnectionPool Boolean 是否开启连接池
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Desc String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
ProxyAllocation Array of ProxyAllocation 实例读权重分配
注意:此字段可能返回 null,表示取不到有效值。

ProxyAllocation

代理节点权重分布

被如下接口引用:AdjustCdbProxyAddress, CreateCdbProxyAddress, DescribeCdbProxyInfo。

名称 类型 必选 描述
Region String 代理节点所属地域
示例值:ap-guangzhou
Zone String 代理节点所属可用区
示例值:ap-guangzhou-1
ProxyInstance Array of ProxyInst 代理实例分布

ProxyGroupInfo

代理组详情

被如下接口引用:DescribeCdbProxyInfo。

名称 类型 描述
ProxyGroupId String 代理组ID
示例值:proxy-ixw3ll2d
ProxyVersion String 代理版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.2.1
SupportUpgradeProxyVersion String 代理支持升级版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.3.1
Status String 代理状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:online
TaskStatus String 代理任务状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:upgrade
ProxyNode Array of ProxyNode 代理组节点信息
注意:此字段可能返回 null,表示取不到有效值。
ProxyAddress Array of ProxyAddress 代理组地址信息
注意:此字段可能返回 null,表示取不到有效值。
ConnectionPoolLimit Integer 连接池阈值
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
SupportCreateProxyAddress Boolean 支持创建地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
SupportUpgradeProxyMysqlVersion String 支持升级代理版本所需的cdb版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:20210330

ProxyInst

代理实例

被如下接口引用:AdjustCdbProxyAddress, CreateCdbProxyAddress。

名称 类型 必选 描述
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdb-aykuksx3
InstanceName String 实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
InstanceType Integer 实例类型:1 master 主实例; 2 ro 只读实例; 3 dr 灾备实例; 4 sdr 小灾备实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status Integer 实例状态,可能的返回值:0-创建中;1-运行中;4-隔离中;5-已隔离
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Weight Integer 只读权重,如果权重为系统自动分配,改值不生效,只代表是否启用该实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
Region String 实例所属地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou
Zone String 实例所属可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-1

ProxyNode

代理节点

被如下接口引用:DescribeCdbProxyInfo。

名称 类型 描述
ProxyId String 代理节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:proxynode-tets
Cpu Integer CPU核数
注意:此字段可能返回 null,表示取不到有效值。
示例值:4
Mem Integer 内存大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
Status String 节点状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:online
Zone String 代理节点可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-1
Region String 代理节点地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou
Connection Integer 连接数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100

ProxyNodeCustom

节点规格配置

被如下接口引用:AdjustCdbProxy, CreateCdbProxy。

名称 类型 必选 描述
NodeCount Integer 节点个数
示例值:2
Cpu Integer CPU核数
示例值:8
Mem Integer 内存大小
示例值:1000
Region String 地域
示例值:ap-guangzhou
Zone String 可用区
示例值:ap-guangzhou-1

ReleaseResult

解隔离任务结果

被如下接口引用:ReleaseIsolatedDBInstances。

名称 类型 描述
InstanceId String 实例 ID。
Code Integer 实例解隔离操作的结果值。返回值为0表示成功。
Message String 实例解隔离操作的错误信息。

RemoteBackupInfo

异地备份信息

被如下接口引用:DescribeBackups, DescribeBinlogs。

名称 类型 描述
SubBackupId Integer 异地备份子任务的ID
示例值:123
Region String 异地备份所在地域
示例值:ap-guangzhou
Status String 备份任务状态。可能的值有 "SUCCESS": 备份成功, "FAILED": 备份失败, "RUNNING": 备份进行中。
示例值:SUCCESS
StartTime String 异地备份任务的开始时间
示例值:2016-03-17 02:00:37
FinishTime String 异地备份任务的结束时间
示例值:2016-03-17 02:00:37
Url String 下载地址
示例值:https://XXX

RoGroup

只读组参数

被如下接口引用:CreateDBInstance, CreateDBInstanceHour, DescribeDBInstances, DescribeRoGroups。

名称 类型 必选 描述
RoGroupMode String 只读组模式,可选值为:alone-系统自动分配只读组;allinone-新建只读组;join-使用现有只读组。
示例值:''
RoGroupId String 只读组 ID。
示例值:cdbrg-92zkeaq2
RoGroupName String 只读组名称。
示例值:your_group_name
RoOfflineDelay Integer 是否启用延迟超限剔除功能,启用该功能后,只读实例与主实例的延迟超过延迟阈值,只读实例将被隔离。可选值:1-启用;0-不启用。
示例值:0
RoMaxDelayTime Integer 延迟阈值。
示例值:1
MinRoInGroup Integer 最少实例保留个数,若购买只读实例数量小于设置数量将不做剔除。
示例值:1
WeightMode String 读写权重分配模式,可选值:system-系统自动分配;custom-自定义。
示例值:system
Weight Integer 该字段已经废弃,无意义。查看只读实例的权重,请查看 RoInstances 字段里的 Weight 值。
示例值:0
RoInstances Array of RoInstanceInfo 只读组中的只读实例详情。
示例值:[]
Vip String 只读组的内网 IP。
示例值:10.89.90.66
Vport Integer 只读组的内网端口号。
示例值:3306
UniqVpcId String 私有网络 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-ja6ts123
UniqSubnetId String 子网 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:subnet-njh2bc99
RoGroupRegion String 只读组所在的地域。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-beijing
RoGroupZone String 只读组所在的可用区。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-beijing-3
DelayReplicationTime Integer 延迟复制时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000

RoGroupAttr

RO 组的配置信息

被如下接口引用:ModifyRoGroupInfo。

名称 类型 必选 描述
RoGroupName String RO 组名称。
示例值:test_rogroup
RoMaxDelayTime Integer RO 实例最大延迟阈值。单位为秒,最小值为 1。注意,RO 组必须设置了开启实例延迟剔除策略,该值才有效。
示例值:10
RoOfflineDelay Integer 是否开启实例延迟剔除。支持的值包括:1 - 开启;0 - 不开启。注意,若设置开启实例延迟剔除,则必须设置延迟阈值(RoMaxDelayTime)参数。
示例值:1
MinRoInGroup Integer 最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。注意,若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
示例值:1
WeightMode String 权重模式。支持值包括:"system" - 系统自动分配; "custom" - 用户自定义设置。注意,若设置 "custom" 模式,则必须设置 RO 实例权重配置(RoWeightValues)参数。
示例值:system
ReplicationDelayTime Integer 延迟复制时间。
示例值:100

RoInstanceInfo

RO实例的详细信息

被如下接口引用:CreateDBInstance, CreateDBInstanceHour, DescribeDBInstances, DescribeRoGroups。

名称 类型 必选 描述
MasterInstanceId String RO组对应的主实例的ID
示例值:cdb-***
RoStatus String RO实例在RO组内的状态,可能的值:online-在线,offline-下线
示例值:online
OfflineTime String RO实例在RO组内上一次下线的时间
示例值:''
Weight Integer RO实例在RO组内的权重
示例值:1
Region String RO实例所在区域名称,如ap-shanghai
示例值:ap-shanghai
Zone String RO可用区的正式名称,如ap-shanghai-1
示例值:ap-shanghai-1
InstanceId String RO实例ID,格式如:cdbro-c1nl9rpv
示例值:cdbro-***
Status Integer RO实例状态,可能返回值:0-创建中,1-运行中,3-异地RO(仅在使用DescribeDBInstances查询主实例信息时,返回值中异地RO的状态恒等于3,其他场景下无此值),4-删除中
示例值:1
InstanceType Integer 实例类型,可能返回值:1-主实例,2-灾备实例,3-只读实例
示例值:3
InstanceName String RO实例名称
示例值:''
HourFeeStatus Integer 按量计费状态,可能的取值:1-正常,2-欠费
示例值:1
TaskStatus Integer RO实例任务状态,可能返回值:
0-没有任务
1-升级中
2-数据导入中
3-开放Slave中
4-外网访问开通中
5-批量操作执行中
6-回档中
7-外网访问关闭中
8-密码修改中
9-实例名修改中
10-重启中
12-自建迁移中
13-删除库表中
14-灾备实例创建同步中
示例值:0
Memory Integer RO实例内存大小,单位:MB
示例值:1000
Volume Integer RO实例硬盘大小,单位:GB
示例值:1
Qps Integer 每次查询数量
示例值:0
Vip String RO实例的内网IP地址
示例值:1.2.3.4
Vport Integer RO实例访问端口
示例值:3306
VpcId Integer RO实例所在私有网络ID
示例值:246100
SubnetId Integer RO实例所在私有网络子网ID
示例值:995192
DeviceType String RO实例规格描述,目前可取值 CUSTOM
示例值:CUSTOM
EngineVersion String RO实例数据库引擎版本,可能返回值:5.1、5.5、5.6、5.7、8.0
示例值:5.7
DeadlineTime String RO实例到期时间,时间格式:yyyy-mm-dd hh:mm:ss,如实例为按量计费模式,则此字段值为0000-00-00 00:00:00
示例值:‘’
PayType Integer RO实例计费类型,可能返回值:0-包年包月,1-按量计费,2-后付费月结
示例值:0

RoVipInfo

只读vip信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
RoVipStatus Integer 只读vip状态
RoSubnetId Integer 只读vip的子网
RoVpcId Integer 只读vip的私有网络
RoVport Integer 只读vip的端口号
RoVip String 只读vip

RoWeightValue

RO 实例的权重值

被如下接口引用:ModifyRoGroupInfo。

名称 类型 必选 描述
InstanceId String RO 实例 ID。
Weight Integer 权重值。取值范围为 [0, 100]。

RollbackDBName

用于回档的数据库名

被如下接口引用:StartBatchRollback。

名称 类型 必选 描述
DatabaseName String 回档前的原数据库名
注意:此字段可能返回 null,表示取不到有效值。
NewDatabaseName String 回档后的新数据库名
注意:此字段可能返回 null,表示取不到有效值。

RollbackInstancesInfo

用于回档的实例详情

被如下接口引用:DescribeRollbackTaskDetail, StartBatchRollback。

名称 类型 必选 描述
InstanceId String 云数据库实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdb_xxx
Strategy String 回档策略。可选值为:table、db、full;默认值为full。table - 极速回档模式,仅导入所选中表级别的备份和binlog,如有跨表操作,且关联表未被同时选中,将会导致回档失败,该模式下参数Databases必须为空;db - 快速模式,仅导入所选中库级别的备份和binlog,如有跨库操作,且关联库未被同时选中,将会导致回档失败;full - 普通回档模式,将导入整个实例的备份和binlog,速度较慢。
示例值:""
RollbackTime String 数据库回档时间,时间格式为:yyyy-mm-dd hh:mm:ss
示例值:""
Databases Array of RollbackDBName 待回档的数据库信息,表示整库回档
注意:此字段可能返回 null,表示取不到有效值。
Tables Array of RollbackTables 待回档的数据库表信息,表示按表回档
注意:此字段可能返回 null,表示取不到有效值。

RollbackTableName

用于回档的数据库表名

被如下接口引用:StartBatchRollback。

名称 类型 必选 描述
TableName String 回档前的原数据库表名
注意:此字段可能返回 null,表示取不到有效值。
NewTableName String 回档后的新数据库表名
注意:此字段可能返回 null,表示取不到有效值。

RollbackTables

用于回档的数据库表详情

被如下接口引用:StartBatchRollback。

名称 类型 必选 描述
Database String 数据库名
注意:此字段可能返回 null,表示取不到有效值。
Table Array of RollbackTableName 数据库表详情
注意:此字段可能返回 null,表示取不到有效值。

RollbackTask

回档任务详情

被如下接口引用:DescribeRollbackTaskDetail。

名称 类型 描述
Info String 任务执行信息描述。
Status String 任务执行结果。可能的取值:INITIAL - 初始化,RUNNING - 运行中,SUCCESS - 执行成功,FAILED - 执行失败,KILLED - 已终止,REMOVED - 已删除,PAUSED - 终止中。
Progress Integer 任务执行进度。取值范围为[0, 100]。
StartTime String 任务开始时间。
EndTime String 任务结束时间。
Detail Array of RollbackInstancesInfo 回档任务详情。
注意:此字段可能返回 null,表示取不到有效值。

RollbackTimeRange

可回档时间范围

被如下接口引用:DescribeRollbackRangeTime。

名称 类型 描述
Begin String 实例可回档开始时间,时间格式:2016-10-29 01:06:04
End String 实例可回档结束时间,时间格式:2016-11-02 11:44:47

Rule

权重分配规则

被如下接口引用:DescribeProxyCustomConf。

名称 类型 描述
LessThan Integer 划分上限
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
Weight Integer 权重
注意:此字段可能返回 null,表示取不到有效值。
示例值:5

RuleFilters

审计规则的规则过滤条件

被如下接口引用:CreateAuditRuleTemplate, DescribeAuditRuleTemplateModifyHistory, DescribeAuditRuleTemplates, ModifyAuditRuleTemplates, ModifyAuditService, OpenAuditService。

名称 类型 必选 描述
Type String 审计规则过滤条件的参数名称。可选值:host – 客户端 IP;user – 数据库账户;dbName – 数据库名称;sqlType-SQL类型;sql-sql语句;affectRows -影响行数;sentRows-返回行数;checkRows-扫描行数;execTime-执行时间。
示例值:sqlType
Compare String 审计规则过滤条件的匹配类型。可选值:INC – 包含;EXC – 不包含;EQS – 等于;NEQ – 不等于;REG-正则;GT-大于;LT-小于。
示例值:INC
Value Array of String 审计规则过滤条件的匹配值。sqlType条件的Value需在以下选择"alter", "changeuser", "create", "delete", "drop", "execute", "insert", "login", "logout", "other", "replace", "select", "set", "update"。
示例值:UPDATE

RuleTemplateInfo

规则模板内容

被如下接口引用:DescribeAuditRuleTemplateModifyHistory。

名称 类型 描述
RuleTemplateId String 规则模板ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:cdb-art-8qx2kcr7
RuleTemplateName String 规则模板名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
RuleFilters Array of RuleFilters 规则内容。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"Type":"host","Compare":"INC","Value":["100.122.76.176"]}]
AlarmLevel Integer 告警等级。1-低风险,2-中风险,3-高风险。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AlarmPolicy Integer 告警策略。0-不告警,1-告警。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Description String 规则描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:这不单单是一个的描述

RuleTemplateRecordInfo

规则模板变更记录信息

被如下接口引用:DescribeAuditRuleTemplateModifyHistory。

名称 类型 描述
TaskId Integer 任务ID
注意:此字段可能返回 null,表示取不到有效值。
ModifyBeforeInfo RuleTemplateInfo 修改前规则模板的详情。
注意:此字段可能返回 null,表示取不到有效值。
ModifyAfterInfo RuleTemplateInfo 修改后规则模板的详情。
注意:此字段可能返回 null,表示取不到有效值。
AffectedInstances Array of String 影响的实例。
注意:此字段可能返回 null,表示取不到有效值。
Operator String 操作人,账号uin。
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 变更的时间。
注意:此字段可能返回 null,表示取不到有效值。

SecurityGroup

安全组详情

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

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

SlaveConfig

从库的配置信息

被如下接口引用:DescribeDBInstanceConfig。

名称 类型 描述
ReplicationMode String 从库复制方式,可能的返回值:aysnc-异步,semisync-半同步
Zone String 从库可用区的正式名称,如ap-shanghai-1

SlaveInfo

备机信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
First SlaveInstanceInfo 第一备机信息
Second SlaveInstanceInfo 第二备机信息
注意:此字段可能返回 null,表示取不到有效值。

SlaveInstanceInfo

备机信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
Vport Integer 端口号
示例值:3306
Region String 地域信息
示例值:ap-beijing
Vip String 虚拟 IP 信息
示例值:1.2.3.4
Zone String 可用区信息
示例值:ap-beijing-3

SlowLogInfo

慢查询日志详情

被如下接口引用:DescribeSlowLogs。

名称 类型 描述
Name String 备份文件名
Size Integer 备份文件大小,单位:Byte
Date String 备份快照时间,时间格式:2016-03-17 02:10:37
IntranetUrl String 内网下载地址
InternetUrl String 外网下载地址
Type String 日志具体类型,可能的值:slowlog - 慢日志

SlowLogItem

结构化的慢日志详情

被如下接口引用:DescribeSlowLogData。

名称 类型 描述
Timestamp Integer Sql的执行时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1637894492
QueryTime Float Sql的执行时长(秒)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.1
SqlText String Sql语句。
注意:此字段可能返回 null,表示取不到有效值。
示例值:select * from test
UserHost String 客户端地址。
注意:此字段可能返回 null,表示取不到有效值。
示例值:127.0.0.1
UserName String 用户名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_user
Database String 数据库名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_db
LockTime Float 锁时长(秒)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.11
RowsExamined Integer 扫描行数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
RowsSent Integer 结果集行数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SqlTemplate String Sql模板。
注意:此字段可能返回 null,表示取不到有效值。
示例值:select * from test
Md5 String Sql语句的md5。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2casbjhk1ty

SqlFileInfo

sql文件信息

被如下接口引用:DescribeUploadedFiles。

名称 类型 描述
UploadTime Timestamp 上传时间
UploadInfo UploadInfo 上传进度
FileName String 文件名
FileSize Integer 文件大小,单位为Bytes
IsUploadFinished Integer 上传是否完成标志,可选值:0 - 未完成,1 - 已完成
FileId String 文件ID

TablePrivilege

数据库表权限

被如下接口引用:DescribeAccountPrivileges, ModifyAccountPrivileges。

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

Tag

标签结构

被如下接口引用:DescribeDBInstances。

名称 类型 必选 描述
Key String 标签键
示例值:name
Value String 标签值
示例值:zhang

TagInfo

标签信息

被如下接口引用:CreateCloneInstance, CreateDBInstance, CreateDBInstanceHour, ModifyInstanceTag。

名称 类型 必选 描述
TagKey String 标签键
TagValue Array of String 标签值

TagInfoItem

标签信息

被如下接口引用:DescribeDBInstances。

名称 类型 描述
TagKey String 标签键
注意:此字段可能返回 null,表示取不到有效值。
示例值:‘’
TagValue String 标签值
注意:此字段可能返回 null,表示取不到有效值。
示例值:‘’

TagInfoUnit

tag信息单元

被如下接口引用:DescribeAuditInstanceList, DescribeTagsOfInstanceIds。

名称 类型 描述
TagKey String 标签键
TagValue String 标签值

TagsInfoOfInstance

实例的标签信息

被如下接口引用:DescribeTagsOfInstanceIds。

名称 类型 描述
InstanceId String 实例Id
Tags Array of TagInfoUnit 标签信息

TaskDetail

实例任务详情

被如下接口引用:DescribeTasks。

名称 类型 描述
Code Integer 错误码。
Message String 错误信息。
JobId Integer 实例任务 ID。
Progress Integer 实例任务进度。
TaskStatus String 实例任务状态,可能的值包括:
"UNDEFINED" - 未定义;
"INITIAL" - 初始化;
"RUNNING" - 运行中;
"SUCCEED" - 执行成功;
"FAILED" - 执行失败;
"KILLED" - 已终止;
"REMOVED" - 已删除;
"PAUSED" - 已暂停。
"WAITING" - 等待中(可撤销)
TaskType String 实例任务类型,可能的值包括:
"ROLLBACK" - 数据库回档;
"SQL OPERATION" - SQL操作;
"IMPORT DATA" - 数据导入;
"MODIFY PARAM" - 参数设置;
"INITIAL" - 初始化云数据库实例;
"REBOOT" - 重启云数据库实例;
"OPEN GTID" - 开启云数据库实例GTID;
"UPGRADE RO" - 只读实例升级;
"BATCH ROLLBACK" - 数据库批量回档;
"UPGRADE MASTER" - 主实例升级;
"DROP TABLES" - 删除云数据库库表;
"SWITCH DR TO MASTER" - 灾备实例提升为主。
StartTime String 实例任务开始时间。
EndTime String 实例任务结束时间。
InstanceIds Array of String 任务关联的实例 ID。
注意:此字段可能返回 null,表示取不到有效值。
AsyncRequestId String 异步任务的请求 ID。

UploadInfo

文件上传描述

被如下接口引用:DescribeUploadedFiles。

名称 类型 描述
AllSliceNum Integer 文件所有分片数
CompleteNum Integer 已完成分片数

ZoneConf

多可用区信息

被如下接口引用:DescribeCdbZoneConfig。

名称 类型 必选 描述
DeployMode Array of Integer 可用区部署方式,可能的值为:0-单可用区;1-多可用区
MasterZone Array of String 主实例所在的可用区
SlaveZone Array of String 实例为多可用区部署时,备库1所在的可用区
BackupZone Array of String 实例为多可用区部署时,备库2所在的可用区