附录
更新时间：2024-12-23
对象定义
DBInstanceModel
参数名称 |
类型 |
描述 |
|---|---|---|
| dbInstanceId | String | 实例ID |
| dbInstanceName | String | 数据库实例名 |
| connectionString | String | 数据库连接地址 |
| port | String | 数据库连接端口 |
| storageEngine | String | 存储引擎，取值参考 |
| engineVersion | String | 数据库引擎版本，取值参考 |
| dbInstanceType | String | 实例类型，取值参考 |
| dbInstanceStatus | String | 实例状态，取值参考 |
| dbInstanceCpuCount | Integer | 副本集实例CPU规格 |
| dbInstanceMemoryCapacity | Integer | 副本集实例内存规格，单位GB |
| dbInstanceStorage | Integer | 副本集实例存储规格，单位GB |
| mongosCount | Integer | 分片集Mongos组件数量,单位GB |
| shardCount | Integer | 分片集Shard组件数量 |
| createTime | Datetime | 实例创建时间 |
| votingMemberNum | Integer | 副本集实例投票节点数 |
| readonlyNodeNum | Integer | 副本集实例只读节点总个数 |
| vpcId | String | 实例所属VPC的短ID |
| paymentTiming | String | 付费方式： 预付费：Prepaid，后付费：Postpaid |
| subnets | List<SubnetModel> | 实例所在可用区和子网 |
| tags | List<TagModel> | 实例所属标签 |
| mongosList | List NodeModel | Mongos组件列表 |
| shardList | List NodeModel | Shard组件列表 |
| members | List Member | 副本集实例节点信息 |
SubnetModel
参数名称 |
参数类型 |
参数描述 |
|---|---|---|
| subnetId | String | 子网短ID |
| zoneName | String | 子网所属可用区。可通过调用查询可用区列表接口查询可用区列表。zoneName命名规范是小写的“国家-region-可用区序列"，例如北京可用区A为"cn-bj-a" |
LogServiceModel
参数名称 |
参数类型 |
参数描述 |
|---|---|---|
| type | String | 日志类型 运行日志：running，审计日志：audit，错误日志：error |
| status | String | 日志当前状态 |
Member
参数名称 |
参数类型 |
参数描述 |
|---|---|---|
| memberId | String | 节点IP |
| mongoStatus | String | 节点的mongo状态 primary, secondary, hidden |
| mongoType | String | 节点的mongo类型 replica, config, shard, mongos |
| readonly | String | 节点是否是只读节点 READ_ONLY, READ_WRITE |
| zoneName | String | 子网所属可用区。可通过调用查询可用区列表接口查询可用区列表。zoneName命名规范是小写的“国家-region-可用区序列"，例如北京可用区A为"cn-bj-a" |
| ip | String | 节点内网IP |
| mongoHost | String | 节点所绑定域名。若节点开通公网（即eip不为空），则节点的公网域名也是这个 |
| eip | String | 节点公网IP |
| diskUsedMB | Integer | 磁盘使用量 |
DbInstanceSimpleModel
参数名称 |
类型 |
描述 |
|---|---|---|
| dbInstanceId | String | 实例短ID |
| connectionString | String | 数据库链接字符串 |
| port | String | 数据库连接端口 |
TagModel
参数名称 |
参数类型 |
参数描述 |
|---|---|---|
| tagKey | String | 标签键 |
| tagValue | String | 标签值 |
NodeModel
参数名称 |
类型 |
描述 |
|---|---|---|
| nodeId | String | 组件ID |
| name | String | 组件名称 |
| status | String | 组件状态。具体参见 |
| cpuCount | Integer | 组件CPU规格 |
| memoryCapacity | Integer | 组件内存规格 |
| storage | Integer | 组件存储规格 |
| connectString | String | 组件链接字符串 |
| storageType | String | 组件存储类型。具体参见 |
| members | List<Member> | 组件内节点信息 |
BackupModel
参数名称 |
类型 |
描述 |
|---|---|---|
| backupId | String | 备份ID |
| backupSize | String | 备份大小。单位Byte |
| backupMethod | String | 备份方式，取值参考 |
| bakupMode | String | 备份模式，取值参考 |
| backupType | String | 备份类型，取值参考 |
| backupStatus | String | 备份状态，取值参考 |
| backupStartTime | DateTime | 备份开始时间 |
| backupEndTime | DateTime | 备份结束时间 |
| backupDescription | String | 备份详情 |
AutoBackupPolicyModel
参数名称 |
类型 |
是否必填 |
描述 |
|---|---|---|---|
| autoBackupEnable | String | 否 | 自动备份状态。取值范围：[ON,OFF]，ON为开启，OFF为关闭。默认为OFF。 |
| preferredBackupPeriod | String | 否 | 备份周期。当autoBackupEnable=ON时必填。如需传入多个值，多个值用英文逗号（,）隔开。 |
| preferredBackupTime | String | 否 | 备份时间。当autoBackupEnable=ON时必填。格式为HH:mmZ-HH:mmZ，时间范围限制为1小时。 |
| backupMethod | String | 否 | 备份生成方式。取值范围：[Physical,Snapshot]。 |
| enableIncrementBackup | Integer | 否 | 是否开启增量备份。0：关闭、1：开启,若要开启增量备份，必须开启自动备份（存量），即autoBackupEnable为“ON” |
| backupRetentionPeriod | Integer | 否 | 表示用于设置备份文件保留天数，默认7天；取值范围7~30 |
| incrBackupRetentionPeriod | Integer | 否 | 表示用于设置增量备份文件保留天数，默认7天；取值范围7~30 |
类型编码定义
StorageEngine
编码 |
描述 |
|---|---|
| WiredTiger | WiredTiger存储引擎 |
EngineVersion
编码 |
描述 |
|---|---|
| 3.4 | MongoDB 3.4 |
| 3.6 | MongoDB 3.6 |
InstanceType
编码 |
描述 |
|---|---|
| replica | 副本集 |
| sharding | 分片集 |
StorageType
编码 |
描述 |
|---|---|
| CDS_PREMIUM_SSD | 通用型SSD云磁盘 |
| CDS_ENHANCED_SSD | 增强型SSD云磁盘 |
| LOCAL_DISK | 本地NVME |
NodeType
编码 |
描述 |
|---|---|
| mongos | Mongos组件 |
| shard | Shard组件 |
BackupMethod
编码 |
描述 |
|---|---|
| Logical | 逻辑备份 |
| Physical | 物理备份 |
BackupMode
编码 |
描述 |
|---|---|
| Automated | 自动备份 |
| Manual | 手动备份 |
BackupType
编码 |
描述 |
|---|---|
| FullBackup | 全量备份 |
| IncrementalBackup | 增量备份 |
AutoBackupEnable
编码 |
描述 |
|---|---|
| ON | 开启自动备份 |
| OFF | 关闭自动备份 |
PreferredBackupPeriod
编码 |
描述 |
|---|---|
| Monday | 周一 |
| Tuesday | 周二 |
| Wednesday | 周三 |
| Thursday | 周四 |
| Friday | 周五 |
| Saturday | 周六 |
| Sunday | 周日 |
状态编码定义
InstanceStatus
编码 |
描述 |
|---|---|
| CREATING | 创建中 |
| RUNNING | 运行中 |
| RESTARTING | 实例重启中 |
| NODE_RESTARTING | 组件重启中 |
| NODE_CREATING | 组件添加中 |
| NODE_CLASS_CHANGING | 组件升降级中 |
| CLASS_CHANGING | 实例升降级中 |
| EXPIRED | 实例已过期或已欠费 |
| STARTING | （充值／续费）启动中 |
| STOPPING | （过期／欠费）停机中 |
NodeStatus
状态值 |
描述 |
|---|---|
| CREATING | 创建中 |
| RUNNING | 运行中 |
| RESTARTING | 组件重启中 |
| CLASS_CHANGING | 组件升降级中 |
BackupStatus
编码 |
描述 |
|---|---|
| BACKUPING | 备份中 |
| SUCC | 备份成功 |
| FAILED | 备份失败 |
套餐配置
副本集实例可选套餐
CPU核数 |
内存(GB) |
磁盘(GB) |
|---|---|---|
| 1 | 2 | 5-2000 |
| 2 | 4 | 5-2000 |
| 4 | 8 | 5-2000 |
| 4 | 16 | 5-2000 |
| 8 | 16 | 5-2000 |
| 8 | 32 | 5-2000 |
| 16 | 64 | 5-2000 |
分片集实例可选套餐
Mongos组件可选套餐
CPU核数 |
内存(GB) |
|---|---|
| 1 | 2 |
| 2 | 4 |
| 4 | 8 |
| 4 | 16 |
| 8 | 16 |
| 8 | 32 |
| 16 | 64 |
Shard组件可选套餐
CPU核数 |
内存(GB) |
磁盘(GB) |
|---|---|---|
| 1 | 2 | 5-2000 |
| 2 | 4 | 5-2000 |
| 4 | 8 | 5-2000 |
| 4 | 16 | 5-2000 |
| 8 | 16 | 5-2000 |
| 8 | 32 | 5-2000 |
| 16 | 64 | 5-2000 |
订单相关
Billing
状态 |
类型 |
描述 |
|---|---|---|
| paymentTiming | String | 付费方式, 预付费：Prepaid，后付费：Postpaid |
| reservation | Reservation | 保留信息，支付方式为后支付时不需要设置，预支付时必须设置 |
Reservation
状态 |
类型 |
描述 |
|---|---|---|
| reservationLength | Integer | 时长，[1,2,3,4,5,6,7,8,9,12,24,36] |
| reservationTimeUnit | String | 时间单位，Month，当前仅支持按月 |
