AddNodeList
修改实例节点详情。
被如下接口引用：ModifyDBInstanceSpec。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Role | String | 是 | 需要新增的节点角色。 - SECONDARY：Mongod 节点。 - READONLY：只读节点。 - MONGOS：Mongos 节点。 示例值：SECONDARY |
| Zone | String | 是 | 节点所对应的可用区。当前支持的可用区，请参见地域和可用区。 - 单可用区，所有节点在同一可用区。 - 多可用区：当前标准规格是三可用区分布，主从节点不在同一可用区，需注意配置新增节点对应的可用区，且新增后必须满足任意2个可用区节点数大于第3个可用区原则。 示例值：ap-guangzhou-2 |
Auth
用户权限
被如下接口引用：CreateAccountUser, DescribeAccountUsers, SetAccountUserPrivilege。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Mask | Integer | 是 | 当前账号具有的权限信息。 - 0：无权限。 - 1：只读。 - 3：读写。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| NameSpace | String | 是 | 指具有当前账号权限的数据库名。 - * ：表示所有数据库。 - db.name：表示特定 name 的数据库。 注意：此字段可能返回 null，表示取不到有效值。 示例值："db_test" |
BackupDownloadTask
备份下载任务
被如下接口引用：DescribeBackupDownloadTask。
| 名称 | 类型 | 描述 |
|---|---|---|
| CreateTime | String | 任务创建时间。 示例值：2021-01-02 15:04:05 |
| BackupName | String | 备份文件名。 示例值：cmgo-74sj****_2021-03-24 15:40 |
| ReplicaSetId | String | 分片名称。 示例值：cmgo-74sj****_0 |
| BackupSize | Integer | 备份数据大小，单位：字节。 示例值：102400 |
| Status | Integer | 任务状态。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。 示例值：0 |
| Percent | Integer | 任务进度百分比。 示例值：20 |
| TimeSpend | Integer | 耗时，单位为秒。 示例值：60 |
| Url | String | 备份数据下载链接。 示例值：http://cmgo-****.b.c/d.tar?e |
| BackupMethod | Integer | 备份方式。 - 0：逻辑备份。 - 1：物理备份。 - 3：快照备份。 说明: 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。 2. 实例开通存储加密，则备份方式不能为物理备份。 示例值：1 |
| BackupDesc | String | 发起备份时指定的备注信息。 示例值：我的备份 |
| Region | String | 地区信息。 示例值：ap-guangzhou |
| Bucket | String | Bucket信息。 示例值：my_bucket |
BackupDownloadTaskStatus
创建备份下载任务结果。
被如下接口引用：CreateBackupDownloadTask。
| 名称 | 类型 | 描述 |
|---|---|---|
| ReplicaSetId | String | 分片名。 示例值：cmgo-74sjf5mt_0 |
| Status | Integer | 任务当前状态。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。 示例值：0 |
BackupInfo
备份信息。
被如下接口引用：DescribeDBBackups。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID。 示例值：cmgo-ca2n**** |
| BackupType | Integer | 备份方式。 - 0：自动备份。 - 1：手动备份。 示例值：0 |
| BackupName | String | 备份文件名称。 示例值：cmgo-ca2n****_2021-12-13 02:02 |
| BackupDesc | String | 备份任务备注信息。 示例值：系统后台每日定时自动备份 |
| BackupSize | Integer | 备份文件大小，单位：KB。 示例值：326594030 |
| StartTime | String | 备份开始时间。 示例值：2021-12-13 02:02:51 |
| EndTime | String | 备份结束时间。 示例值：2021-12-13 03:02:51 |
| Status | Integer | 备份状态。 - 1：备份中。 - 2：备份成功。 示例值：2 |
| BackupMethod | Integer | 备份方式。 - 0：逻辑备份。 - 1：物理备份。 - 3：快照备份。 说明: - 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。 - 实例开通存储加密，则备份方式不能为物理备份。 示例值：0 |
| BackId | Integer | 备份记录 ID。 示例值：6997433 |
| DeleteTime | String | 备份删除时间。 示例值：2099-01-01 00:00:00 |
| BackupRegion | String | 异地备份地域。 示例值：ap-guangzhou |
| RestoreTime | String | 备份支持的回档时间。 示例值：2021-12-13 03:02:51 |
ClientConnection
客户端连接信息，包括客户端IP和连接数
被如下接口引用：DescribeClientConnections。
| 名称 | 类型 | 描述 |
|---|---|---|
| IP | String | 连接的客户端 IP。 示例值：192.168.1.1 |
| Count | Integer | 对应客户端 IP 的连接数。 示例值：9 |
| InternalService | Boolean | 是否为内部 IP。 示例值：true |
CurrentOp
云数据库实例当前操作
被如下接口引用：DescribeCurrentOp。
| 名称 | 类型 | 描述 |
|---|---|---|
| OpId | Integer | 操作序号。 示例值：1804858933 |
| Ns | String | 操作所在的命名空间，形式如db.collection。 示例值：db.test |
| Query | String | 操作执行语句。 示例值：执行语句 |
| Op | String | 操作类型。 - none：特殊状态，空闲连接或内部任务等。 - update：更新数据。 - insert：插入操作。 - query：查询操作。 - command：命令操作。 - getmore：获取更多数据。 - remove：删除操作。 - killcursors：释放查询游标的操作。 示例值：update |
| ReplicaSetName | String | 操作所在的分片名称。 示例值：cmgo-12asa***_0 |
| NodeName | String | 操作所在的节点名称。 示例值：9.18.157.*:70:234**** |
| Operation | String | 操作详细信息。 示例值：操作详情 |
| State | String | 节点角色。 - primary：主节点。 - secondary：从节点。 示例值：Secondary |
| MicrosecsRunning | Integer | 操作已执行时间（ms）。 示例值：30353723 |
| ExecNode | String | 当前操作所在节点信息。 示例值：从节点 |
DBInstanceInfo
实例信息
被如下接口引用：DescribeDBInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：cmgo-12sad**** |
| Region | String | 地域信息 示例值：ap-guangzhou |
DBInstancePrice
数据库实例价格
被如下接口引用：InquirePriceCreateDBInstances, InquirePriceModifyDBInstanceSpec, InquirePriceRenewDBInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UnitPrice | Float | 是 | 实例单价。单位：元。 示例值：0.17 |
| OriginalPrice | Float | 是 | 实例原价。单位：元。 示例值：210 |
| DiscountPrice | Float | 是 | 实例折扣价。单位：元。 示例值：198 |
DbURL
数据库实例 URI 形式的连接串访问地址示例。
被如下接口引用：DescribeDBInstanceURL。
| 名称 | 类型 | 描述 |
|---|---|---|
| URLType | String | 指 URI 类别，包括：， - CLUSTER_ALL：指通过该 URI 连接库实例的主节点，可读写。 - CLUSTER_READ_READONLY：指通过该 URI 连接实例只读节点。 - CLUSTER_READ_SECONDARY：指通过该 URI 连接实例从节点。 - CLUSTER_READ_SECONDARY_AND_READONLY：指通过该 URI 连接实例只读从节点。 - CLUSTER_PRIMARY_AND_SECONDARY：指通过该 URI 连接实例 主节点与从节点。 - MONGOS_ALL：指通过该 URI 连接每个 Mongos 节点，可读写。 - MONGOS_READ_READONLY：指通过该 URI 连接 Mongos 的只读节点。 - MONGOS_READ_SECONDARY：指通过该 URI 连接 Mongos 的从节点。 - MONGOS_READ_PRIMARY_AND_SECONDARY：指通过该URI 连接 Mongos 的主节点与从节点。 - MONGOS_READ_SECONDARY_AND_READONLY：指通过该URI 连接 Mongos 的从节点与只读节点。 示例值：MONGOS_ALL |
| Address | String | 实例 URI 形式的连接串访问地址示例。 示例值：mongodb://mongouser:**@10.0.5.:27017/test?replicaSet=cmgo-ldig**_0&authSource=admin |
FBKeyValue
按 Key 闪回键值对
被如下接口引用：FlashBackDBInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | 指定按 Key 闪回的目标 Key （键） 。 示例值：fbKey |
| Value | String | 否 | 指定按 Key 闪回的目标 Key 所对应的 Value（值）。 示例值：fbValue |
FlashbackCollection
按 Key 闪回数据表
被如下接口引用：FlashBackDBInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CollectionName | String | 是 | 指定按 Key 闪回源数据库集合名。 示例值：my_collection |
| TargetResultCollectionName | String | 是 | 指定按 Key 闪回目标数据库集合名。 示例值：my_collection_re |
| FilterKey | String | 是 | 指定用于过滤按 Key 闪回的 Key（键）。 示例值：fKey |
| KeyValues | Array of FBKeyValue | 否 | 指定用于按 Key 闪回的键值对。数组元素最大限制为 50000。 示例值：fValue |
FlashbackDatabase
按 Key 闪回的数据库及集合信息
被如下接口引用：FlashBackDBInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DBName | String | 是 | 按 Key 闪回目标数据所在库。 示例值：my-db |
| Collections | Array of FlashbackCollection | 是 | 按 Key 闪回的数据库集合。 示例值：my-collection |
InstanceChargePrepaid
描述了实例的计费模式
被如下接口引用：InquirePriceRenewDBInstances, RenewDBInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Period | Integer | 否 | 购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。 示例值：1 |
| RenewFlag | String | 否 | 自动续费标识。取值范围： - NOTIFY_AND_AUTO_RENEW：通知过期且自动续费。在账户余额充足的情况下，实例到期后将按月自动续费。 - NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。默认为NOTIFY_AND_MANUAL_RENEW。 - DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费。 示例值：NOTIFY_AND_AUTO_RENEW |
InstanceDetail
实例详情。
被如下接口引用：DescribeDBInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例 ID。 示例值：cmgo-7pje**** |
| InstanceName | String | 实例名称。 示例值：test-instance |
| PayMode | Integer | 付费类型。 - 1：包年包月。 - 0：按量计费。 示例值：1 |
| ProjectId | Integer | 项目 ID。 示例值：1 |
| ClusterType | Integer | 集群类型。 - 0：副本集实例。 - 1：分片实例。 示例值：1 |
| Region | String | 地域信息。 示例值：ap-guangzhou |
| Zone | String | 可用区信息。 示例值：ap-guangzhou-2 |
| NetType | Integer | 网络类型。 - 0：基础网络。 - 1：私有网络。 示例值：1 |
| VpcId | String | 私有网络的ID。 示例值：vpc-0vjm**** |
| SubnetId | String | 私有网络的子网ID。 示例值：subnet-emtf**** |
| Status | Integer | 实例状态。 - 0：待初始化。 - 1：流程处理中，例如：变更规格、参数修改等。 - 2：实例正常运行中。 - -2：已隔离（包年包月）。 - -3：已隔离（按量计费）。 示例值：2 |
| Vip | String | 实例IP。 示例值：10.100.0.** |
| Vport | Integer | 端口号。 示例值：27017 |
| CreateTime | Timestamp | 实例创建时间。 示例值：2010-07-25 18:00:00 |
| DeadLine | Timestamp | 实例到期时间。 示例值：2010-07-25 20:00:00 |
| MongoVersion | String | 实例存储引擎版本信息。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。 - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。 - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。 - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。 - MONGO_70_WT：MongoDB 7.0 WiredTiger存储引擎版本。 示例值：MONGO_42_WT |
| Memory | Integer | 实例内存规格，单位：MB。 示例值：4 |
| Volume | Integer | 实例磁盘规格，单位：MB。 示例值：120 |
| CpuNum | Integer | 实例 CPU 核心数。 示例值：2 |
| MachineType | String | 实例机器类型。 - HIO10G：通用高 HIO 万兆型。 - HCD：云盘版类型。 示例值：HIO10G |
| SecondaryNum | Integer | 实例从节点数。 示例值：2 |
| ReplicationSetNum | Integer | 实例分片数。 示例值：3 |
| AutoRenewFlag | Integer | 实例自动续费标志。 - 0：手动续费。 - 1：自动续费。 - 2：确认不续费。 示例值：0 |
| UsedVolume | Integer | 已用容量，单位：MB。 示例值：100 |
| MaintenanceStart | String | 维护窗口起始时间。 示例值：04:00:00 |
| MaintenanceEnd | String | 维护窗口结束时间。 示例值：05:00:00 |
| ReplicaSets | Array of ShardInfo | 分片信息。 |
| ReadonlyInstances | Array of DBInstanceInfo | 只读实例信息。 |
| StandbyInstances | Array of DBInstanceInfo | 灾备实例信息。 |
| CloneInstances | Array of DBInstanceInfo | 临时实例信息。 |
| RelatedInstance | DBInstanceInfo | 关联实例信息，对于正式实例，该字段表示它的临时实例信息；对于临时实例，则表示它的正式实例信息;如果为只读/灾备实例,则表示他的主实例信息。 |
| Tags | Array of TagInfo | 实例标签信息集合。 |
| InstanceVer | Integer | 实例版本标记。 示例值：4 |
| ClusterVer | Integer | 实例版本标记。 示例值：1 |
| Protocol | Integer | 协议信息：mongodb。 示例值：0 |
| InstanceType | Integer | 实例类型。 - 0：所有实例。 - 1：正式实例。 - 2：临时实例 - 3：只读实例。 - -1：同时包括正式实例、只读实例与灾备实例。 示例值：1 |
| InstanceStatusDesc | String | 实例状态描述。 示例值：运行中 |
| RealInstanceId | String | 实例对应的物理实例 ID。回档并替换过的实例有不同的 InstanceId 和 RealInstanceId，从 barad 获取监控数据等场景下需要用物理 ID 获取。 示例值：cmgo-8go1o9xl |
| ZoneList | Array of String | 实例当前可用区信息。 示例值：["ap-guangzhou-2","ap-guangzhou-3","ap-guangzhou-4"] |
| MongosNodeNum | Integer | mongos 节点个数。 示例值：3 |
| MongosMemory | Integer | mongos 节点内存。单位：MB。 示例值：2 |
| MongosCpuNum | Integer | mongos 节点 CPU 核数。 示例值：1 |
| ConfigServerNodeNum | Integer | Config Server节点个数。 示例值：3 |
| ConfigServerMemory | Integer | Config Server节点内存。单位：MB。 示例值：2 |
| ConfigServerVolume | Integer | Config Server节点磁盘大小。单位：MB。 示例值：20 |
| ConfigServerCpuNum | Integer | Config Server 节点 CPU 核数。 示例值：1 |
| ReadonlyNodeNum | Integer | readonly节点个数。 示例值：3 |
InstanceEnumParam
实例可修改参数枚举类型集合。
被如下接口引用：DescribeDBInstanceParamTplDetail, DescribeInstanceParams。
| 名称 | 类型 | 描述 |
|---|---|---|
| CurrentValue | String | 参数当前值。 示例值："all" |
| DefaultValue | String | 参数默认值。 示例值："slowOp" |
| EnumValue | Array of String | 枚举值，所有支持的值。 示例值：["off","slowOp","all"] |
| NeedRestart | String | 参数修改之后是否需要重启生效。 - 1：需要重启后生效。 - 0：无需重启，设置成功即可生效。 示例值："0" |
| ParamName | String | 参数名称。 示例值："operationProfiling.mode" |
| Tips | Array of String | 参数说明。 示例值：["事务加锁超时时间","max transaction lockrequest timeout millis"] |
| ValueType | String | 参数值类型说明。 示例值："enum" |
| Status | Integer | 是否为运行中参数值。 - 1：运行中参数值。 - 0：非运行中参数值。 示例值：1 |
InstanceIntegerParam
实例可修改参数 Integer 类型集合。
被如下接口引用：DescribeDBInstanceParamTplDetail, DescribeInstanceParams。
| 名称 | 类型 | 描述 |
|---|---|---|
| CurrentValue | String | 参数当前值。 示例值："100" |
| DefaultValue | String | 参数默认值。 示例值："100" |
| Max | String | 参数最大值。 示例值："65536" |
| Min | String | 最小值。 示例值："0" |
| NeedRestart | String | 参数修改之后是否需要重启生效。 - 1:需要重启后生效。 - 0：无需重启，设置成功即可生效。 示例值："1" |
| ParamName | String | 参数名称。 示例值："operation.profiling.slowOpThresholdMs" |
| Tips | Array of String | 参数说明。 示例值：["数据库profiler确定慢查询的阈值，单位毫秒，默认值100","The Performance Advisor re"] |
| ValueType | String | 参数类型。 示例值："integer" |
| Status | Integer | 是否为运行中参数值。 - 1：运行中参数值。 - 0：非运行中参数值。 示例值：1 |
| Unit | String | 冗余字段，可忽略。 示例值：1 |
InstanceMultiParam
实例可修改参数Multi类型集合。
被如下接口引用：DescribeDBInstanceParamTplDetail, DescribeInstanceParams。
| 名称 | 类型 | 描述 |
|---|---|---|
| CurrentValue | String | 参数当前值。 示例值："01:00" |
| DefaultValue | String | 参数默认值。 示例值：NULL |
| EnumValue | Array of String | 参考值范围。 示例值：["00:00","23:00" ] |
| NeedRestart | String | 参数修改后是否需要重启才会生效。 - 1：需要重启后生效。 - 0：无需重启，设置成功即可生效。 示例值："1" |
| ParamName | String | 参数名称。 示例值："openBalance.window" |
| Status | Integer | 是否为运行中参数值。 - 1：运行中参数值。 - 0：非运行中参数值。 示例值："1" |
| Tips | Array of String | 参数说明。 示例值：["负载均衡时间窗","balance.window"] |
| ValueType | String | 当前值的类型描述，默认为multi。 示例值："multi" |
InstanceTextParam
实例可修改参数为 Text 类型的参数集合。
被如下接口引用：DescribeDBInstanceParamTplDetail, DescribeInstanceParams。
| 名称 | 类型 | 描述 |
|---|---|---|
| CurrentValue | String | 参数当前值。 示例值：textParam |
| DefaultValue | String | 参数默认值。 示例值：textParam |
| NeedRestart | String | 修改参数值之后是否需要重启。 示例值：1 |
| ParamName | String | 参数名称。 示例值：operationProfiling.**** |
| TextValue | String | Text 类型参数对应的值。 示例值：currentTtext |
| Tips | Array of String | 参数说明。 示例值：参数描述 |
| ValueType | String | 参数值类型说明。 示例值：txt |
| Status | String | 是否为运行中的参数值。 - 1：运行中参数值。 - 0：非运行中参数值。 示例值：1 |
KMSInfoDetail
KMS密钥信息
被如下接口引用：DescribeTransparentDataEncryptionStatus。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| KeyId | String | 否 | 主密钥 ID。 示例值：e648b6c-584a-11ef-a5d2-5254002**** |
| KeyName | String | 否 | 主密钥名称。 示例值：stg02-ai-bj-kms-** |
| CreateTime | String | 否 | 实例与密钥绑定时间。 示例值：2021-01-02 15:04:05 |
| Status | String | 否 | 密钥状态。 - Enabled：开启。 - Disabled：不开启。 示例值：Enabled |
| KeyUsage | String | 否 | 密钥用途。 示例值：ENCRYPT_DECRYPT |
| KeyOrigin | String | 否 | 密钥来源。 示例值：TENCENT_KMS |
| KmsRegion | String | 否 | kms所在地域。 示例值：ap-guangzhou |
ModifyMongoDBParamType
修改mongoDB实例，请求参数
被如下接口引用：ModifyInstanceParams。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 需要修改的参数名称，请严格参考通过 DescribeInstanceParams 获取的当前实例支持的参数名。 示例值："operationProfiling.****" |
| Value | String | 是 | 需要修改的参数名称对应的值，请严格参考通过 DescribeInstanceParams 获取的参数对应的值的范围。 示例值：off |
ModifyNetworkAddress
修改数据库地址
被如下接口引用：ModifyDBInstanceNetworkAddress。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NewIPAddress | String | 是 | 新IP地址。 示例值：172.16.0.** |
| OldIpAddress | String | 是 | 原IP地址。 示例值：172.16.1.** |
NodeProperty
节点属性
被如下接口引用：DescribeDBInstanceNodeProperty。
| 名称 | 类型 | 描述 |
|---|---|---|
| Zone | String | 节点所在的可用区。 示例值：ap-guangzhou-1 |
| NodeName | String | 节点名称。 示例值：cmgo-ocdv****_0-node-primary |
| Address | String | 节点访问地址。 示例值：10.4.0.7:30000 |
| WanServiceAddress | String | 节点公网访问外网地址(IP或域名，示例为IP方式)。 示例值：113.0..:27017 |
| Role | String | 节点角色。 - PRIMARY：主节点。 - SECONDARY：从节点。 - READONLY：只读节点。 - ARBITER：仲裁节点。 示例值：PRIMARY |
| Hidden | Boolean | 节点是否为 Hidden 节点。 - true：Hidden 节点。 - false：非 Hidden 节点。 示例值：false |
| Status | String | 节点状态。 - NORMAL：正常运行中。 - STARTUP：正在启动。 - STARTUP2：正在启动，处理中间数据。 - RECOVERING：恢复中，暂不可用。 - DOWN：已掉线。 - UNKNOWN：未知状态。 - ROLLBACK：回滚中。 - REMOVED：已移除。 示例值：NORMAL |
| SlaveDelay | Integer | 主从同步延迟时间，单位：秒。 示例值：1 |
| Priority | Integer | 节点优先级。其取值范围为[0,100]，数值越高，优先级越高。 示例值：10 |
| Votes | Integer | 节点投票权。 - 1：具有投票权。 - 0：无投票权。 示例值：1 |
| Tags | Array of NodeTag | 节点标签。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"TagKey":"role-cmgo","TagValue":"primary-secondary-group"}] |
| ReplicateSetId | String | 副本集 ID。 示例值：cmgo-ocdv****_0 |
NodeTag
节点Tag
被如下接口引用：DescribeDBInstanceNodeProperty。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 否 | 节点Tag key 示例值：testKey |
| TagValue | String | 否 | 节点Tag Value 示例值：testValue |
Operation
需要终止的操作。
被如下接口引用：KillOps。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ReplicaSetName | String | 是 | 操作所在的分片名称。请通过接口 DescribeCurrentOp 查询分片名称。 示例值：cmgo-bbzl****_0 |
| NodeName | String | 是 | 操作所在的节点名。请通过接口 DescribeCurrentOp 查询节点名称。 示例值：30.99..:7005:244** |
| OpId | Integer | 是 | 操作序号。请通过接口 DescribeCurrentOp 查询操作序号。 示例值：918759117 |
ParamTpl
数据库参数模板
被如下接口引用：DescribeDBInstanceParamTpl。
| 名称 | 类型 | 描述 |
|---|---|---|
| TplName | String | 参数模板名称。 示例值：压测参数模板 |
| TplId | String | 参数模板 ID。 示例值：tpl-adh42hg1y |
| MongoVersion | String | 参数模板适用的数据库版本。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本， - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本， - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。 - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。 - MONGO_70_WT：MongoDB 7.0 WiredTiger存储引擎版本。 示例值：MONGO_42_WT |
| ClusterType | String | 参数模板适用的数据库类型。 - REPLSET：副本集实例。 - SHARD：分片实例。 - STANDALONE：单节点实例。 示例值：SHARD |
| TplDesc | String | 参数模板描述。 示例值：用于压测 |
| TplType | String | 模板类型。 - DEFAULT：系统默认模板。 - CUSTOMIZE：自定义模板。 示例值：DEFAULT |
ParamType
数据库参数
被如下接口引用：CreateDBInstanceParamTpl, ModifyDBInstanceParamTpl。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 参数 示例值：balance.window |
| Value | String | 是 | 参数值 示例值：1|2 |
RemoveNodeList
修改实例节点详情。
被如下接口引用：ModifyDBInstanceSpec。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Role | String | 是 | 需要删除的节点角色。 - SECONDARY：Mongod 从节点。 - READONLY：只读节点。 - MONGOS：Mongos 节点。 示例值：SECONDARY |
| NodeName | String | 是 | 要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可，其余分片对该组对齐。 - 获取方式：登录 MongoDB控制台，在节点管理页签，可获取节点 ID。 - 特别说明：分片集群同一节点上的分片，仅需指定0分片节点 ID 即可。例如：cmgo-6hfk****_0-node-primary。 示例值：cmgo-3iecwbfx_0-node-readonly0 |
| Zone | String | 是 | 节点所对应的可用区。当前支持可用区信息，请参见地域和可用区。 - 单可用区，所有节点在同一可用区。 - 多可用区：当前标准规格是三可用区分布，主从节点不在同一可用区，需注意配置所删除节点对应的可用区，且删除后必须满足任意2个可用区节点数大于第3个可用区原则。 示例值：ap-guangzhou-2 |
ReplicaSetInfo
分片信息。
被如下接口引用：CreateBackupDownloadTask。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ReplicaSetId | String | 是 | 副本集 ID。 示例值：cmgo_ih8uido9_0 |
ReplicateSetInfo
副本集信息
被如下接口引用：DescribeDBInstanceNodeProperty。
| 名称 | 类型 | 描述 |
|---|---|---|
| Nodes | Array of NodeProperty | 节点属性 |
SecurityGroup
安全组信息
被如下接口引用：DescribeSecurityGroup。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProjectId | Integer | 所属项目 ID。 示例值：0 |
| CreateTime | String | 安全组创建时间。 示例值：2021-01-02 15:04:05 |
| Inbound | Array of SecurityGroupBound | 安全组入站规则。 |
| Outbound | Array of SecurityGroupBound | 安全组出站规则。 |
| SecurityGroupId | String | 安全组 ID。 示例值：sg-lxdv**** |
| SecurityGroupName | String | 安全组名称。 示例值：Security Test |
| SecurityGroupRemark | String | 安全组备注信息。 示例值：暴露全部端口到公网和内网，有一定安全风险 |
SecurityGroupBound
安全组规则
被如下接口引用：DescribeSecurityGroup。
| 名称 | 类型 | 描述 |
|---|---|---|
| Action | String | 执行策略。 - ACCEPT：允许，放行该端口相应的访问请求。 - DROP：拒绝，直接丢弃数据包，不返回任何回应信息。 示例值：ACCEPT |
| CidrIp | String | 访问数据库的入站 IP 或 IP 段。 示例值：0.0.0.0/0 |
| PortRange | String | 访问数据库的端口。 示例值：80,443 |
| IpProtocol | String | 传输层协议：tcp。 示例值：tcp |
| Id | String | 安全组 ID。 示例值：sg-kayh**** |
| AddressModule | String | IP 地址或 IP 地址组参数模板 ID。请登录参数模板控制台获取参数模板 IP 地址详情。 示例值：ipm-0h4k**** |
| ServiceModule | String | 协议端口或协议端口组参数模板 ID。请登录参数模板控制台获取参数模板协议端口详情。 示例值：ppm-ay7b**** |
| Desc | String | 安全组描述信息。 示例值：my-SecurityGroupBound |
ShardInfo
实例分片详情
被如下接口引用：DescribeDBInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| UsedVolume | Float | 分片已使用容量 示例值：100 |
| ReplicaSetId | String | 分片ID 示例值：cmgo-pzb****_0 |
| ReplicaSetName | String | 分片名 示例值：cmgo-pzb****_0 |
| Memory | Integer | 分片内存规格，单位为MB 示例值：8192 |
| Volume | Integer | 分片磁盘规格，单位为MB 示例值：51200 |
| OplogSize | Integer | 分片Oplog大小，单位为MB 示例值：1024 |
| SecondaryNum | Integer | 分片从节点数 示例值：2 |
| RealReplicaSetId | String | 分片物理id 示例值：cmgo-pzb****_0 |
SlowLogItem
慢日志详情
被如下接口引用：DescribeDetailedSlowLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Log | String | 慢日志详情。 示例值："Mon Sep 22 20:30:19.980 I COMMAND [] command admin.$cmd command: saslContinue { : 1, conversationId: 1, payload: BinData(0, ), $clusterTime: { clusterTime: Timestamp(1758544211, 1), **" |
| NodeName | String | 节点名称。 示例值："cmgo-r3p8hslf_0-node-primary" |
| QueryHash | String | 查询哈希值。 示例值："admin..*Continue" |
SlowLogPattern
用于描述MongoDB数据库慢日志统计信息
被如下接口引用：DescribeSlowLogPatterns。
| 名称 | 类型 | 描述 |
|---|---|---|
| Pattern | String | 慢日志输出格式：库名.表名.命令。 示例值：admin.$cmd.command |
| QueryHash | String | 记录慢日志时所带的queryHash 值，标识一类查询。 示例值：83BAE67C |
| MaxTime | Integer | 最大执行时间。单位：毫秒。 示例值：578 |
| AverageTime | Integer | 平均执行时间。单位：毫秒。 示例值：546 |
| Total | Integer | 慢日志条数。 示例值：8 |
SpecItem
mongodb售卖规格。
被如下接口引用：DescribeSpecInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| SpecCode | String | 规格信息标识。格式如：mongo.HIO10G.128g。由节点类型、规格类型、内存规格三部分组成。 - 节点类型：mongo，指 Mongod 节点；mongos，指 Mongos 节点；cfgstr，指 Configserver 节点。 - 规格类型：HIO10G，指通用高HIO万兆型；HCD：指云盘版类型。 - 内存规格：支持4、8、16、32、64、128、240、512。单位g：表示GB。128g 则表示128GB。 示例值：mongo.HIO10G.128g |
| Status | Integer | 售卖规格有效标志，取值范围如下： - 0：停止售卖， - 1：开放售卖。 示例值：1 |
| Cpu | Integer | 计算资源规格，CPU核数。 示例值：2 |
| Memory | Integer | 内存规格，单位为：MB。 示例值：4096 |
| DefaultStorage | Integer | 默认磁盘规格，单位为：MB。 示例值：3072000 |
| MaxStorage | Integer | 最大磁盘规格，单位为：MB。 示例值：5120000 |
| MinStorage | Integer | 最小磁盘规格，单位为：MB。 示例值：1536000 |
| Qps | Integer | 指每秒最大请求次数，单位为：次/秒。 示例值：36000 |
| Conns | Integer | 规格所支持的最大连接数限制。 示例值：20000 |
| MongoVersionCode | String | 实例存储引擎版本信息。 - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。 - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。 - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。 - MONGO_70_WT：MongoDB 7.0 WiredTiger存储引擎版本。 示例值：MONGO_50_WT |
| MongoVersionValue | Integer | 实例版本对应的数字版本。 示例值：4 |
| Version | String | 实例版本信息。支持：4.2、4.4、5.0、6.0、7.0。 示例值：3.6 |
| EngineName | String | 存储引擎。 示例值：WiredTiger |
| ClusterType | Integer | 集群类型，取值如下： - 1：分片集群。 - 0：副本集集群。 示例值：1 |
| MinNodeNum | Integer | 每个副本集最小节点数。 示例值：3 |
| MaxNodeNum | Integer | 每个副本集最大节点数。 示例值：7 |
| MinReplicateSetNum | Integer | 最小分片数。 示例值：2 |
| MaxReplicateSetNum | Integer | 最大分片数。 示例值：20 |
| MinReplicateSetNodeNum | Integer | 每个分片最小节点数。 示例值：3 |
| MaxReplicateSetNodeNum | Integer | 每个分片最大节点数。 示例值：7 |
| MachineType | String | 集群的规格类型，取值范围如下： - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。 示例值：HIO10G |
SpecificationInfo
实例规格信息。
被如下接口引用：DescribeSpecInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Region | String | 地域信息。 示例值：ap-guangzhou |
| Zone | String | 可用区信息。 示例值：ap-guangzhou-1 |
| SpecItems | Array of SpecItem | 售卖规格信息。 |
| SupportMultiAZ | Integer | 是否支持跨可用区部署。 - 1：支持。 - 0：不支持。 示例值：1 |
TagInfo
实例标签信息
被如下接口引用：CreateDBInstance, CreateDBInstanceHour, DescribeDBInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签键 示例值：myTag |
| TagValue | String | 是 | 标签值 示例值：myTagValue |
UserInfo
账户基本信息
被如下接口引用：DescribeAccountUsers。
| 名称 | 类型 | 描述 |
|---|---|---|
| UserName | String | 账号名。 示例值：mongo_test |
| AuthRole | Array of Auth | 账号权限详情。 |
| CreateTime | String | 账号创建时间。 示例值：2021-09-28 14:25:38 |
| UpdateTime | String | 账号更新时间。 示例值：2021-09-28 14:25:38 |
| UserDesc | String | 备注信息。 示例值：mongodb测试账号 |
| ConsolePassUpdateTime | String | 控制台密码更新时间 示例值：2021-09-28 14:25:38 |
