Ability
集群支持的功能
被如下接口引用：DescribeClusterDetail, DescribeClusters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IsSupportSlaveZone | String | 是 | 是否支持从可用区 示例值：yes |
| NonsupportSlaveZoneReason | String | 是 | 不支持从可用区的原因 注意：此字段可能返回 null，表示取不到有效值。 |
| IsSupportRo | String | 是 | 是否支持RO实例 示例值：yes |
| NonsupportRoReason | String | 是 | 不支持RO实例的原因 注意：此字段可能返回 null，表示取不到有效值。 |
| IsSupportManualSnapshot | String | 是 | 是否支持手动发起快照备份 注意：此字段可能返回 null，表示取不到有效值。 示例值：yes |
Account
数据库账号信息
被如下接口引用：DescribeAccounts。
| 名称 | 类型 | 描述 |
|---|---|---|
| AccountName | String | 数据库账号名 示例值：xxx |
| Description | String | 数据库账号描述 示例值：xxx |
| CreateTime | Timestamp | 创建时间 示例值：xxx |
| UpdateTime | Timestamp | 更新时间 示例值：xxx |
| Host | String | 主机 示例值：xxx |
| MaxUserConnections | Integer | 用户最大连接数 示例值：0 |
AccountParam
账号参数
被如下接口引用：ModifyAccountParams。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ParamName | String | 是 | 参数名称，当前仅支持参数：max_user_connections 示例值：max_user_connections |
| ParamValue | String | 是 | 参数值 示例值：1 |
Addr
数据库地址
被如下接口引用：DescribeClusterDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| IP | String | IP地址 |
| Port | Integer | 端口 |
AuditInstanceFilters
查询审计实例的过滤条件
被如下接口引用：DescribeAuditInstanceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤条件值。支持InstanceId-实例ID，InstanceName-实例名称，ProjectId-项目ID，TagKey-标签键，Tag-标签（以竖线分割，例：Tagkey|Tagvalue）。 示例值：InstanceId |
| ExactMatch | Boolean | 是 | true表示精确查找，false表示模糊匹配。 示例值：true |
| Values | Array of String | 是 | 筛选值 示例值：cynosdbmysql-ins-3nskq234 |
AuditInstanceInfo
审计实例详情
被如下接口引用：DescribeAuditInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProjectId | Integer | 项目ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：23414 |
| TagList | Array of Tag | 标签信息 注意：此字段可能返回 null，表示取不到有效值。 |
AuditLog
审计日志详细信息
被如下接口引用：DescribeAuditLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| AffectRows | Integer | 影响行数。 示例值：0 |
| ErrCode | Integer | 错误码。 示例值：0 |
| SqlType | String | SQL类型。 示例值：UPDATE |
| TableName | String | 表名称。 示例值：1234 |
| InstanceName | String | 实例名称。 示例值：cynosdbmysql-ins-xxxxxxxx |
| PolicyName | String | 审计策略名称。 示例值：审计策略 |
| DBName | String | 数据库名称。 示例值：数据库名称 |
| Sql | String | SQL语句。 |
| Host | String | 客户端地址。 |
| User | String | 用户名。 示例值：user |
| ExecTime | Integer | 执行时间，微秒。 示例值：12345678 |
| Timestamp | String | 时间。 |
| SentRows | Integer | 返回行数。 示例值：1 |
| ThreadId | Integer | 执行线程ID。 示例值：1 |
| CheckRows | Integer | 扫描行数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| CpuTime | Float | cpu执行时间，微秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：289.474 |
| IoWaitTime | Integer | IO等待时间，微秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：11 |
| LockWaitTime | Integer | 锁等待时间，微秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：57 |
| TrxLivingTime | Integer | 事物持续等待时间，微秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1092 |
| NsTime | Integer | 开始时间，与timestamp构成一个精确到纳秒的时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：106483229 |
| TemplateInfo | Array of LogRuleTemplateInfo | 日志命中规则模板的基本信息 注意：此字段可能返回 null，表示取不到有效值。 |
AuditLogFile
审计日志文件
被如下接口引用：DescribeAuditLogFiles。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileName | String | 审计日志文件名称 示例值：FileName |
| CreateTime | String | 审计日志文件创建时间。格式为 : "2019-03-20 17:09:13"。 示例值：2019-03-20 17:09:13 |
| Status | String | 文件状态值。可能返回的值为： "creating" - 生成中; "failed" - 创建失败; "success" - 已生成; 示例值：creating |
| FileSize | Integer | 文件大小，单位为 KB。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1234 |
| DownloadUrl | String | 审计日志下载地址。 注意：此字段可能返回 null，表示取不到有效值。 示例值：DownloadUrl |
| ErrMsg | String | 错误信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：ErrMsg |
AuditLogFilter
审计日志过滤条件。查询审计日志时，用户过滤返回的审计日志。
被如下接口引用：CreateAuditLogFile, DescribeAuditLogs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Host | Array of String | 否 | 客户端地址。 示例值：192.168.0.1 |
| User | Array of String | 否 | 用户名。 示例值：["user"] |
| DBName | Array of String | 否 | 数据库名称。 示例值：["db_test"] |
| TableName | Array of String | 否 | 表名称。 示例值：["table_test"] |
| PolicyName | Array of String | 否 | 审计策略名称。 示例值：["policy_test"] |
| Sql | String | 否 | SQL 语句。支持模糊匹配。 |
| SqlType | String | 否 | SQL 类型。目前支持："SELECT", "INSERT", "UPDATE", "DELETE", "CREATE", "DROP", "ALTER", "SET", "REPLACE", "EXECUTE"。 示例值：SELECT |
| ExecTime | Integer | 否 | 执行时间。单位为：ms。表示筛选执行时间大于该值的审计日志。 示例值：100 |
| AffectRows | Integer | 否 | 影响行数。表示筛选影响行数大于该值的审计日志。 示例值：10 |
| SqlTypes | Array of String | 否 | SQL 类型。支持多个类型同时查询。目前支持："SELECT", "INSERT", "UPDATE", "DELETE", "CREATE", "DROP", "ALTER", "SET", "REPLACE", "EXECUTE"。 示例值：["SELECT"] |
| Sqls | Array of String | 否 | SQL 语句。支持传递多个sql语句。 示例值："DELETE FROM test" |
| SentRows | Integer | 否 | 返回行数。 示例值：2 |
| ThreadId | Array of String | 否 | 线程ID。 示例值：["49354"] |
AuditRuleFilters
规则审计的过滤条件
被如下接口引用：DescribeAuditRuleWithInstanceIds, ModifyAuditService, OpenAuditService。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RuleFilters | Array of RuleFilters | 是 | 单条审计规则。 注意：此字段可能返回 null，表示取不到有效值。 |
AuditRuleTemplateInfo
审计规则模板的详情
被如下接口引用：DescribeAuditRuleTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuleTemplateId | String | 规则模板ID。 示例值：cynosdb-art-dnpg9p3r |
| RuleTemplateName | String | 规则模板名称。 示例值：规则模板名称 |
| RuleFilters | Array of RuleFilters | 规则模板的过滤条件 |
| Description | String | 规则模板描述。 注意：此字段可能返回 null，表示取不到有效值。 示例值：规则模板描述 |
| CreateAt | String | 规则模板创建时间。 示例值：2022-11-15 11:11:11 |
| UpdateAt | String | 规则模板修改时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-11-15 12:00:00 |
| AlarmLevel | Integer | 告警等级。1-低风险，2-中风险，3-高风险。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| AlarmPolicy | Integer | 告警策略。0-不告警，1-告警。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Status | Integer | 模板状态。0-无任务 ，1-修改中。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| AffectedInstances | Array of String | 规则模板应用在哪些在实例。 注意：此字段可能返回 null，表示取不到有效值。 |
BackupFileInfo
备份文件信息
被如下接口引用：DescribeBackupList。
| 名称 | 类型 | 描述 |
|---|---|---|
| SnapshotId | Integer | 快照文件ID，已废弃，请使用BackupId |
| FileName | String | 备份文件名 |
| FileSize | Integer | 备份文件大小 |
| StartTime | String | 备份开始时间 |
| FinishTime | String | 备份完成时间 |
| BackupType | String | 备份类型：snapshot，快照备份；logic，逻辑备份 |
| BackupMethod | String | 备份方式：auto，自动备份；manual，手动备份 |
| BackupStatus | String | 备份文件状态：success：备份成功；fail：备份失败；creating：备份文件创建中；deleting：备份文件删除中 |
| SnapshotTime | String | 备份文件时间 |
| BackupId | Integer | 备份ID 注意：此字段可能返回 null，表示取不到有效值。 |
| SnapShotType | String | 快照类型，可选值：full，全量；increment，增量 注意：此字段可能返回 null，表示取不到有效值。 |
| BackupName | String | 备份文件备注 注意：此字段可能返回 null，表示取不到有效值。 |
BillingResourceInfo
计费资源信息
被如下接口引用：DescribeResourcesByDealName。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID 示例值：”cynosdbmysql-xxx" |
| InstanceIds | Array of String | 实例ID列表 示例值：["cynosdbmysql-ins-xxx"]] |
| DealName | String | 订单ID 示例值："xxx" |
BindInstanceInfo
资源包绑定的实例信息
被如下接口引用：DescribeResourcePackageList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 绑定的集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cynosdbmysql-test |
| InstanceRegion | String | 绑定的实例所在的地域 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou |
| InstanceType | String | 绑定的实例类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：cynosdb-serverless |
| ExtendIds | Array of String | 绑定集群下的实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：[cynosdbmysql-ins-test] |
BinlogItem
Binlog描述
被如下接口引用：DescribeBinlogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileName | String | Binlog文件名称 |
| FileSize | Integer | 文件大小，单位：字节 |
| StartTime | String | 事务最早时间 |
| FinishTime | String | 事务最晚时间 |
| BinlogId | Integer | Binlog文件ID |
BizTaskInfo
任务信息
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| ID | Integer | 任务id 示例值：0 |
| AppId | Integer | 用户appid 示例值：123 |
| ClusterId | String | 集群id 示例值：cynosdbmysql-xxx |
| CreateTime | String | 任务创建时间 示例值：2004-05-03T17:30:08+08:00 |
| DelayTime | String | 延迟执行时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2004-05-03T17:30:08+08:00 |
| ErrMsg | String | 任务失败信息 注意：此字段可能返回 null，表示取不到有效值。 |
| FlowId | Integer | 异步任务流id 示例值：1 |
| Input | String | 任务输入信息 |
| InstanceGroupId | String | 实例组id 示例值：cynosdbmysql-grp-xx |
| InstanceId | String | 实例id 示例值：cynosmysql-ins-xx |
| ObjectId | String | 任务操作对象id 示例值：cynosmysql-ins-xx |
| ObjectType | String | 任务操作对象类型 示例值：cluster |
| Operator | String | 操作者uin 示例值：1 |
| Output | String | 任务输出信息 示例值：1 |
| Status | String | 任务状态 示例值：success |
| TaskType | String | 任务类型 示例值：taskCreateCluster |
| TriggerTaskId | Integer | 触发本任务的父任务ID 示例值：0 |
| UpdateTime | String | 更新时间 示例值：2004-05-03T17:30:08+08:00 |
| StartTime | String | 任务开始时间 示例值：2004-05-03T17:30:08+08:00 |
| EndTime | String | 任务结束时间 示例值：2004-05-03T17:30:08+08:00 |
| ClusterName | String | 集群名称 |
| InstanceName | String | 实例名称 |
| Process | Integer | 任务进度 示例值：100 |
| ModifyParamsData | Array of ModifyParamsData | 修改参数任务信息 注意：此字段可能返回 null，表示取不到有效值。 |
| CreateClustersData | CreateClustersData | 创建集群任务信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RollbackData | RollbackData | 集群回档任务信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ModifyInstanceData | ModifyInstanceData | 实例变配任务信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ManualBackupData | ManualBackupData | 手动备份任务信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ModifyDbVersionData | ModifyDbVersionData | 修改内核版本任务信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ClusterSlaveData | ClusterSlaveData | 集群可用区信息 注意：此字段可能返回 null，表示取不到有效值。 |
| SwitchClusterLogBin | SwitchClusterLogBin | 转换集群日志 注意：此字段可能返回 null，表示取不到有效值。 |
| ModifyInstanceParamsData | BizTaskModifyParamsData | 修改实例参数数据 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskMaintainInfo | TaskMaintainInfo | 维护时间 注意：此字段可能返回 null，表示取不到有效值。 |
BizTaskModifyInstanceParam
实例参数修改任务详情
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：cynosdbmysql-ins-xxx |
| ModifyInstanceParamList | Array of ModifyParamItem | 实例参数修改任务详情 注意：此字段可能返回 null，表示取不到有效值。 |
BizTaskModifyParamsData
修改参数任务数据
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID 示例值：cynosdbmysql-xxx |
| ClusterParamList | Array of ModifyParamItem | 集群参数修改数据 注意：此字段可能返回 null，表示取不到有效值。 |
| ModifyInstanceParams | Array of BizTaskModifyInstanceParam | 实例参数修改数据 注意：此字段可能返回 null，表示取不到有效值。 |
ClusterInstanceDetail
集群实例信息
被如下接口引用：DescribeClusterDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID |
| InstanceName | String | 实例名称 |
| InstanceType | String | 引擎类型 |
| InstanceStatus | String | 实例状态 |
| InstanceStatusDesc | String | 实例状态描述 |
| InstanceCpu | Integer | cpu核数 |
| InstanceMemory | Integer | 内存 |
| InstanceStorage | Integer | 硬盘 |
| InstanceRole | String | 实例角色 |
| MaintainStartTime | Integer | 执行开始时间(距离0点的秒数) 注意：此字段可能返回 null，表示取不到有效值。 示例值：10920 |
| MaintainDuration | Integer | 持续的时间(单位：秒) 注意：此字段可能返回 null，表示取不到有效值。 示例值：3600 |
| MaintainWeekDays | Array of String | 可以执行的时间，枚举值：["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"] 注意：此字段可能返回 null，表示取不到有效值。 示例值："Mon" |
| ServerlessStatus | String | serverless实例子状态 注意：此字段可能返回 null，表示取不到有效值。 |
ClusterParamModifyLog
参数修改记录
被如下接口引用：DescribeClusterParamLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| ParamName | String | 参数名称 |
| CurrentValue | String | 当前值 |
| UpdateValue | String | 修改后的值 |
| Status | String | 修改状态 |
| CreateTime | Timestamp ISO8601 | 创建时间 |
| UpdateTime | Timestamp ISO8601 | 更新时间 |
| ClusterId | String | 集群ID 示例值：cynosdbmysql-xxx |
| InstanceId | String | 实例ID 示例值：cynosdbmysql-ins-xxx |
ClusterSlaveData
集群从可用区信息
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| OldMasterZone | String | 旧主可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou-3 |
| OldSlaveZone | Array of String | 旧从可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ap-guangzhou-5] |
| NewMasterZone | String | 新主可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou-3 |
| NewSlaveZone | Array of String | 新从可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ap-guangzhou-5] |
| NewSlaveZoneAttr | Array of SlaveZoneAttrItem | 新从可用区属性 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"Zone":"ap-guangzhou-5","BinlogSyncWay":"async"}] |
| OldSlaveZoneAttr | Array of SlaveZoneAttrItem | 旧可用区属性 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"Zone":"ap-guangzhou-5","BinlogSyncWay":"async"}] |
CreateClustersData
创建集群任务信息
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| Cpu | Integer | 实例CPU |
| Memory | Integer | 实例内存 |
| StorageLimit | Integer | 集群存储上限 |
CynosdbCluster
集群信息
被如下接口引用：DescribeClusters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Status | String | 是 | 集群状态， 可选值如下: creating: 创建中 running:运行中 isolating:隔离中 isolated:已隔离 activating:解隔离中 offlining:下线中 offlined:已下线 deleting:删除中 deleted:已删除 示例值：running |
| UpdateTime | String | 是 | 更新时间 示例值：2021-05-08 14:29:25 |
| Zone | String | 是 | 可用区 示例值：ap-guangzhou-3 |
| ClusterName | String | 是 | 集群名称 示例值：MyClusterName |
| Region | String | 是 | 地域 示例值：ap-guangzhou |
| DbVersion | String | 是 | 数据库版本 示例值：5.7 |
| ClusterId | String | 是 | 集群ID 示例值：cynosmysql-xxxxxxxx |
| InstanceNum | Integer | 是 | 实例数 示例值：1 |
| Uin | String | 是 | 用户uin 注意：此字段可能返回 null，表示取不到有效值。 示例值：111111 |
| DbType | String | 是 | 引擎类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：MYSQL |
| AppId | Integer | 是 | 用户appid 注意：此字段可能返回 null，表示取不到有效值。 示例值：111111 |
| StatusDesc | String | 是 | 集群状态描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：运行中 |
| CreateTime | String | 是 | 集群创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-05-08 14:29:25 |
| PayMode | Integer | 是 | 付费模式。0-按量计费，1-包年包月 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| PeriodEndTime | String | 是 | 截止时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-06-08 14:29:25 |
| Vip | String | 是 | 集群读写vip 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.1.1.1 |
| Vport | Integer | 是 | 集群读写vport 注意：此字段可能返回 null，表示取不到有效值。 示例值：3306 |
| ProjectID | Integer | 是 | 项目id 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| VpcId | String | 否 | 私有网络ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-xxxxxxxx |
| SubnetId | String | 否 | 子网ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-xxxxxxxx |
| CynosVersion | String | 否 | cynos内核版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：2.0.12 |
| StorageLimit | Integer | 否 | 存储容量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| RenewFlag | Integer | 否 | 续费标志 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ProcessingTask | String | 否 | 正在处理的任务 注意：此字段可能返回 null，表示取不到有效值。 示例值：ProcessingTask |
| Tasks | Array of ObjectTask | 否 | 集群的任务数组 注意：此字段可能返回 null，表示取不到有效值。 |
| ResourceTags | Array of Tag | 否 | 集群绑定的tag数组 注意：此字段可能返回 null，表示取不到有效值。 |
| DbMode | String | 否 | Db类型(NORMAL, SERVERLESS) 注意：此字段可能返回 null，表示取不到有效值。 示例值：SERVERLESS |
| ServerlessStatus | String | 否 | 当Db类型为SERVERLESS时，serverless集群状态，可选值: resume pause 注意：此字段可能返回 null，表示取不到有效值。 示例值：resume |
| Storage | Integer | 否 | 集群预付费存储值大小 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| StorageId | String | 否 | 集群存储为预付费时的存储ID，用于预付费存储变配 注意：此字段可能返回 null，表示取不到有效值。 示例值：cynosmysql-xxxxxxxx |
| StoragePayMode | Integer | 否 | 集群存储付费模式。0-按量计费，1-包年包月 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MinStorageSize | Integer | 否 | 集群计算规格对应的最小存储值 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| MaxStorageSize | Integer | 否 | 集群计算规格对应的最大存储值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| NetAddrs | Array of NetAddr | 否 | 集群网络信息 注意：此字段可能返回 null，表示取不到有效值。 |
| PhysicalZone | String | 否 | 物理可用区 注意：此字段可能返回 null，表示取不到有效值。 |
| MasterZone | String | 否 | 主可用区 注意：此字段可能返回 null，表示取不到有效值。 |
| HasSlaveZone | String | 否 | 是否有从可用区 注意：此字段可能返回 null，表示取不到有效值。 |
| SlaveZones | Array of String | 否 | 从可用区 注意：此字段可能返回 null，表示取不到有效值。 |
| BusinessType | String | 否 | 商业类型 注意：此字段可能返回 null，表示取不到有效值。 |
| IsFreeze | String | 否 | 是否冻结 注意：此字段可能返回 null，表示取不到有效值。 |
| OrderSource | String | 否 | 订单来源 注意：此字段可能返回 null，表示取不到有效值。 |
| Ability | Ability | 否 | 能力 注意：此字段可能返回 null，表示取不到有效值。 |
| ResourcePackages | Array of ResourcePackage | 否 | 实例绑定资源包信息（此处只返回存储资源包，即packageType=DISK） 注意：此字段可能返回 null，表示取不到有效值。 |
CynosdbClusterDetail
集群详情详细信息
被如下接口引用：DescribeClusterDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID 示例值：cynosdbmysql-xxx |
| ClusterName | String | 集群名称 示例值：cynosdbmysql-xxx |
| Region | String | 地域 示例值：ap-guangzhou |
| Zone | String | 可用区 示例值：ap-guangzhou-1 |
| PhysicalZone | String | 物理可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou-1 |
| Status | String | 状态 示例值：running |
| StatusDesc | String | 状态描述 示例值：运行中 |
| ServerlessStatus | String | 当Db类型为SERVERLESS时，serverless集群状态，可选值: resume resuming pause pausing 示例值：resume |
| StorageId | String | 存储Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：123 |
| Storage | Integer | 存储大小，单位为G 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| MaxStorageSize | Integer | 最大存储规格，单位为G 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| MinStorageSize | Integer | 最小存储规格，单位为G 注意：此字段可能返回 null，表示取不到有效值。 示例值：5 |
| StoragePayMode | Integer | 存储付费类型，1为包年包月，0为按量计费 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| VpcName | String | VPC名称 示例值：Default-VPC |
| VpcId | String | vpc唯一id 示例值：vpc-xxx |
| SubnetName | String | 子网名称 示例值：Default-Subnet |
| SubnetId | String | 子网ID 示例值：subnet-xxx |
| Charset | String | 字符集 示例值：utf8 |
| CreateTime | String | 创建时间 示例值："2021-05-25 19:23:31" |
| DbType | String | 数据库类型 示例值：MYSQL |
| DbMode | String | 数据库类型，normal，serverless 注意：此字段可能返回 null，表示取不到有效值。 示例值：normal |
| DbVersion | String | 数据库版本 示例值：5.7 |
| StorageLimit | Integer | 存储空间上限 注意：此字段可能返回 null，表示取不到有效值。 示例值：3000 |
| UsedStorage | Integer | 使用容量 示例值：100 |
| Vip | String | vip地址 示例值：127.0.0.1 |
| Vport | Integer | vport端口 示例值：3306 |
| RoAddr | Array of Addr | 集群只读实例的vip地址和vport端口 |
| Ability | Ability | 集群支持的功能 注意：此字段可能返回 null，表示取不到有效值。 |
| CynosVersion | String | cynos版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：2.0.21 |
| BusinessType | String | 商业类型 注意：此字段可能返回 null，表示取不到有效值。 |
| HasSlaveZone | String | 是否有从可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：yes |
| IsFreeze | String | 是否冻结 注意：此字段可能返回 null，表示取不到有效值。 示例值：no |
| Tasks | Array of ObjectTask | 任务列表 注意：此字段可能返回 null，表示取不到有效值。 |
| MasterZone | String | 主可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou-3 |
| SlaveZones | Array of String | 从可用区列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou-3 |
| InstanceSet | Array of ClusterInstanceDetail | 实例信息 |
| PayMode | Integer | 付费模式 示例值：1 |
| PeriodEndTime | String | 到期时间 示例值："2021-05-25 19:23:31" |
| ProjectID | Integer | 项目id 示例值：0 |
| ResourceTags | Array of Tag | 实例绑定的tag数组信息 |
| ProxyStatus | String | Proxy状态 注意：此字段可能返回 null，表示取不到有效值。 |
| LogBin | String | binlog开关，可选值：ON, OFF 注意：此字段可能返回 null，表示取不到有效值。 示例值：OFF |
| IsSkipTrade | String | 是否跳过交易 注意：此字段可能返回 null，表示取不到有效值。 示例值：no |
| PitrType | String | pitr类型，可选值：normal, redo_pitr 注意：此字段可能返回 null，表示取不到有效值。 示例值：normal |
| IsOpenPasswordComplexity | String | 是否打开密码复杂度 注意：此字段可能返回 null，表示取不到有效值。 |
| NetworkStatus | String | 网络类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：tcp |
| ResourcePackages | Array of ResourcePackage | 集群绑定的资源包信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RenewFlag | Integer | 自动续费标识，1为自动续费，0为到期不续 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| NetworkType | String | 节点网络类型 注意：此字段可能返回 null，表示取不到有效值。 |
| SlaveZoneAttr | Array of SlaveZoneAttrItem | 备可用区属性 注意：此字段可能返回 null，表示取不到有效值。 |
CynosdbErrorLogItem
实例错误日志返回类型
被如下接口引用：DescribeInstanceErrorLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | Integer | 日志时间戳 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Level | String | 日志等级 注意：此字段可能返回 null，表示取不到有效值。 |
| Content | String | 日志内容 注意：此字段可能返回 null，表示取不到有效值。 |
CynosdbInstance
实例信息
被如下接口引用：DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| Uin | String | 用户Uin 示例值：11111111 |
| AppId | Integer | 用户AppId 示例值：11111111 |
| ClusterId | String | 集群ID 示例值：cynosmysql-xxxxxxxx |
| ClusterName | String | 集群名称 示例值：MyClusterName |
| InstanceId | String | 实例ID 示例值：cynosmysql-ins-xxxxxxxx |
| InstanceName | String | 实例名称 示例值：MyInstanceName |
| ProjectId | Integer | 项目ID 示例值：0 |
| Region | String | 地域 示例值：ap-guangzhou |
| Zone | String | 可用区 示例值：ap-guangzhou-3 |
| Status | String | 实例状态 示例值：running |
| StatusDesc | String | 实例状态中文描述 示例值：运行中 |
| DbMode | String | 实例形态，是否为serverless实例 示例值：SERVERLESS |
| DbType | String | 数据库类型 示例值：MYSQL |
| DbVersion | String | 数据库版本 示例值：5.7 |
| Cpu | Integer | Cpu，单位：核 示例值：1 |
| Memory | Integer | 内存，单位：GB 示例值：1 |
| Storage | Integer | 存储量，单位：GB 示例值：1000 |
| InstanceType | String | 实例类型 示例值：master |
| InstanceRole | String | 实例当前角色 示例值：master |
| UpdateTime | Timestamp | 更新时间 示例值：2021-06-08 14:29:25 |
| CreateTime | Timestamp | 创建时间 示例值：2021-06-08 14:29:25 |
| VpcId | String | VPC网络ID 示例值：vpc-xxxxxxxx |
| SubnetId | String | 子网ID 示例值：subnet-xxxxxxxx |
| Vip | String | 实例内网IP 示例值：1.2.3.4 |
| Vport | Integer | 实例内网端口 示例值：3306 |
| PayMode | Integer | 付费模式 示例值：1 |
| PeriodEndTime | Timestamp | 实例过期时间 示例值：2021-07-08 14:29:25 |
| DestroyDeadlineText | String | 销毁期限 示例值：0 天 |
| IsolateTime | Timestamp | 隔离时间 示例值：2021-07-08 14:29:25 |
| NetType | Integer | 网络类型 |
| WanDomain | String | 外网域名 |
| WanIP | String | 外网IP 示例值：2.3.4.5 |
| WanPort | Integer | 外网端口 示例值：7654 |
| WanStatus | String | 外网状态 |
| DestroyTime | String | 实例销毁时间 |
| CynosVersion | String | Cynos内核版本 示例值：2.0.12 |
| ProcessingTask | String | 正在处理的任务 示例值：ProcessingTask |
| RenewFlag | Integer | 续费标志 示例值：1 |
| MinCpu | Float | serverless实例cpu下限 示例值：1 |
| MaxCpu | Float | serverless实例cpu上限 示例值：2 |
| ServerlessStatus | String | serverless实例状态, 可选值： resume pause 示例值：resume |
| StorageId | String | 预付费存储Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：cynosmysql-xxxxxxxx |
| StoragePayMode | Integer | 存储付费类型 示例值：1 |
| PhysicalZone | String | 物理区 |
| BusinessType | String | 商业类型 注意：此字段可能返回 null，表示取不到有效值。 |
| Tasks | Array of ObjectTask | 任务 注意：此字段可能返回 null，表示取不到有效值。 |
| IsFreeze | String | 是否冻结 注意：此字段可能返回 null，表示取不到有效值。 示例值：yes |
| ResourceTags | Array of Tag | 资源标签 注意：此字段可能返回 null，表示取不到有效值。 |
| MasterZone | String | 主可用区 注意：此字段可能返回 null，表示取不到有效值。 |
| SlaveZones | Array of String | 备可用区 注意：此字段可能返回 null，表示取不到有效值。 |
| InstanceNetInfo | Array of InstanceNetInfo | 实例网络信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ResourcePackages | Array of ResourcePackage | 实例绑定资源包信息（此处只返回计算资源包，即packageType=CCU） 注意：此字段可能返回 null，表示取不到有效值。 |
| InstanceIndexMode | String | 实例索引形态,可选值【mixedRowColumn（行列混存），onlyRowIndex（仅行存）】 注意：此字段可能返回 null，表示取不到有效值。 示例值：mixedRowColumn |
| InstanceAbility | InstanceAbility | 当前实例支持的能力 注意：此字段可能返回 null，表示取不到有效值。 |
CynosdbInstanceDetail
实例详情
被如下接口引用：DescribeInstanceDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Uin | String | 用户Uin |
| AppId | Integer | 用户AppId |
| ClusterId | String | 集群ID |
| ClusterName | String | 集群名称 |
| InstanceId | String | 实例ID |
| InstanceName | String | 实例名称 |
| ProjectId | Integer | 项目ID |
| Region | String | 地域 |
| Zone | String | 可用区 |
| Status | String | 实例状态 |
| StatusDesc | String | 实例状态中文描述 |
| DbType | String | 数据库类型 |
| DbVersion | String | 数据库版本 |
| Cpu | Integer | Cpu，单位：核 |
| Memory | Integer | 内存，单位：GB |
| Storage | Integer | 存储量，单位：GB |
| InstanceType | String | 实例类型 |
| InstanceRole | String | 实例当前角色 |
| UpdateTime | Timestamp | 更新时间 |
| CreateTime | Timestamp | 创建时间 |
| PayMode | Integer | 付费模式 |
| PeriodEndTime | Timestamp | 实例过期时间 |
| NetType | Integer | 网络类型 |
| VpcId | String | VPC网络ID |
| SubnetId | String | 子网ID |
| Vip | String | 实例内网IP |
| Vport | Integer | 实例内网端口 |
| WanDomain | String | 实例外网域名 |
| Charset | String | 字符集 |
| CynosVersion | String | Cynos内核版本 |
| RenewFlag | Integer | 续费标志 |
| MinCpu | Float | serverless实例cpu下限 |
| MaxCpu | Float | serverless实例cpu上限 |
| ServerlessStatus | String | serverless实例状态, 可能值： resume pause |
CynosdbInstanceGroup
实例组信息
被如下接口引用：DescribeClusterInstanceGroups, DescribeClusterInstanceGrps。
| 名称 | 类型 | 描述 |
|---|---|---|
| AppId | Integer | 用户appId |
| ClusterId | String | 集群ID |
| CreatedTime | String | 创建时间 |
| DeletedTime | String | 删除时间 |
| InstanceGroupId | String | 实例组ID |
| Status | String | 状态 |
| Type | String | 实例组类型。ha-ha组；ro-只读组 |
| UpdatedTime | String | 更新时间 |
| Vip | String | 内网IP |
| Vport | Integer | 内网端口 |
| WanDomain | String | 外网域名 |
| WanIP | String | 外网ip |
| WanPort | Integer | 外网端口 |
| WanStatus | String | 外网状态 |
| InstanceSet | Array of CynosdbInstance | 实例组包含实例信息 |
| UniqVpcId | String | VPC的ID 注意：此字段可能返回 null，表示取不到有效值。 |
| UniqSubnetId | String | 子网ID 注意：此字段可能返回 null，表示取不到有效值。 |
| OldAddrInfo | OldAddrInfo | 正在回收IP信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ProcessingTasks | Array of String | 正在进行的任务 |
| Tasks | Array of ObjectTask | 任务列表 |
| NetServiceId | Integer | biz_net_service表id |
DatabasePrivileges
数据库权限列表
被如下接口引用：DescribeAccountAllGrantPrivileges, ModifyAccountPrivileges。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Db | String | 是 | 数据库 注意：此字段可能返回 null，表示取不到有效值。 |
| Privileges | Array of String | 是 | 权限列表 注意：此字段可能返回 null，表示取不到有效值。 |
DatabaseTables
数据库表信息
被如下接口引用：CreateBackup, SearchClusterTables。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Database | String | 否 | 数据库名 注意：此字段可能返回 null，表示取不到有效值。 示例值：db |
| Tables | Array of String | 否 | 表名称列表 注意：此字段可能返回 null，表示取不到有效值。 |
DbInfo
数据库详细信息
被如下接口引用：DescribeClusterDetailDatabases。
| 名称 | 类型 | 描述 |
|---|---|---|
| DbName | String | 数据库名称 示例值：test |
| CharacterSet | String | 字符集类型 示例值：utf8 |
| Status | String | 数据库状态 示例值：running |
| CollateRule | String | 排序规则 示例值： utf8_general_ci |
| Description | String | 数据库备注 注意：此字段可能返回 null，表示取不到有效值。 示例值：test-备注 |
| UserHostPrivileges | Array of UserHostPrivilege | 用户权限 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"DbUserName":"root","DbHost":"%","DbPrivilege":""} |
| DbId | Integer | 数据库ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：123 |
| CreateTime | Timestamp ISO8601 | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdateTime | Timestamp ISO8601 | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 |
| AppId | Integer | 用户appid 注意：此字段可能返回 null，表示取不到有效值。 |
| Uin | String | 用户Uin 注意：此字段可能返回 null，表示取不到有效值。 |
| ClusterId | String | 集群Id 注意：此字段可能返回 null，表示取不到有效值。 |
DbTable
数据库表
被如下接口引用：GrantAccountPrivileges, RevokeAccountPrivileges。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Db | String | 是 | 数据库名称 示例值：db-xx |
| TableName | String | 否 | 数据库表名称 示例值：table-xx |
ErrorLogItemExport
错误日志导出格式
被如下接口引用：ExportInstanceErrorLogs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Timestamp | String | 否 | 时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2019-04-17 00:00:00 |
| Level | String | 否 | 日志等级，可选值note, warning，error 注意：此字段可能返回 null，表示取不到有效值。 示例值：note |
| Content | String | 否 | 日志内容 注意：此字段可能返回 null，表示取不到有效值。 |
InputAccount
账号，包含accountName和host
被如下接口引用：DeleteAccounts, DescribeAccountAllGrantPrivileges, GrantAccountPrivileges, ModifyAccountHost, ModifyAccountParams, ModifyAccountPrivileges, RevokeAccountPrivileges。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AccountName | String | 是 | 账号 |
| Host | String | 否 | 主机，默认‘%’ |
InstanceAbility
实例允许的操作列表
被如下接口引用：DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| IsSupportForceRestart | String | 实例是否支持强制重启，可选值：yes：支持，no：不支持 注意：此字段可能返回 null，表示取不到有效值。 示例值：yes |
| NonsupportForceRestartReason | String | 不支持强制重启的原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：不支持强制重启 |
InstanceAuditLogFilter
审计日志搜索条件
被如下接口引用：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 - 范围。 示例值：INC |
| Value | Array of String | 是 | 过滤的值。反向查询时，多个值之前是且的关系，正向查询多个值是或的关系。 示例值：100.0. |
InstanceAuditRule
实例的审计规则详情。
被如下接口引用：DescribeAuditRuleWithInstanceIds。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID。 示例值：cynosdbmysql-ins-6990cckk |
| AuditRule | Boolean | 是否是规则审计。true-规则审计，false-全审计。 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| AuditRuleFilters | Array of AuditRuleFilters | 审计规则详情。仅当AuditRule=true时有效。 注意：此字段可能返回 null，表示取不到有效值。 |
| OldRule | Boolean | 是否是审计策略 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| RuleTemplates | Array of RuleTemplateInfo | 实例应用的规则模板详情 注意：此字段可能返回 null，表示取不到有效值。 |
InstanceAuditStatus
实例审计详情信息
被如下接口引用：DescribeAuditInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID。 示例值：cynosdbmysql-ins-3nskq234 |
| AuditStatus | String | 审计状态。ON-表示审计已开启，OFF-表示审计关闭。 示例值：ON |
| 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 |
| RuleTemplateIds | Array of String | 实例所应用的规则模板。 注意：此字段可能返回 null，表示取不到有效值。 |
InstanceInitInfo
实例初始化配置信息
被如下接口引用：CreateClusters, RollbackToNewCluster。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Cpu | Integer | 是 | 实例cpu 示例值：1 |
| Memory | Integer | 是 | 实例内存 示例值：2 |
| InstanceType | String | 是 | 实例类型 rw/ro 示例值：rw |
| InstanceCount | Integer | 是 | 实例个数,范围[1,15] 示例值：1 |
| MinRoCount | Integer | 否 | Serverless实例个数最小值，范围[1,15] 示例值：1 |
| MaxRoCount | Integer | 否 | Serverless实例个数最大值，范围[1,15] 示例值：1 |
| MinRoCpu | Float | 否 | Serverless实例最小规格 示例值：0.5 |
| MaxRoCpu | Float | 否 | Serverless实例最大规格 示例值：1 |
InstanceNetInfo
实例网络信息
被如下接口引用：DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceGroupType | String | 网络类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：ro |
| InstanceGroupId | String | 实例组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cynosdbmysql-grp-qwertyui |
| VpcId | String | 私有网络ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-qwerty |
| SubnetId | String | 子网ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-qwerty |
| NetType | Integer | 网络类型, 0-基础网络, 1-vpc网络, 2-黑石网络 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Vip | String | 私有网络IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：123.123.123.1 |
| Vport | Integer | 私有网络端口 注意：此字段可能返回 null，表示取不到有效值。 示例值：1234 |
| WanDomain | String | 外网域名 注意：此字段可能返回 null，表示取不到有效值。 示例值：aa.com |
| WanIP | String | 外网IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：12.12.23.3 |
| WanPort | Integer | 外网端口 注意：此字段可能返回 null，表示取不到有效值。 示例值：12345 |
| WanStatus | String | 外网开启状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：init |
InstanceParamItem
实例参数信息
被如下接口引用：DescribeInstanceParams。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID |
| ParamsItems | Array of ParamItemDetail | 实例参数列表 |
InstanceSpec
实例可售卖规格详细信息，创建实例时Cpu/Memory确定实例规格，存储可选大小为[MinStorageSize,MaxStorageSize]
被如下接口引用：DescribeInstanceSpecs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Cpu | Integer | 实例CPU，单位：核 |
| Memory | Integer | 实例内存，单位：GB |
| MaxStorageSize | Integer | 实例最大可用存储，单位：GB |
| MinStorageSize | Integer | 实例最小可用存储，单位：GB |
| HasStock | Boolean | 是否有库存 |
| MachineType | String | 机器类型 |
| MaxIops | Integer | 最大IOPS |
| MaxIoBandWidth | Integer | 最大IO带宽 |
| ZoneStockInfos | Array of ZoneStockInfo | 地域库存信息 注意：此字段可能返回 null，表示取不到有效值。 |
| StockCount | Integer | 库存数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
LogRuleTemplateInfo
审计日志命中规则模板的基本信息
被如下接口引用：DescribeAuditLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuleTemplateId | String | 模板ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cynosdb-art-ns0u376 |
| RuleTemplateName | String | 规则模板名 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_rule |
| AlarmLevel | String | 告警等级。1-低风险，2-中风险，3-高风险。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| RuleTemplateStatus | Integer | 规则模板变更状态：0-未变更；1-已变更；2-已删除 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
LogicBackupConfigInfo
逻辑备份配置信息
被如下接口引用：ModifyBackupConfig。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LogicBackupEnable | String | 否 | 是否开启自动逻辑备份 注意：此字段可能返回 null，表示取不到有效值。 示例值：OFF |
| LogicBackupTimeBeg | Integer | 否 | 自动逻辑备份开始时间 注意：此字段可能返回 null，表示取不到有效值。 |
| LogicBackupTimeEnd | Integer | 否 | 自动逻辑备份结束时间 注意：此字段可能返回 null，表示取不到有效值。 |
| LogicReserveDuration | Integer | 否 | 自动逻辑备份保留时间 注意：此字段可能返回 null，表示取不到有效值。 |
| LogicCrossRegionsEnable | String | 否 | 是否开启跨地域逻辑备份 注意：此字段可能返回 null，表示取不到有效值。 |
| LogicCrossRegions | Array of String | 否 | 逻辑备份所跨地域 注意：此字段可能返回 null，表示取不到有效值。 |
ManualBackupData
手动备份任务信息
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| BackupType | String | 备份类型。snapshot-快照备份 |
| BackupMethod | String | 备份方式。auto-自动备份，manual-手动 |
| SnapshotTime | String | 备份时间 |
ModifiableInfo
参数是否可修改的详细信息
被如下接口引用：DescribeClusterParams, DescribeClusterPasswordComplexity, DescribeParamTemplateDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| IsModifiable | Integer | 参数是否可被修改, 1:可以 0:不可以 |
ModifyDbVersionData
修改数据库内核版本任务信息
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| OldVersion | String | 修改前版本 |
| NewVersion | String | 修改后版本 |
| UpgradeType | String | 升级方式 |
ModifyInstanceData
实例变配任务信息
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| Cpu | Integer | 变配后CPU |
| Memory | Integer | 变配后内存 |
| StorageLimit | Integer | 变配后存储上限 |
| OldCpu | Integer | 变配前CPU |
| OldMemory | Integer | 变配前内存 |
| OldStorageLimit | Integer | 变配前存储上限 |
| UpgradeType | String | 升级方式。升级完成后切换或维护时间内切换 |
ModifyParamItem
修改的实例参数信息
被如下接口引用：AddInstances, DescribeTasks, ModifyInstanceParam, ModifyParamTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ParamName | String | 是 | 参数名 |
| CurrentValue | String | 是 | 参数当前值 |
| OldValue | String | 否 | 参数旧值（只在出参时有用） 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
ModifyParamsData
修改参数信息
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 参数名 |
| OldValue | String | 修改前参数值 |
| CurValue | String | 修改后参数值 |
Module
系统支持的模块
被如下接口引用：DescribeZones。
| 名称 | 类型 | 描述 |
|---|---|---|
| IsDisable | String | 是否支持，可选值:yes,no 示例值：yes |
| ModuleName | String | 模块名 示例值：Wan |
NetAddr
网络信息
被如下接口引用：DescribeClusters, DescribeProxies。
| 名称 | 类型 | 描述 |
|---|---|---|
| Vip | String | 内网ip 注意：此字段可能返回 null，表示取不到有效值。 示例值：127.0.0.1 |
| Vport | Integer | 内网端口号 注意：此字段可能返回 null，表示取不到有效值。 示例值：3306 |
| WanDomain | String | 外网域名 注意：此字段可能返回 null，表示取不到有效值。 示例值：127.0.0.1 |
| WanPort | Integer | 外网端口号 注意：此字段可能返回 null，表示取不到有效值。 示例值：3306 |
| NetType | String | 网络类型（ro-只读,rw/ha-读写） 注意：此字段可能返回 null，表示取不到有效值。 示例值：rw |
| UniqSubnetId | String | 子网ID 注意：此字段可能返回 null，表示取不到有效值。 |
| UniqVpcId | String | 私有网络ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Description | String | 描述信息 注意：此字段可能返回 null，表示取不到有效值。 |
| WanIP | String | 外网IP 注意：此字段可能返回 null，表示取不到有效值。 |
| WanStatus | String | 外网状态 注意：此字段可能返回 null，表示取不到有效值。 |
| InstanceGroupId | String | 实例组ID 注意：此字段可能返回 null，表示取不到有效值。 |
NewAccount
x08新创建的账号
被如下接口引用：CreateAccounts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AccountName | String | 是 | 账户名，包含字母数字_,以字母开头，字母或数字结尾，长度1-30 示例值：0 |
| AccountPassword | String | 是 | 密码，密码长度范围为8到64个字符 示例值：0 |
| Host | String | 是 | 主机(%或ipv4地址) 示例值：0 |
| Description | String | 否 | 描述 示例值：0 |
| MaxUserConnections | Integer | 否 | 用户最大连接数，不能大于10240 示例值：0 |
ObjectTask
任务信息
被如下接口引用：DescribeClusterDetail, DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, DescribeClusters, DescribeInstances, DescribeProxies。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TaskId | Integer | 否 | 任务自增ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| TaskType | String | 否 | 任务类型 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskStatus | String | 否 | 任务状态 注意：此字段可能返回 null，表示取不到有效值。 |
| ObjectId | String | 否 | 任务ID（集群ID|实例组ID|实例ID） 注意：此字段可能返回 null，表示取不到有效值。 |
| ObjectType | String | 否 | 任务类型 注意：此字段可能返回 null，表示取不到有效值。 |
OldAddrInfo
数据库地址
被如下接口引用：DescribeClusterInstanceGroups, DescribeClusterInstanceGrps。
| 名称 | 类型 | 描述 |
|---|---|---|
| Vip | String | IP 注意：此字段可能返回 null，表示取不到有效值。 |
| Vport | Integer | 端口 注意：此字段可能返回 null，表示取不到有效值。 |
| ReturnTime | String | 期望执行回收时间 注意：此字段可能返回 null，表示取不到有效值。 |
Package
资源包
被如下接口引用：DescribeResourcePackageList。
| 名称 | 类型 | 描述 |
|---|---|---|
| AppId | Integer | AppID 注意：此字段可能返回 null，表示取不到有效值。 示例值：1234567 |
| PackageId | String | 资源包唯一ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：pkg-qwerty |
| PackageName | String | 资源包名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：资源包_2 |
| PackageType | String | 资源包类型 CCU-计算资源包，DISK-存储资源包 注意：此字段可能返回 null，表示取不到有效值。 示例值：CCU |
| PackageRegion | String | 资源包使用地域 china-中国内地通用，overseas-港澳台及海外通用 注意：此字段可能返回 null，表示取不到有效值。 示例值：china |
| Status | String | 资源包状态 creating-创建中； using-使用中； expired-已过期； normal_finish-使用完； apply_refund-申请退费中； refund-已退费。 注意：此字段可能返回 null，表示取不到有效值。 示例值：using |
| PackageTotalSpec | Float | 资源包总量 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| PackageUsedSpec | Float | 资源包已使用量 注意：此字段可能返回 null，表示取不到有效值。 示例值：29 |
| HasQuota | Boolean | 是否还有库存余量 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| BindInstanceInfos | Array of BindInstanceInfo | 绑定实例信息 注意：此字段可能返回 null，表示取不到有效值。 |
| StartTime | String | 生效时间：2022-07-01 00:00:00 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-07-01 00:00:00 |
| ExpireTime | String | 失效时间：2022-08-01 00:00:00 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-08-01 00:00:00 |
| HistoryBindResourceInfos | Array of BindInstanceInfo | 资源包历史绑定（已解绑）实例信息 注意：此字段可能返回 null，表示取不到有效值。 |
PackageDetail
资源包明细说明
被如下接口引用：DescribeResourcePackageDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| AppId | Integer | AppId账户ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：123456789 |
| PackageId | String | 资源包唯一ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：扩展信息 |
| InstanceId | String | 实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cynosdb-ins-test |
| SuccessDeductSpec | Float | 成功抵扣容量 注意：此字段可能返回 null，表示取不到有效值。 示例值：50 |
| PackageTotalUsedSpec | Float | 截止当前，资源包已使用的容量 注意：此字段可能返回 null，表示取不到有效值。 示例值：30 |
| StartTime | String | 抵扣开始时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-07-01 00:00:00 |
| EndTime | String | 抵扣结束时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-07-02 00:00:00 |
| ExtendInfo | String | 扩展信息 注意：此字段可能返回 null，表示取不到有效值。 |
ParamDetail
实例参数详细描述
被如下接口引用：DescribeParamTemplateDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| ParamName | String | 参数名称 |
| ParamType | String | 参数类型：integer，enum，float，string，func |
| SupportFunc | Boolean | true-支持"func"，false-不支持公式 |
| Default | String | 默认值 |
| Description | String | 参数描述 |
| CurrentValue | String | 参数当前值 |
| NeedReboot | Integer | 修改参数后，是否需要重启数据库以使参数生效。0-不需要重启，1-需要重启。 |
| Max | String | 参数容许的最大值 |
| Min | String | 参数容许的最小值 |
| EnumValue | Array of String | 参数的可选枚举值。如果为非枚举值，则为空 注意：此字段可能返回 null，表示取不到有效值。 |
| IsGlobal | Integer | 1：全局参数，0：非全局参数 |
| MatchType | String | 匹配类型，multiVal |
| MatchValue | String | 匹配目标值，当multiVal时，各个key用，分割 |
| IsFunc | Boolean | true-为公式，false-非公式 注意：此字段可能返回 null，表示取不到有效值。 |
| Func | String | 参数设置为公式时，Func返回设置的公式内容 注意：此字段可能返回 null，表示取不到有效值。 |
| ModifiableInfo | ModifiableInfo | 参数是否可修改 注意：此字段可能返回 null，表示取不到有效值。 |
ParamInfo
参数信息
被如下接口引用：DescribeClusterParams, DescribeClusterPasswordComplexity。
| 名称 | 类型 | 描述 |
|---|---|---|
| CurrentValue | String | 当前值 |
| Default | String | 默认值 |
| EnumValue | Array of String | 参数为enum/string/bool时，可选值列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Max | String | 参数类型为float/integer时的最大值 |
| Min | String | 参数类型为float/integer时的最小值 |
| ParamName | String | 参数名称 |
| NeedReboot | Integer | 是否需要重启生效 |
| ParamType | String | 参数类型：integer/float/string/enum/bool |
| MatchType | String | 匹配类型，multiVal, regex在参数类型是string时使用 |
| MatchValue | String | 匹配目标值，当multiVal时，各个key用;分割 |
| Description | String | 参数描述 |
| IsGlobal | Integer | 是否为全局参数 注意：此字段可能返回 null，表示取不到有效值。 |
| ModifiableInfo | ModifiableInfo | 参数是否可修改 注意：此字段可能返回 null，表示取不到有效值。 |
| IsFunc | Boolean | 是否为函数 注意：此字段可能返回 null，表示取不到有效值。 |
| Func | String | 函数 注意：此字段可能返回 null，表示取不到有效值。 |
ParamItem
修改参数时，传入参数描述
被如下接口引用：CreateClusters, CreateParamTemplate, ModifyClusterParam, RollbackToNewCluster。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ParamName | String | 是 | 参数名称 |
| CurrentValue | String | 是 | 当前值 |
| OldValue | String | 是 | 原有值 |
ParamItemDetail
实例参数信息
被如下接口引用：DescribeInstanceParams。
| 名称 | 类型 | 描述 |
|---|---|---|
| CurrentValue | String | 当前值 |
| Default | String | 默认值 |
| EnumValue | Array of String | 参数的可选枚举值。如果为非枚举值，则为空 |
| IsGlobal | Integer | 1：全局参数，0：非全局参数 |
| Max | String | 最大值 |
| Min | String | 最小值 |
| NeedReboot | Integer | 修改参数后，是否需要重启数据库以使参数生效。0-不需要重启，1-需要重启。 |
| ParamName | String | 参数名称 |
| ParamType | String | 参数类型：integer，enum，float，string，func |
| Description | String | 参数描述 |
| IsFunc | Boolean | 类型是否为公式 注意：此字段可能返回 null，表示取不到有效值。 |
| Func | String | 参数配置公式 注意：此字段可能返回 null，表示取不到有效值。 |
ParamItemInfo
参数变化信息
被如下接口引用：DescribeChangedParamsAfterUpgrade。
| 名称 | 类型 | 描述 |
|---|---|---|
| ParamName | String | 参数名字 注意：此字段可能返回 null，表示取不到有效值。 |
| NewValue | String | 参数新值 注意：此字段可能返回 null，表示取不到有效值。 |
| OldValue | String | 参数旧值 注意：此字段可能返回 null，表示取不到有效值。 |
| ValueFunction | String | 参数公式 注意：此字段可能返回 null，表示取不到有效值。 |
ParamTemplateListInfo
参数模板信息
被如下接口引用：DescribeParamTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 参数模板ID 示例值：1234 |
| TemplateName | String | 参数模板名称 示例值："test" |
| TemplateDescription | String | 参数模板描述 示例值："cynosdbmysqltemplste" |
| EngineVersion | String | 引擎版本 示例值："5.7" |
| DbMode | String | 数据库类型，可选值：NORMAL，SERVERLESS 示例值：NORMAL |
| ParamInfoSet | Array of TemplateParamInfo | 参数模板详情 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{""}] |
PolicyRule
安全组规则
被如下接口引用：DescribeDBSecurityGroups, DescribeProjectSecurityGroups。
| 名称 | 类型 | 描述 |
|---|---|---|
| Action | String | 策略，ACCEPT或者DROP |
| CidrIp | String | 来源Ip或Ip段，例如192.168.0.0/16 |
| PortRange | String | 端口 |
| IpProtocol | String | 网络协议，支持udp、tcp等 |
| ServiceModule | String | 协议端口ID或者协议端口组ID。 |
| AddressModule | String | IP地址ID或者ID地址组ID。 |
| Id | String | id |
| Desc | String | 描述 |
ProxyConnectionPoolInfo
数据库代理连接池信息
被如下接口引用：DescribeProxies。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ConnectionPoolTimeOut | Integer | 是 | 连接池保持阈值：单位（秒） 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| OpenConnectionPool | String | 否 | 是否开启了连接池 注意：此字段可能返回 null，表示取不到有效值。 示例值：no |
| ConnectionPoolType | String | 否 | 连接池类型：SessionConnectionPool（会话级别连接池） 注意：此字段可能返回 null，表示取不到有效值。 示例值：SessionConnectionPool |
ProxyGroup
proxy组
被如下接口引用：DescribeProxies。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProxyGroupId | String | 数据库代理组ID |
| ProxyNodeCount | Integer | 数据库代理组节点个数 示例值：0 |
| Status | String | 数据库代理组状态 |
| Region | String | 地域 |
| Zone | String | 可用区 |
| CurrentProxyVersion | String | 当前代理版本 |
| ClusterId | String | 集群ID 注意：此字段可能返回 null，表示取不到有效值。 |
| AppId | Integer | 用户AppId 注意：此字段可能返回 null，表示取不到有效值。 |
| OpenRw | String | 读写节点开通数据库代理 注意：此字段可能返回 null，表示取不到有效值。 |
ProxyGroupInfo
数据库代理组详细信息
被如下接口引用：DescribeProxies。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProxyGroup | ProxyGroup | 数据库代理组 注意：此字段可能返回 null，表示取不到有效值。 |
| ProxyGroupRwInfo | ProxyGroupRwInfo | 数据库代理组读写分离信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ProxyNodes | Array of ProxyNodeInfo | 数据库代理节点信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ConnectionPool | ProxyConnectionPoolInfo | 数据库代理连接池信息 注意：此字段可能返回 null，表示取不到有效值。 |
| NetAddrInfos | Array of NetAddr | 数据库代理网络信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Tasks | Array of ObjectTask | 数据库代理任务集 注意：此字段可能返回 null，表示取不到有效值。 |
ProxyGroupRwInfo
数据库代理组读写分离信息
被如下接口引用：DescribeProxies。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ConsistencyType | String | 否 | 一致性类型 eventual-最终一致性,global-全局一致性,session-会话一致性 |
| ConsistencyTimeOut | Integer | 否 | 一致性超时时间 |
| WeightMode | String | 否 | 权重模式 system-系统分配，custom-自定义 |
| FailOver | String | 否 | 是否开启故障转移 |
| AutoAddRo | String | 否 | 是否自动添加只读实例，yes-是，no-不自动添加 |
| InstanceWeights | Array of ProxyInstanceWeight | 否 | 实例权重数组 |
| OpenRw | String | 否 | 是否开通读写节点，yse-是，no-否 注意：此字段可能返回 null，表示取不到有效值。 |
| RwType | String | 否 | 读写属性，可选值：READWRITE,READONLY |
| TransSplit | Boolean | 否 | 事务拆分 |
| AccessMode | String | 否 | 连接模式，可选值：balance，nearby |
ProxyInstanceWeight
数据库代理，读写分离实例权重
被如下接口引用：CreateProxyEndPoint, DescribeProxies, ModifyProxyRwSplit。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 是 | 实例Id 示例值：cynosdbmysql-ins-xxxxxxx |
| Weight | Integer | 是 | 实例权重 示例值：0 |
ProxyNodeInfo
数据库代理组节点
被如下接口引用：DescribeProxies, DescribeProxyNodes。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProxyNodeId | String | 数据库代理节点ID |
| ProxyNodeConnections | Integer | 节点当前连接数, DescribeProxyNodes接口此字段值不返回 |
| Cpu | Integer | 数据库代理节点cpu |
| Mem | Integer | 数据库代理节点内存 |
| Status | String | 数据库代理节点状态 |
| ProxyGroupId | String | 数据库代理组ID |
| ClusterId | String | 集群ID |
| AppId | Integer | 用户AppID |
| Region | String | 地域 |
| Zone | String | 可用区 |
| OssProxyNodeName | String | 数据库代理节点名字 |
ProxySpec
数据库代理规格
被如下接口引用：DescribeProxySpecs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Cpu | Integer | 数据库代理cpu核数 |
| Mem | Integer | 数据库代理内存 |
ProxyZone
proxy节点可用区内个数
被如下接口引用：AddInstances, CreateProxy, UpgradeInstance, UpgradeProxy。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ProxyNodeZone | String | 否 | proxy节点可用区 示例值：ap-guangzhou-3 |
| ProxyNodeCount | Integer | 否 | proxy节点数量 示例值：2 |
QueryFilter
查询过滤器
被如下接口引用：DescribeClusters, DescribeInstances, DescribeProxyNodes, DescribeTasks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Names | Array of String | 是 | 搜索字段，目前支持："InstanceId", "ProjectId", "InstanceName", "Vip" 示例值："projectId" |
| Values | Array of String | 是 | 搜索字符串 示例值："xxx" |
| ExactMatch | Boolean | 否 | 是否精确匹配 示例值：1 |
| Name | String | 否 | 搜索字段 示例值："123" |
| Operator | String | 否 | 操作符 |
QueryParamFilter
查询参数过滤器
被如下接口引用：DescribeProxies。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Names | Array of String | 是 | 搜索字段，目前支持："InstanceId", "ProjectId", "InstanceName", "Vip" |
| Values | Array of String | 是 | 搜索字符串 |
| ExactMatch | Boolean | 否 | 是否精确匹配 |
ResourcePackage
资源包信息
被如下接口引用：DescribeClusterDetail, DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, DescribeClusters, DescribeInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PackageId | String | 否 | 资源包的唯一ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：package-123456 |
| PackageType | String | 否 | 资源包类型：CCU：计算资源包 DISK：存储资源包 注意：此字段可能返回 null，表示取不到有效值。 示例值：CCU |
RollbackData
回档任务信息
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| Cpu | Integer | 实例CPU 示例值：5 |
| Memory | Integer | 实例内存 示例值：48 |
| StorageLimit | Integer | 集群存储上限 示例值：10 |
| OriginalClusterId | String | 原集群id 示例值：cynosdbmysql-xx |
| OriginalClusterName | String | 原集群名 示例值：test |
| RollbackStrategy | String | 回档方式 示例值：ROLLBACK_STRATEGY_SNAP |
| SnapshotTime | String | 快照时间 示例值：2022.01.01 |
| MinCpu | Integer | 回档到serverlessls集群时最小CPU 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| MaxCpu | Integer | 回档到serverlessls集群时最大CPU 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| SnapShotId | Integer | 快照ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RollbackDatabases | Array of RollbackDatabase | 回档数据库 注意：此字段可能返回 null，表示取不到有效值。 |
| RollbackTables | Array of RollbackTable | 回档数据表 注意：此字段可能返回 null，表示取不到有效值。 |
| BackupFileName | String | 备份文件名称 注意：此字段可能返回 null，表示取不到有效值。 |
RollbackDatabase
回滚数据库信息
被如下接口引用：DescribeTasks, RollBackCluster。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| OldDatabase | String | 是 | 旧数据库名称 示例值：xxx |
| NewDatabase | String | 是 | 新数据库名称 示例值：xxx |
RollbackTable
回档数据库及表
被如下接口引用：DescribeTasks, RollBackCluster。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Database | String | 是 | 数据库名称 示例值：xxx |
| Tables | Array of RollbackTableInfo | 是 | 数据库表 示例值：xxx |
RollbackTableInfo
回档表信息
被如下接口引用：RollBackCluster。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| OldTable | String | 是 | 旧表名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx |
| NewTable | String | 是 | 新表名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx |
RollbackTimeRange
可回档的时间范围
被如下接口引用：DescribeRollbackTimeRange。
| 名称 | 类型 | 描述 |
|---|---|---|
| TimeRangeStart | String | 开始时间 |
| TimeRangeEnd | String | 结束时间 |
RuleFilters
审计规则的规则过滤条件
被如下接口引用：CreateAuditRuleTemplate, DescribeAuditRuleTemplates, DescribeAuditRuleWithInstanceIds, 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 | 是 | 审计规则过滤条件的匹配值。 示例值：UPDATE |
RuleTemplateInfo
规则模板内容
被如下接口引用：DescribeAuditRuleWithInstanceIds。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuleTemplateId | String | 规则模板ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：cynosdb-art-jy6hmgcz |
| 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，表示取不到有效值。 |
SalePackageSpec
资源包明细说明
被如下接口引用：DescribeResourcePackageSaleSpec。
| 名称 | 类型 | 描述 |
|---|---|---|
| PackageRegion | String | 资源包使用地域 注意：此字段可能返回 null，表示取不到有效值。 示例值：china |
| PackageType | String | 资源包类型 CCU-计算资源包 DISK-存储资源包 注意：此字段可能返回 null，表示取不到有效值。 示例值：CCU |
| PackageVersion | String | 资源包版本 base-基础版本，common-通用版本，enterprise-企业版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：base |
| MinPackageSpec | Float | 当前版本资源包最小资源数，计算资源单位：个；存储资源：GB 注意：此字段可能返回 null，表示取不到有效值。 示例值：50 |
| MaxPackageSpec | Float | 当前版本资源包最大资源数，计算资源单位：个；存储资源：GB 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| ExpireDay | Integer | 资源包有效期，单位:天 注意：此字段可能返回 null，表示取不到有效值。 示例值：180 |
SaleRegion
售卖地域信息
被如下接口引用：DescribeZones。
| 名称 | 类型 | 描述 |
|---|---|---|
| Region | String | 地域英文名 示例值：ap-guangzhou |
| RegionId | Integer | 地域数字ID 示例值：1 |
| RegionZh | String | 地域中文名 示例值：上海 |
| ZoneSet | Array of SaleZone | 可售卖可用区列表 |
| DbType | String | 引擎类型 示例值：MYSQL |
| Modules | Array of Module | 地域模块支持情况 |
SaleZone
售卖可用区信息
被如下接口引用：DescribeZones。
| 名称 | 类型 | 描述 |
|---|---|---|
| Zone | String | 可用区英文名 示例值：ap-shanghai-4 |
| ZoneId | Integer | 可用区数字ID 示例值：200004 |
| ZoneZh | String | 可用区中文名 示例值：上海四区 |
| IsSupportServerless | Integer | 是否支持serverless集群 0:不支持 1:支持 示例值：1 |
| IsSupportNormal | Integer | 是否支持普通集群 0:不支持 1:支持 示例值：1 |
| PhysicalZone | String | 物理区 示例值：ap-guangzhou-2 |
| HasPermission | Boolean | 用户是否有可用区权限 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| IsWholeRdmaZone | String | 是否为全链路RDMA可用区 |
SecurityGroup
安全组详情
被如下接口引用：DescribeDBSecurityGroups, DescribeProjectSecurityGroups。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProjectId | Integer | 项目ID |
| CreateTime | String | 创建时间，时间格式：yyyy-mm-dd hh:mm:ss |
| Inbound | Array of PolicyRule | 入站规则 |
| Outbound | Array of PolicyRule | 出站规则 |
| SecurityGroupId | String | 安全组ID |
| SecurityGroupName | String | 安全组名称 |
| SecurityGroupRemark | String | 安全组备注 |
SlaveZoneAttrItem
可用区属性项
被如下接口引用：DescribeClusterDetail, DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| Zone | String | 可用区 注意：此字段可能返回 null，表示取不到有效值。 |
| BinlogSyncWay | String | binlog同步方式 注意：此字段可能返回 null，表示取不到有效值。 示例值：async |
SlaveZoneStockInfo
备可用区库存信息
被如下接口引用：DescribeInstanceSpecs。
| 名称 | 类型 | 描述 |
|---|---|---|
| SlaveZone | String | 备可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou-4 |
| StockCount | Integer | 备可用区的库存数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| HasStock | Boolean | 备可用区是否有库存 注意：此字段可能返回 null，表示取不到有效值。 |
SlowQueriesItem
实例慢查询信息
被如下接口引用：DescribeInstanceSlowQueries。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | Integer | 执行时间戳 |
| QueryTime | Float | 执行时长，单位秒 |
| SqlText | String | sql语句 |
| UserHost | String | 客户端host |
| UserName | String | 用户名 |
| Database | String | 数据库名 |
| LockTime | Float | 锁时长，单位秒 |
| RowsExamined | Integer | 扫描行数 |
| RowsSent | Integer | 返回行数 |
| SqlTemplate | String | sql模板 |
| SqlMd5 | String | sql语句md5 |
| SyncReadCountRemote | Integer | 远程读取次数 数据库内核版本大于3.1.12 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| SyncReadBytesRemote | Integer | 远程读取的字节数 数据库内核版本大于3.1.12 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| SyncReadTimeRemote | Integer | 远程读取所花费的时间（微秒） 数据库内核版本大于3.1.12 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| SyncWriteCountRemote | Integer | 远程写入次数 数据库内核版本大于3.1.12 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| SyncWriteBytesRemote | Integer | 远程写入的字节数。 数据库内核版本大于3.1.12 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| SyncWriteTimeRemote | Integer | 远程写入所花费的时间（微秒）。 数据库内核版本大于3.1.12 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| TrxCommitDelay | Integer | 事务提交延迟（微秒） 数据库内核版本大于3.1.12 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
SwitchClusterLogBin
转换集群log bin开关
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 状态 注意：此字段可能返回 null，表示取不到有效值。 |
TablePrivileges
mysql表权限
被如下接口引用：DescribeAccountAllGrantPrivileges, ModifyAccountPrivileges。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Db | String | 是 | 数据库名 注意：此字段可能返回 null，表示取不到有效值。 |
| TableName | String | 是 | 表名 注意：此字段可能返回 null，表示取不到有效值。 |
| Privileges | Array of String | 是 | 权限列表 注意：此字段可能返回 null，表示取不到有效值。 |
Tag
集群绑定的标签信息，包含标签键TagKey和标签值TagValue
被如下接口引用：CreateClusters, DescribeAuditInstanceList, DescribeClusterDetail, DescribeClusterInstanceGroups, DescribeClusterInstanceGrps, DescribeClusters, DescribeInstances, RollbackToNewCluster。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签键 |
| TagValue | String | 是 | 标签值 |
TaskMaintainInfo
TaskMaintainInfo
被如下接口引用：DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| MaintainStartTime | Integer | 执行开始时间(距离0点的秒数) 注意：此字段可能返回 null，表示取不到有效值。 示例值：10920 |
| MaintainDuration | Integer | 持续的时间(单位：秒) 注意：此字段可能返回 null，表示取不到有效值。 示例值：3600 |
| MaintainWeekDays | Array of String | 可以执行的时间，枚举值：["Mon","Tue","Wed","Thu","Fri", "Sat", "Sun"] 注意：此字段可能返回 null，表示取不到有效值。 示例值："Mon" |
TemplateParamInfo
参数模板详情
被如下接口引用：DescribeParamTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| CurrentValue | String | 当前值 示例值：1024 |
| Default | String | 默认值 示例值：2048 |
| EnumValue | Array of String | 参数类型为enum时可选的值类型集合 注意：此字段可能返回 null，表示取不到有效值。 示例值：[12,23,45] |
| Max | String | 参数类型为float/integer时的最大值 注意：此字段可能返回 null，表示取不到有效值。 示例值：200 |
| Min | String | 参数类型为float/integer时的最小值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ParamName | String | 参数名称 示例值：binlog_back |
| NeedReboot | Integer | 是否需要重启 示例值：1 |
| Description | String | 参数描述 示例值：this is set bin log size |
| ParamType | String | 参数类型，integer/float/string/enum 示例值：float |
TradePrice
计费询价结果
被如下接口引用：InquirePriceCreate, InquirePriceRenew。
| 名称 | 类型 | 描述 |
|---|---|---|
| TotalPrice | Integer | 预付费模式下资源总价，不包含优惠，单位:分 注意：此字段可能返回 null，表示取不到有效值。 示例值：6000 |
| Discount | Float | 总的折扣，100表示100%不打折 示例值：100 |
| TotalPriceDiscount | Integer | 预付费模式下的优惠后总价, 单位: 分,例如用户享有折扣 =TotalPrice × Discount 注意：此字段可能返回 null，表示取不到有效值。 示例值：6000 |
| UnitPrice | Integer | 后付费模式下的单位资源价格，不包含优惠，单位:分 注意：此字段可能返回 null，表示取不到有效值。 示例值：350 |
| UnitPriceDiscount | Integer | 优惠后后付费模式下的单位资源价格, 单位: 分,例如用户享有折扣=UnitPricet × Discount 注意：此字段可能返回 null，表示取不到有效值。 示例值：350 |
| ChargeUnit | String | 计费价格单位 示例值：GB*h |
UpgradeProxy
添加实例或者变配实例时同步升级proxy.
被如下接口引用：AddInstances, UpgradeInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Cpu | Integer | 是 | cpu 示例值：2 |
| Mem | Integer | 是 | memory 示例值：4000 |
| ProxyZones | Array of ProxyZone | 是 | 代理节点信息 |
| ReloadBalance | String | 否 | 重新负载均衡 示例值：auto |
UserHostPrivilege
用户主机权限
被如下接口引用：CreateClusterDatabase, DescribeClusterDetailDatabases, ModifyClusterDatabase。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DbUserName | String | 是 | 授权用户 示例值：root |
| DbHost | String | 是 | 客户端ip 注意：此字段可能返回 null，表示取不到有效值。 示例值：% |
| DbPrivilege | String | 是 | 用户权限 注意：此字段可能返回 null，表示取不到有效值。 示例值：readonly |
ZoneStockInfo
可用区库存信息
被如下接口引用：DescribeInstanceSpecs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Zone | String | 可用区 |
| HasStock | Boolean | 是否有库存 |
| StockCount | Integer | 库存数量 示例值：1 |
| SlaveZoneStockInfos | Array of SlaveZoneStockInfo | 备可用区库存信息 注意：此字段可能返回 null，表示取不到有效值。 |