数据类型
Instance(实例参数)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | String | Y | 实例ID |
| createdAt | Date | Y | 实例创建时间 |
| updatedAt | Date | Y | 实例更新时间 |
| deletedAt | Date | Y | 实例删除时间 |
| isDeleted | Boolean | Y | 是否删除 |
| dbInstanceIdentifier | String | Y | 实例名称（2-128个字符，只能以字母或汉字开头，仅包含字母、汉字、数字、"."、"_"或"-"） |
| availabilityZone | String | Y | 可用区域 |
| account | String | Y | 用户（对应openstack的project） |
| creator | String | Y | 创建实例的用户 |
| rootUser | String | N | 主用户 （JsonIgnore） |
| instanceClassId | String | N | 实例规格id（JsonIgnore） |
| templateId | String | N | 实例模板id（JsonIgnore） |
| storageType | String | Y | 存储类型（目前仅支持：LOCAL_SSD） |
| allocatedStorage | String | Y | 存储空间大小，默认是5GB |
| status | InstanceStatus | Y | 实例状态（枚举） |
| chargeType | ChargeType | Y | 支付类型（枚举） |
| purchaseTime | String | Y | 购买时长（按需付费方式值为1，包年包月值取1-36整数） |
| expireTime | Date | Y | 过期时间 |
| count | Integer | Y | 实例数量 |
| characterSetName | String | Y | 数据库字符集 |
| dbInstanceClass | String | Y | 数据库规格类型 |
| dbInstanceType | String | Y | 数据库类型 高可用/单节点 |
| dbParameterGroupName | String | Y | 数据库参数组名称 |
| vpcId | String | Y | VPC ID |
| subnetId | String | Y | 子网ID |
| engine | String | Y | 数据库引擎 |
| engineVersion | String | Y | 数据库引擎版本 |
| masterUsername | String | Y | 数据库管理员名称（目前默认为root） |
| masterUserPassword | String | Y | 数据库管理员密码（8-32个字符，必须包含大小写字母和数字，支持英文特殊字符!"$%+,/:;<=>?[]^_`{}|~) |
| dbInstancePort | String | Y | 数据库端口号 |
| timezone | String | Y | 数据库时区 |
| dbInstanceAddress | String | Y | 数据库连接地址 |
| region | String | Y | 区域 |
| originalBackupId | String | N | 实例为备份恢复的话源备份Id |
| isAutoRenew | String | N | 是否自动续费 |
| mainInstanceId | String | N | 如果为只读实例的话，主实例Id |
| readOnlyInstanceIds | String | N | 如果主实例含有只读实例的话，只读实例Id列表 |
InstanceStatus(实例状态表)
| 实例状态 | 状态说明 |
|---|---|
| CREATING | 创建中 |
| CREATE_FAILED | 创建失败 |
| RUNNING | 运行中 |
| FAILED | 失败 |
| RESTARTING | 重启中 |
| DELETING | 删除中 |
| SOFTDELETED | 软删除 |
| HARDDELETED | 硬删除 |
| EXPIRED | 已过期 |
| ARREARS | 已欠费 |
| RESTORE_FAILED | 恢复失败 |
| RESTORING | 恢复中 |
| UPGRADING | 更配中 |
| UPGRADE_FLAVOR_FAILED | 更配失败 |
| EXTENDING | 扩容中 |
| EXTEND_STORAGE_FAILED | 扩容失败 |
ChargeType(支付类型)
| 实例状态 | 状态说明 |
|---|---|
| hourlySettlement | 按需付费 |
| monthly | 包年包月 |
Backup(备份参数)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | String | Y | 备份ID |
| createdAt | Date | Y | 创建时间 |
| updatedAt | Date | Y | 更新时间 |
| deletedAt | Date | Y | 删除时间 |
| isDeleted | Boolean | Y | 是否删除 |
| instanceId | String | Y | 数据库实例ID |
| operationId | String | Y | 实例ID |
| name | String | Y | 备份名称，默认为Backup-YYYYMMDDHHmmSS，如Backup-20190129123005 |
| backupType | BackupType | Y | 备份类型，默认：PHYSICAL |
| backupMode | BackupMode | Y | 备份模式，默认：FULL |
| backupMethod | BackupMethod | Y | 备份方法 |
| status | BackupStatus | Y | 备份状态 |
| size | Long | Y | 备份大小 |
| container | String | Y | swift容器名称 |
| lastRecoveryTime | Date | Y | 上次恢复时间 |
| retentionDays | Integer | Y | 保存天数 |
| isRestoring | Boolean | Y | 备份文件是否在使用 |
BackupType(备份类型)
| 实例状态 | 状态说明 |
|---|---|
| PHYSICAL | 物理备份 |
| LOGIC | 逻辑备份 |
BackupMode(备份模式)
| 实例状态 | 状态说明 |
|---|---|
| FULL | 全量备份 |
| INCREMENTAL | 增量备份 |
BackupMethod(备份方法)
| 实例状态 | 状态说明 |
|---|---|
| MANUAL | 手动备份 |
| AUTO | 自动备份 |
BackupStatus(备份状态)
| 实例状态 | 状态说明 |
|---|---|
| FAILED | 失败 |
| COMPLETED | 成功 |
| PROCESSING | 备份中 |
ParameterTemplateType(参数模板类型)
| 实例状态 | 状态说明 |
|---|---|
| DEFAULT | 系统默认 |
| CUSTOM | 用户自定义 |
PMAParameters(数据库管理参数：请求)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| userName | String | Y | 数据库用户名称 |
| password | String | Y | 数据库用户密码 |
| serverName | String | Y | 实例名称 |
| serverId | String | Y | 实例Id |
PMAParameters(数据库管理参数：返回)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| isSuccess | Boolean | Y | 登录是否成功 |
| message | Boolean | Y | 响应信息 |
| code | Boolean | Y | 响应码 |
| cookies | Boolean | Y | phpadmin所需的用户名密码等信息 |
InstanceClass(实例规格参数)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | String | Y | 规格id |
| code | String | Y | 规格编码 |
| name | String | Y | 规格名称 |
| cpu | Integer | Y | CPU大小 |
| ram | Integer | Y | 内存大小 |
| maxConn | Integer | Y | 最大连接数 |
| iops | Integer | Y | iops大小 |
| flavor | String | Y | 对应OpenStack使用标识 |
| description | String | Y | 规格描述信息 |
| createdAt | Date | Y | 创建时间 |
| updatedAt | Date | Y | 更新时间 |
| deletedAt | Date | Y | 删除时间 |
| isDeleted | Boolean | Y | 是否删除 |
Template(实例模板参数)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | String | Y | 模板id |
| name | String | Y | 模板名称 |
| version | String | Y | 模板版本号 |
| instanceType | String | Y | 实例类型（HARDS） |
| engine | String | Y | 引擎名称 |
| engineVersion | String | Y | 引擎版本号 |
| image | String | Y | 镜像id |
| isLatest | Boolean | Y | 是否是最新版本 |
| updateSupport | String | Y | 是否支持升级 |
| createdAt | Date | Y | 创建时间 |
| updatedAt | Date | Y | 更新时间 |
| deletedAt | Date | Y | 删除时间 |
| isDeleted | Boolean | Y | 是否删除 |
InstanceVpcInfo(实例网络信息参数)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| instanceId | String | Y | 实例id |
| dbInstanceIdentifier | String | Y | 实例名称 |
| status | InstanceStatus | Y | 实例状态（枚举） |
| dbInstanceAddress | String | Y | 数据库连接地址 |
| engine | String | Y | 引擎名称 |
| engineVersion | String | Y | 引擎版本号 |
| dbInstancePort | Integer | Y | 数据库连接端口号 |
| subnetId | String | Y | 子网id |
InstanceUpgradeStats(升级统计参数：返回)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| total | Integer | Y | 本次可升级实例总数 |
| success | Integer | Y | 成功数 |
| failed | Integer | Y | 失败数 |
| patching | Integer | Y | 升级中实例数 |
| unpatched | Integer | Y | 未升级实例数 |
| instanceUpgradeInfo | List< InstanceUpgradeInfo > | Y | 实例升级信息列表 |
InstanceUpgradeInfo(实例升级参数：返回)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| instanceId | String | Y | 实例id |
| status | UpgradeStatus | Y | 实例升级状态 |
| retryCount | Integer | Y | 重试次数 |
| lastResult | String | Y | 最新结果 |
InstanceUpgradeRequest(升级参数：请求)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| patchId | String | Y | 补丁id |
| patchNum | Integer | Y | 本次升级实例总数 |
| patchParameters | PatchParameters | Y | 本次升级个性化参数 |
| ignoredInstances | List< String > | Y | 本次升级忽略实例列表 |
UpgradeJobs(升级参数：返回)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | String | N | 升级任务id |
| createdAt | Date | N | 创建时间 |
| updatedAt | Date | N | 更新时间 |
| deletedAt | Date | N | 删除时间 |
| isDeleted | Boolean | N | 是否删除 |
| instanceId | String | Y | 实例id |
| patchId | String | Y | 补丁id |
| originalTemplateId | String | Y | 源模板id |
| targetTemplateId | String | Y | 目标模板id |
| operationId | String | Y | 操作id |
| status | UpgradeStatus | Y | 实例升级状态（枚举） |
UpgradeStatus(升级状态)
| 实例状态 | 状态说明 |
|---|---|
| PATCHING | 升级中 |
| SUCCESS | 成功 |
| UNPATCHED | 未升级 |
| FAILED | 失败 |
InstanceBindEip(实例绑定eip参数)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | String | Y | 主实例id |
| eipId | String | Y | 弹性公网Ip id |
| eip | String | Y | 弹性公网Ip地址 |
| securityGroupIds | List |
N | 安全组id列表 |
InstanceUnbindEip(实例解绑eip参数)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | String | Y | 主实例id |
| eipId | String | Y | 弹性公网Ip id |
| eniId | String | Y | 弹性网卡 id |