云数据库 MongoDB

文档中心云数据库 MongoDB API 文档数据结构

数据结构

最近更新时间：2024-04-09 01:18:26

我的收藏

本页目录：

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：只读。 2：只写。 3：读写。示例值：1
NameSpace	String	是	指具有当前账号权限的数据库名。 * ：表示所有数据库。 db.name：表示特定name的数据库。示例值："db_test"

BackupDownloadTask

备份下载任务

被如下接口引用：DescribeBackupDownloadTask。

名称	类型	描述
CreateTime	String	任务创建时间示例值：2021-01-02 15:04:05
BackupName	String	备份文件名示例值：cmgo-74sjf5mt_2021-03-24 15:40
ReplicaSetId	String	分片名称示例值：cmgo-74sjf5mt_0
BackupSize	Integer	备份数据大小，单位为字节示例值：102400
Status	Integer	任务状态。0-等待执行，1-正在下载，2-下载完成，3-下载失败，4-等待重试示例值：0
Percent	Integer	任务进度百分比示例值：20
TimeSpend	Integer	耗时，单位为秒示例值：60
Url	String	备份数据下载链接示例值：http://a.b.c/d.tar?e
BackupMethod	Integer	备份文件备份类型，0-逻辑备份，1-物理备份示例值：1
BackupDesc	String	发起备份时指定的备注信息注意：此字段可能返回 null，表示取不到有效值。示例值：我的备份

BackupDownloadTaskStatus

创建备份下载任务结果

被如下接口引用：CreateBackupDownloadTask。

名称	类型	描述
ReplicaSetId	String	分片名示例值：cmgo-74sjf5mt_0
Status	Integer	任务当前状态。0-等待执行，1-正在下载，2-下载完成，3-下载失败，4-等待重试示例值：0

BackupInfo

备份信息

被如下接口引用：DescribeDBBackups。

名称	类型	描述
InstanceId	String	实例ID
BackupType	Integer	备份方式，0-自动备份，1-手动备份
BackupName	String	备份名称
BackupDesc	String	备份备注注意：此字段可能返回 null，表示取不到有效值。
BackupSize	Integer	备份文件大小，单位KB 注意：此字段可能返回 null，表示取不到有效值。
StartTime	String	备份开始时间注意：此字段可能返回 null，表示取不到有效值。
EndTime	String	备份结束时间注意：此字段可能返回 null，表示取不到有效值。
Status	Integer	备份状态，1-备份中，2-备份成功
BackupMethod	Integer	备份方法，0-逻辑备份，1-物理备份

ClientConnection

客户端连接信息，包括客户端IP和连接数

被如下接口引用：DescribeClientConnections。

名称	类型	描述
IP	String	连接的客户端IP 示例值：192.168.1.1
Count	Integer	对应客户端IP的连接数示例值：9
InternalService	Boolean	是否为内部ip 示例值：true

CurrentOp

云数据库实例当前操作

被如下接口引用：DescribeCurrentOp。

名称	类型	描述
OpId	Integer	操作序号注意：此字段可能返回 null，表示取不到有效值。
Ns	String	操作所在的命名空间，形式如db.collection 注意：此字段可能返回 null，表示取不到有效值。
Query	String	操作执行语句注意：此字段可能返回 null，表示取不到有效值。
Op	String	操作类型，可能的取值：aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command 注意：此字段可能返回 null，表示取不到有效值。
ReplicaSetName	String	操作所在的分片名称
State	String	筛选条件，节点状态，可能的取值为：Primary、Secondary 注意：此字段可能返回 null，表示取不到有效值。
Operation	String	操作详细信息注意：此字段可能返回 null，表示取不到有效值。
NodeName	String	操作所在的节点名称
MicrosecsRunning	Integer	操作已执行时间（ms）注意：此字段可能返回 null，表示取不到有效值。

DBInstanceInfo

实例信息

被如下接口引用：DescribeDBInstances。

名称	类型	描述
InstanceId	String	实例ID
Region	String	地域信息

DBInstancePrice

数据库实例价格

被如下接口引用：InquirePriceCreateDBInstances, InquirePriceModifyDBInstanceSpec, InquirePriceRenewDBInstances。

名称	类型	必选	描述
UnitPrice	Float	是	单价注意：此字段可能返回 null，表示取不到有效值。
OriginalPrice	Float	是	原价
DiscountPrice	Float	是	折扣价

FBKeyValue

按key回档，用于筛选数据的键值对

被如下接口引用：FlashBackDBInstance。

名称	类型	必选	描述
Key	String	否	用于按key回档过滤的key
Value	String	否	用于按key回档过滤的value

FlashbackCollection

按key回档，源数据所在的表

被如下接口引用：FlashBackDBInstance。

名称	类型	必选	描述
CollectionName	String	是	按key回档指定的集合名
TargetResultCollectionName	String	是	按key回档到的目标集合名
FilterKey	String	是	上传到cos的文件的value所对应的key值
KeyValues	Array of FBKeyValue	否	用于按key回档过滤的键值对

FlashbackDatabase

按key回档，源数据所在的库表

被如下接口引用：FlashBackDBInstance。

名称	类型	必选	描述
DBName	String	是	按key回档源数据所在库
Collections	Array of FlashbackCollection	是	按key回档的集群数组

InstanceChargePrepaid

描述了实例的计费模式

被如下接口引用：InquirePriceRenewDBInstances, RenewDBInstances。

名称	类型	必选	描述
Period	Integer	否	购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。（InquirePriceRenewDBInstances，RenewDBInstances调用时必填）
RenewFlag	String	否	自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。（InquirePriceRenewDBInstances，RenewDBInstances调用时必填）

InstanceDetail

实例详情

被如下接口引用：DescribeDBInstances。

名称	类型	描述
InstanceId	String	实例ID。示例值：cmgo-7pjedvz7
InstanceName	String	实例名称。示例值：test-instance
PayMode	Integer	付费类型，可能的返回值：1-包年包月；0-按量计费示例值：1
ProjectId	Integer	项目ID。
ClusterType	Integer	集群类型，可能的返回值：0-副本集实例，1-分片实例。示例值：1
Region	String	地域信息。
Zone	String	可用区信息。
NetType	Integer	网络类型，可能的返回值：0-基础网络，1-私有网络示例值：1
VpcId	String	私有网络的ID。示例值：vpc-0vjmgwtn
SubnetId	String	私有网络的子网ID。示例值：subnet-emtfpj2o
Status	Integer	实例状态，可能的返回值：0-待初始化，1-流程处理中，2-运行中，-2-实例已过期。示例值：2
Vip	String	实例IP。示例值：10.100.0.0
Vport	Integer	端口号。示例值：27017
CreateTime	Timestamp	实例创建时间。示例值：2010-07-25 18:00:00
DeadLine	Timestamp	实例到期时间。示例值：2010-07-25 20:00:00
MongoVersion	String	实例版本信息。示例值：MONGO_42_WT
Memory	Integer	实例内存规格，单位为MB。示例值：4
Volume	Integer	实例磁盘规格，单位为MB。示例值：120
CpuNum	Integer	实例CPU核心数。示例值：2
MachineType	String	实例机器类型。示例值：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	协议信息，可能的返回值：1-mongodb，2-dynamodb。示例值：0
InstanceType	Integer	实例类型，可能的返回值，1-正式实例，2-临时实例，3-只读实例，4-灾备实例示例值：1
InstanceStatusDesc	String	实例状态描述示例值：运行中
RealInstanceId	String	实例对应的物理实例id，回档并替换过的实例有不同的InstanceId和RealInstanceId，从barad获取监控数据等场景下需要用物理id获取示例值：cmgo-8go1o9xl
ZoneList	Array of String	实例当前可用区信息。注意：此字段可能返回 null，表示取不到有效值。
MongosNodeNum	Integer	mongos节点个数。注意：此字段可能返回 null，表示取不到有效值。示例值：3
MongosMemory	Integer	mongos节点内存。注意：此字段可能返回 null，表示取不到有效值。示例值：2
MongosCpuNum	Integer	mongos节点CPU核数。注意：此字段可能返回 null，表示取不到有效值。示例值：1
ConfigServerNodeNum	Integer	Config Server节点个数。注意：此字段可能返回 null，表示取不到有效值。示例值：3
ConfigServerMemory	Integer	Config Server节点内存。注意：此字段可能返回 null，表示取不到有效值。示例值：2
ConfigServerVolume	Integer	Config Server节点磁盘大小。注意：此字段可能返回 null，表示取不到有效值。示例值：20
ConfigServerCpuNum	Integer	Config Server节点CPU核数。注意：此字段可能返回 null，表示取不到有效值。示例值：1
ReadonlyNodeNum	Integer	readonly节点个数。注意：此字段可能返回 null，表示取不到有效值。示例值：3

InstanceEnumParam

实例可修改参数枚举类型集合。

被如下接口引用：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 类型集合。

被如下接口引用：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	冗余字段，可忽略。示例值：""

InstanceMultiParam

实例可修改参数Multi类型集合。

被如下接口引用：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 类型的参数集合。

被如下接口引用：DescribeInstanceParams。

名称	类型	描述
CurrentValue	String	参数当前值。示例值：""
DefaultValue	String	参数默认值。示例值：""
NeedRestart	String	修改参数值之后是否需要重启。示例值：""
ParamName	String	参数名称。示例值：""
TextValue	String	Text 类型参数对应的值。示例值：""
Tips	Array of String	参数说明。示例值：""
ValueType	String	参数值类型说明。示例值：""
Status	String	是否为运行中的参数值。 - 1：运行中参数值。 - 0：非运行中参数值。示例值：""

ModifyNetworkAddress

修改数据库地址

被如下接口引用：ModifyDBInstanceNetworkAddress。

名称	类型	必选	描述
NewIPAddress	String	是	新IP地址。
OldIpAddress	String	是	原IP地址。

NodeProperty

节点属性

被如下接口引用：DescribeDBInstanceNodeProperty。

名称	类型	描述
Zone	String	节点所在的可用区。注意：此字段可能返回 null，表示取不到有效值。示例值：ap-guangzhou-1
NodeName	String	节点名称。注意：此字段可能返回 null，表示取不到有效值。示例值：cmgo-ocdv2lr7_0-node-primary
Address	String	节点访问地址。注意：此字段可能返回 null，表示取不到有效值。示例值：10.4.0.7:30000
Role	String	角色。注意：此字段可能返回 null，表示取不到有效值。示例值：PRIMARY
Hidden	Boolean	是否为Hidden节点注意：此字段可能返回 null，表示取不到有效值。示例值：false
Status	String	节点状态，包括：ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。注意：此字段可能返回 null，表示取不到有效值。示例值：NORMAL
SlaveDelay	Integer	主从延迟，单位秒。注意：此字段可能返回 null，表示取不到有效值。示例值：1
Priority	Integer	节点优先级。注意：此字段可能返回 null，表示取不到有效值。示例值：10
Votes	Integer	节点投票权。注意：此字段可能返回 null，表示取不到有效值。示例值：1
Tags	Array of NodeTag	节点标签。注意：此字段可能返回 null，表示取不到有效值。示例值：[{"TagKey":"role-cmgo","TagValue":"primary-secondary-group"}]
ReplicateSetId	String	副本集Id。注意：此字段可能返回 null，表示取不到有效值。示例值：cmgo-ocdv2lr7_0

NodeTag

节点Tag

被如下接口引用：DescribeDBInstanceNodeProperty。

名称	类型	必选	描述
TagKey	String	否	节点Tag key 注意：此字段可能返回 null，表示取不到有效值。示例值：testKey
TagValue	String	否	节点Tag Value 注意：此字段可能返回 null，表示取不到有效值。示例值：testValue

Operation

需要终止的操作

被如下接口引用：KillOps。

名称	类型	必选	描述
ReplicaSetName	String	是	操作所在的分片名
NodeName	String	是	操作所在的节点名
OpId	Integer	是	操作序号

RemoveNodeList

修改实例节点详情

被如下接口引用：ModifyDBInstanceSpec。

名称	类型	必选	描述
Role	String	是	需要删除的节点角色。 - SECONDARY：Mongod 节点。 - READONLY：只读节点。 - MONGOS：Mongos 节点。示例值：SECONDARY
NodeName	String	是	要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可，其余分片对改组对齐。 - 获取方式：登录 MongoDB控制台，在节点管理页签，可获取节点 ID。 - 特别说明：分片集群同一节点上的分片，仅需指定0分片节点 ID 即可。例如：cmgo-6hfk****0-node-primary。示例值：cmgo-3iecwbfx0-node-readonly0
Zone	String	是	节点所对应的可用区。 - 单可用区，所有节点在同一可用区。 - 多可用区：当前标准规格是三可用区分布，主从节点不在同一可用区，需注意配置所删除节点对应的可用区，且删除后必须满足任意2个可用区节点数大于第3个可用区原则。示例值：ap-guangzhou-2

ReplicaSetInfo

分片信息

被如下接口引用：CreateBackupDownloadTask。

名称	类型	必选	描述
ReplicaSetId	String	是	副本集ID 示例值：cmgo_ih8uido9_0

ReplicateSetInfo

副本集信息

被如下接口引用：DescribeDBInstanceNodeProperty。

名称	类型	描述
Nodes	Array of NodeProperty	节点属性注意：此字段可能返回 null，表示取不到有效值。

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-lxdvbitn
SecurityGroupName	String	安全组名称示例值：全放通
SecurityGroupRemark	String	安全组备注示例值：暴露全部端口到公网和内网，有一定安全风险

SecurityGroupBound

安全组规则

被如下接口引用：DescribeSecurityGroup。

名称	类型	描述
Action	String	执行规则。ACCEPT或DROP 示例值：ACCEPT
CidrIp	String	ip段。示例值：0.0.0.0/0
PortRange	String	端口范围示例值：80,443
IpProtocol	String	传输层协议。tcp，udp或ALL 示例值：tcp
Id	String	安全组id代表的地址集合
AddressModule	String	地址组id代表的地址集合
ServiceModule	String	服务组id代表的协议和端口集合
Desc	String	描述

ShardInfo

实例分片详情

被如下接口引用：DescribeDBInstances。

名称	类型	描述
UsedVolume	Float	分片已使用容量
ReplicaSetId	String	分片ID
ReplicaSetName	String	分片名
Memory	Integer	分片内存规格，单位为MB
Volume	Integer	分片磁盘规格，单位为MB
OplogSize	Integer	分片Oplog大小，单位为MB
SecondaryNum	Integer	分片从节点数
RealReplicaSetId	String	分片物理id

SlowLogPattern

用于描述MongoDB数据库慢日志统计信息

被如下接口引用：DescribeSlowLogPatterns。

名称	类型	描述
Pattern	String	慢日志模式
MaxTime	Integer	最大执行时间
AverageTime	Integer	平均执行时间
Total	Integer	该模式慢日志条数

SpecItem

mongodb售卖规格

被如下接口引用：DescribeSpecInfo。

名称	类型	描述
SpecCode	String	规格信息标识示例值：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	可承载qps信息示例值：36000
Conns	Integer	连接数限制示例值：20000
MongoVersionCode	String	实例mongodb版本信息示例值：MONGO_36_WT
MongoVersionValue	Integer	实例mongodb版本号示例值：4
Version	String	实例mongodb版本号（短）示例值：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	机器类型，取值：0-HIO，4-HIO10G 示例值：4-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	是	标签键
TagValue	String	是	标签值

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测试账号