You need to enable JavaScript to run this app.
导航

数据结构

最近更新时间2024.01.03 22:09:51

首次发布时间2022.04.12 11:06:54

本文汇总文档数据库 MongoDB 版的 API 接口中使用的数据结构定义详情。

AccountObject

名称类型示例值描述
AccountNameStringroot账号名称。
AccountPrivilegesArray of AccountPrivilegeObject请参见返回示例当前账号的数据库和权限列表。关于 AccountPrivileges 的详细说明,请参见数据结构
AccountTypeStringSuper账号类型,当前仅支持返回 Super(即超级管理员)类型的账号信息。

AccountPrivilegeObject

名称类型示例值描述
DBNameStringadmin当前账号所属的数据库。
RoleNameStringroot当前账号的角色。

AllowListObject

名称类型示例值描述
AllowListDescStringtest白名单的备注。
AllowListIdStringacl-d1fd76693bd54e658912e7337d5b****白名单 ID。
AllowListNameStringtest白名单名称。
AllowListIPNumInteger2白名单内的 IP 地址(或地址段)总数。
AllowListTypeStringIPv4白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AssociatedInstanceNumInteger1白名单下绑定的实例总数。

AssociatedInstanceObject

名称类型示例值描述
InstanceIdStringmongo-replica-e405f8e2****已绑定当前白名单的实例 ID。
InstanceNameStringtest已绑定当前白名单的实例名称。
VPCStringvpc-2743n1ihbxla87fap8tap****实例所属的私有网络 ID。

ConfigServerObject

名称类型示例值描述
ConfigServerNodeIdStringmongo-shard-011d2479****-config-0ConfigServer的节点ID。

NodeRole

String

Primary

节点角色,取值范围如下:
Primary:主节点。
Secondary:从节点。
Hidden:隐藏节点。

NodeStatusStringRunning节点状态。
TotalMemoryGBFloat2总内存。单位:GiB。
TotalvCPUFloat1总核数。
UsedMemoryGBFloat0.33296966552734375已用内存。单位:GiB。
UsedvCPUFloat0.004654006已用核数。

ZoneId

String

cn-beijing-a

当前节点所属的可用区 ID。

说明

若您的实例部署了多可用区,则不同角色节点的所在的可用区不一样。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案

ConfigServerNodeSpecObject

名称类型示例值描述
CpuNumDouble1CPU 核数。
MemInGbDouble2内存,单位:GiB。
SpecNameStringmongo.config.1c2g规格码。
MaxConnInteger1000最大连接数。
MaxStorageInteger2000本地盘可选存储空间的最大值。单位:GiB。
MinStorageInteger20本地盘可选存储空间的最小值。单位:GiB。

DBAddressObject

名称类型示例值描述
AddressDomainStringmongoreplicae405f8e2c****.mongodb.ivolces.com连接地址的域名。

AddressIP

String

100.64.***.***

连接地址所对应的 IP。

说明

不建议使用 IP:port 的方式来连接实例,因为切换子网后 IP 地址会改变,客户端代码如果没有及时更新则会出现实例连接失败的问题。建议您使用 域名:port 的方式来访问 MongoDB 实例,避免出现因 IP 地址改变导致实例无法连接的问题。连接 MongoDB 实例的具体步骤,请参见通过 Mongo Shell 工具连接实例

AddressPortString3717连接地址的端口号。

AddressType

String

Primary

节点的连接地址类型,取值范围如下:

  • Primary:主节点连接地址。
  • Secondary:从节点连接地址。
  • Hidden:隐藏节点连接地址。

说明

仅当连接地址类型为私网连接地址(即 NetworkType 取值为 Private)时,会返回隐藏节点的连接地址信息。

EipId

String

eip-2fef2qcfbfw8w5oxruw3w****

实例公网地址所绑定的 EIP ID。

说明

仅当连接地址类型为公网连接地址(即 NetworkType 取值为 Public)时,返回该参数。

NodeIdStringmongo-shard-9a554522****-1连接地址所属的节点 ID。

DBEndpointObject

名称类型示例值描述
DBAddressesArray of DBAddressObject请参见返回示例连接地址串信息列表。关于 DBAddresses 的详细信息,请参见数据结构
EndpointIdStringAk5BUhxJAkgSVR****连接地址 ID。
EndpointStrStringmongodb://<user>:<password>@mongoreplicae405f8e2c****.mongodb.ivolces.com:3717,mongoreplicae405f8e2c****.mongodb.ivolces.com:3717/?authSource=admin&replicaSet=rs-mongo-replica-e405f8e2****&retryWrites=true连接地址的字符串信息。

EndpointType

String

RelicaSet

连接地址所对应的节点类型。取值范围如下:

  • 副本集实例仅支持 ReplicaSet(即副本集)连接地址类型。
  • 分片集群实例支持 Mongos(即 Mongos 节点)、ConfigServer(即 ConfigServer 节点)和 Shard(即 Shard 节点)三种连接地址类型。

NetworkType

String

Private

连接地址的网络类型,取值范围如下:

  • Private:私网连接地址。
  • Public:公网连接地址。

ObjectId

String

mongo-shard-cd807041****

当前连接地址所属组件的 ID。

说明

仅当 EndpointType 取值为 MongosConfigServerShard 时,会返回该参数。

SubnetIdStringsubnet-3rfc6bfv8lssg5zsk2h7z****当前实例所属的子网 ID。
VpcIdStringvpc-3tjjjskc6p4d2et2****当前实例所属的私有网络 ID。

DBInstanceObject

名称类型示例值描述

AutoRenew

Bool

false

包年包月实例是否开启自动续费。取值范围如下:

  • false:未开启。
  • true:已开启。

说明

仅包年包月实例支持返回该参数。

ChargeStatus

String

Normal

实例计费状态,取值范围如下:

  • Normal:正常。
  • WaitingPaid:等待支付。
  • ChangingPayType:计费变更中。
  • Renewing:续费中。
  • Overdue:已到期。
  • Owing:欠费中。
  • Unsubscribing:退订中

ChargeType

String

PostPaid

实例计费类型,取值范围如下:

  • Prepaid:包年包月(也称预付费)。
  • PostPaid:按量计费(也称后付费)。

ClosedTime

String

2022-03-19T04:00:00Z

计划关停时间(UTC)。

说明

仅包年包月实例支持返回该参数。

ConfigServers

Array of ConfigServerObject

请参见返回示例

ConfigServers 的信息列表。关于 ConfigServers 的详细说明,请参见数据结构

说明

仅分片集群实例支持返回该参数。

ConfigServersId

String

mongo-shard-011d2479****-config

ConfigServers 的 ID。

说明

仅分片集群实例支持返回该参数。

CreateTimeString2022-03-15T03:57:15Z实例创建时间(UTC)。
DBEngineStringMongoDB数据库引擎。取值固定为 MongoDB

DBEngineVersion

String

MongoDB_4_0

数据库引擎版本,取值范围如下:

  • MongoDB_4_0:MongoDB 4.0 版本。
  • MongoDB_5_0:MongoDB 5.0 版本。

DBEngineVersionStr

String

MongoDB 4.0

数据库引擎版本的字符串。取值范围如下:

  • MongoDB 4.0:MongoDB 4.0 版本。
  • MongoDB 5.0:MongoDB 5.0 版本。

ExpiredTime

String

22022-03-19T03:45:28Z

实例到期时间(UTC)。

说明

仅包年包月实例支持返回该参数。

InstanceIdStringmongo-replica-9b3f8fb9****实例 ID。
InstanceNameStringtest-mongo实例名称。
InstanceStatusStringRunning实例状态。

InstanceType

String

ReplicaSet

MongoDB 的实例类型,取值范围如下:

  • ReplicaSet:副本集。
  • ShardedCluster:分片集群。

Nodes

Array of NodeObject

请参见返回示例

副本集实例中各节点或分片集群 Shard 分片中各节点的信息列表。关于 Nodes 的详细说明,请参见数据结构

说明

仅副本集实例或分片集群实例的 Shard 分片中支持返回该参数。

Mongos

Array of MongosObject

请参见返回示例

Mongos 的信息列表。关于 Mongos 的详细说明,请参见数据结构

说明

仅分片集群实例支持返回该参数。

MongosId

String

mongo-shard-011d2479****

Mongos 的 ID。

说明

仅分片集群实例支持返回该参数。

ReclaimTime

String

2022-03-26T03:45:28Z

实例的计划回收时间(UTC)。

说明

仅包年包月实例支持返回该参数。

Shards

Array of ShardObject

请参见返回示例

Shards 的信息列表。关于 Shards 的详细说明,请参见数据结构

说明

仅分片集群实例支持返回该参数。

ProjectNameStringdefault实例所属的项目名称。
SubnetIdStringsubnet-2743n265pa8zk7fap8st3****实例所属的子网 ID。

Tags

Array of TagObject

[
{
"Key": "department",
"Value": "game"
},
{
"Key": "owner",
"Value": "Alice"
}
]

实例已绑定的标签信息。关于 Tags 的更多说明,请参见数据结构

说明

仅已绑定了标签的实例才会返回该参数。

UpdateTimeString2022-03-19T03:45:28Z实例的更新时间(UTC)。
VpcIdStringvpc-3tfam26vmy3v****实例所属的私有网络 ID。

ZoneId

String

cn-beijing-a

实例所属的可用区 ID。

说明

若您的实例部署了多可用区,则会同时展示所有节点所在的可用区信息,从左至右依次为主节点、从节点、隐藏节点所在的可用区。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案

StorageTypeStringLocalSSD实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
PrivateEndpointStringmongodb://:@mongoshard3d714182****0.mongodb.ivolces.com:3717,mongoshard3d714182****1.mongodb.ivolces.com:3717,mongoshard3d714182****2.mongodb.ivolces.com:3717/?authSource=admin&retryWrites=true实例私网连接地址的字符串信息。

DBInstancesObject

名称类型示例值描述

AutoRenew

Bool

false

包年包月实例是否开启自动续费。取值范围如下:

  • false:未开启。
  • true:已开启。

说明

仅包年包月实例支持返回该参数。

ChargeStatus

String

Normal

实例计费状态,取值范围如下:

  • Normal:正常。
  • WaitingPaid:等待支付。
  • ChangingPayType:计费变更中。
  • Renewing:续费中。
  • Overdue:已到期。
  • Owing:欠费中。
  • Unsubscribing:退订中

ChargeType

String

PostPaid

实例计费类型,取值范围如下:

  • Prepaid:包年包月(也称预付费)。
  • PostPaid:按量计费(也称后付费)。

ClosedTime

String

2022-03-19T04:00:00Z

计划关停时间(UTC)。

说明

仅包年包月实例支持返回该参数。

ConfigServersId

String

mongo-shard-fa8cd21d****-config

ConfigServer 的 ID。

说明

仅分片集群实例支持返回该参数。

CreateTimeString2022-03-15T03:57:15Z实例创建时间(UTC)。

DBEngineVersion

String

MongoDB_4_0

数据库引擎版本,取值范围如下:

  • MongoDB_4_0:MongoDB 4.0 版本。
  • MongoDB_5_0:MongoDB 5.0 版本。

DBEngineVersionStr

String

MongoDB 4.0

数据库引擎版本的字符串。取值范围如下:

  • MongoDB 4.0:MongoDB 4.0 版本。
  • MongoDB 5.0:MongoDB 5.0 版本。

ExpiredTime

String

22022-03-19T03:45:28Z

实例到期时间(UTC)。

说明

仅包年包月实例支持返回该参数。

InstanceIdStringmongo-replica-9b3f8fb9****实例 ID。
InstanceNameStringtest-mongo实例名称。
InstanceStatusStringRunning实例状态。

InstanceType

String

ReplicaSet

MongoDB 的实例类型,取值范围如下:

  • ReplicaSet:副本集。
  • ShardedCluster:分片集群。
ProjectNameStringdefault实例所属的项目名称。

MongosId

String

mongo-shard-011d2479****

Mongos 的 ID。

说明

仅分片集群实例支持返回该参数。

ReclaimTime

String

2022-03-26T03:45:28Z

实例的计划回收时间(UTC)。

说明

仅包年包月实例支持返回该参数。

SubnetIdStringsubnet-2743n265pa8zk7fap8st3****实例所属的子网ID。

Tags

Array of TagObject

[
{
"Key": "department",
"Value": "game"
},
{
"Key": "owner",
"Value": "Alice"
}
]

实例已绑定的标签信息。关于 Tags 的更多说明,请参见数据结构

说明

仅已绑定了标签的实例才会返回该参数。

UpdateTimeString2022-03-19T03:45:28Z实例的更新时间(UTC)。
VpcIdStringvpc-3tfam26vmy3v****实例所属的私有网络 ID。

ZoneId

String

cn-beijing-a

实例所属的可用区 ID。

说明

若您的实例部署了多可用区,则会同时展示所有节点所在的可用区信息,从左至右依次为主节点、从节点、隐藏节点所在的可用区。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案

StorageTypeStringLocalSSD实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
PrivateEndpointStringmongodb://:@mongoshard3d714182****0.mongodb.ivolces.com:3717,mongoshard3d714182****1.mongodb.ivolces.com:3717,mongoshard3d714182****2.mongodb.ivolces.com:3717/?authSource=admin&retryWrites=true实例私网连接地址的字符串信息。

InstanceParameterObject

名称类型示例值描述
CheckingCodeString200 - 2000参数的取值范围。

ForceModify

Boolean

true

目标参数是否支持修改参数值。取值范围如下:

  • true:支持修改。
  • false:不支持修改分片集群。

ForceRestart

Boolean

true

修改后,新的参数值是否需要重启实例才生效。取值范围如下:

  • true:需要重启。
  • false:不需要重启。
ParameterDefaultValueString600目标参数的默认值。
ParameterDescriptionString表示当前实例与其他 mongod 实例通信的连接池的最大连接数参数描述。
ParameterNamesStringconnPoolMaxConnsPerHost参数名。

ParameterRole

String

Node

参数所属的节点类型。取值范围如下:

  • Node:副本集实例节点。
  • Shard:分片集群实例中的 Shard 节点。
  • ConfigServer:分片集群实例中的 ConfigServer 节点。
  • Mongos:分片集群实例中的 Mongos 节点。

ParameterType

String

Integer

参数值的类型,取值范围如下:

  • Integer:整数类型。
  • String:字符串类型。
  • Boolean:布尔类型。
ParameterValueString1目标参数的当前取值。

MongosObject

名称类型示例值描述
MongosNodeIdStringmongo-shard-011d2479****-0Mongos 的节点 ID。
NodeSpecStringmongo.mongos.1c2g节点规格。
NodeStatusStringRunning节点状态。
TotalMemoryGBFloat2总内存。单位:GiB。
TotalvCPUFloat1总核数。
UsedMemoryGBFloat0.09878921508789062已用内存。单位:GiB。
UsedvCPUFloat0.002623241已用核数。

ZoneId

String

cn-beijing-a

当前节点所属的可用区 ID。

说明

若您的实例部署了多可用区,则不同角色节点的所在的可用区不一样。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案

MongosNodeSpecObject

名称类型示例值描述
CpuNumDouble1CPU 核数。
MaxConnInt641000最大连接数。
MemInGbDouble2内存,单位:GiB。
SpecNameStringmongo.mongos.1c2g规格码。

NodeObject

名称类型示例值描述
NodeDelayTimeInteger0主从延迟时间。单位:毫秒(ms)。

NodeId
NodeRole

String
String

mongo-shard-011d2479****-s1-0
Primary

节点 ID。
节点角色,取值范围如下:

  • Primary:主节点。
  • Secondary:从节点。
  • Hidden:隐藏节点。
NodeSpecStringmongo.shard.1c2g节点规格。
NodeStatusStringRunning节点状态。
TotalMemoryGBFloat2总内存。单位:GiB。
TotalStorageGBFloat20该节点的总存储空间。单位:GiB。
TotalvCPUFloat1总核数。
UsedMemoryGBFloat0.4655952453613281已用内存。单位:GiB。
UsedStorageGBFloat0.9955019280314445该节点已用的存储空间。单位:GiB。
UsedvCPUFloat0.003100326已用核数。

ZoneId

String

cn-beijing-a

当前节点所属的可用区 ID。

说明

若您的实例部署了多可用区,则不同角色节点的所在的可用区不一样。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案

NodeSpecObject

名称类型示例值描述
CpuNumDouble1CPU 核数。
MaxConnInteger1000最大连接数。
MaxStorageInteger2000本地盘可选存储空间的最大值。单位:GiB。
MinStorageInteger20本地盘可选存储空间的最小值。单位:GiB。
MemInGbDouble2内存,单位:GiB。
SpecNameStringmongo.1c2g规格码。

ParameterChangeLog

名称类型示例值描述
ModifyTimeString2022-07-18 21:05:08目标参数被修改的时间点(UTC时间)。
NewParameterValueString600001修改后的参数值。
OldParameterValueString600000修改前的参数值。
ParameterNameStringcursorTimeoutMillis目标参数的名称。

ParameterRole

String

Node

目标参数所属的节点类型,取值范围如下:

  • Node:副本集实例节点。
  • Shard:分片集群实例中的 Shard 节点。
  • ConfigServer:分片集群实例中的 ConfigServer 节点。
  • Mongos:分片集群实例中的 Mongos 节点。

ParameterStatus

String

Applied

新参数值是否生效。取值范围如下:

  • Applied:已生效。
  • Invalid:未生效。

ParameterObject

名称类型是否必选示例值描述

ParameterName

String

cursorTimeoutMillis

目标参数的名称。

说明

您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情,包括参数名称。

ParameterRole

String

Node

目标参数所属的节点类型,取值范围如下:

  • Node:副本集实例节点。
  • Shard:分片集群实例中的 Shard 节点。
  • ConfigServer:分片集群实例中的 ConfigServer 节点。
  • Mongos:分片集群实例中的 Mongos 节点。

说明

您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情,包括参数所属的节点类型。

ParameterValue

String

600001

目标参数的取值。

说明

您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情,包括目标参数的取值范围(即 CheckingCode 的值)。

RegionObject

名称类型示例值描述
RegionIdStringcn-beijing地域 ID。
RegionNameString华北2(北京)地域名称。

ShardObject

名称类型示例值描述
NodesArray of NodesObject请参见返回示例Shard 分片中各节点的信息列表。关于 Nodes 的详细说明,请参见数据结构

ShardId

String

mongo-shard-011d2479****-s0

Shard 节点的 ID。

说明

仅分片集群实例支持返回该参数。

ShardNodeSpecObject

名称类型示例值描述
CpuNumDouble1CPU 核数。
MaxConnInteger1000最大连接数。
MaxStorageInteger2000本地盘可选存储空间的最大值。单位:GiB。
MinStorageInteger20本地盘可选存储空间的最小值。单位:GiB。
MemInGbDouble2内存,单位:GiB。
SpecNameStringmongo.shard.1c2g规格码。

TagFilterObject

名称类型是否必选示例值描述

Key

String

instancetype

用于查询筛选的标签键。

说明

  • 如需使用标签对实例进行查询筛选,该参数必填。
  • 允许传入重复的标签键。
  • 单次最多支持同时传入 10 个标签进行查询筛选。

Value

String

replica

用于查询筛选的标签键所对应的标签值。

说明

  • 若该参数留空,表示不对标签值作限制,会筛选所有绑定了指定标签键的实例。
  • 若传入空字符串,表示筛选对应标签键下,标签值为空的实例。

TagObject

名称类型是否必选示例值描述

Key

String

instancetype

Key 参数在不同 API 接口中作用不同,其中:

  • CreateDBInstance 请求参数中表示需要绑定标签所对应的标签键。

    说明

    • 该参数留空表示新建实例不绑定任何标签。当需要为实例绑定标签时,标签键(Key)必填,标签值(Value)可不填,不填标签值表示对应标签键的标签值为空。
    • 支持一次传入多组标签键值对象,多组标签键值对象间用英文逗号(,)分隔。最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签键需满足设置规则,具体规则请参见标签设置规则
  • DescribeDBInstancesDescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签键。

Value

String

replica

Value 参数在不同 API 接口中作用不同,其中:

  • CreateDBInstance 请求参数中表示需要绑定标签所对应的标签值。

    说明

    • 当需要为实例绑定标签时,标签键(Key)必填,标签值(Value)可不填,不填标签值表示对应标签键的标签值为空。支持一次传入多组标签键值对象,多组标签键值对象间用英文逗号(,)分隔。
    • 最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签键需满足设置规则,具体规则请参见标签设置规则
  • DescribeDBInstancesDescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签值。

ZoneObject

名称类型示例值描述
ZoneIdStringcn-beijing-a可用区 ID。
ZoneNameString华北 2(北京)- 可用区 A可用区名称。