最近更新时间:2024.04.08 17:41:47
首次发布时间:2022.04.12 11:06:54
本文汇总文档数据库 MongoDB 版的 API 接口中使用的数据结构定义详情。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AccountName | String | root | 账号名称。 |
AccountPrivileges | Array of AccountPrivilegeObject | 请参见返回示例。 | 当前账号的数据库和权限列表。关于 AccountPrivileges 的详细说明,请参见数据结构。 |
AccountType | String | Super | 账号类型,当前仅支持返回 Super (即超级管理员)类型的账号信息。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBName | String | admin | 当前账号所属的数据库。 |
RoleName | String | root | 当前账号的角色。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AllowListDesc | String | test | 白名单的备注。 |
AllowListId | String | acl-d1fd76693bd54e658912e7337d5b**** | 白名单 ID。 |
AllowListName | String | test | 白名单名称。 |
AllowListIPNum | Integer | 2 | 白名单内的 IP 地址(或地址段)总数。 |
AllowListType | String | IPv4 | 白名单内的 IP 地址类型。当前仅支持 IPv4 地址。 |
AssociatedInstanceNum | Integer | 1 | 白名单下绑定的实例总数。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceId | String | mongo-replica-e405f8e2**** | 已绑定当前白名单的实例 ID。 |
InstanceName | String | test | 已绑定当前白名单的实例名称。 |
VPC | String | vpc-2743n1ihbxla87fap8tap**** | 实例所属的私有网络 ID。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ConfigServerNodeId | String | mongo-shard-011d2479****-config-0 | ConfigServer的节点ID。 |
NodeRole | String | Primary | 节点角色,取值范围如下: |
NodeStatus | String | Running | 节点状态。 |
TotalMemoryGB | Float | 2 | 总内存。单位:GiB。 |
TotalvCPU | Float | 1 | 总核数。 |
UsedMemoryGB | Float | 0.33296966552734375 | 已用内存。单位:GiB。 |
UsedvCPU | Float | 0.004654006 | 已用核数。 |
ZoneId | String | cn-beijing-a | 当前节点所属的可用区 ID。 说明 若您的实例部署了多可用区,则不同角色节点的所在的可用区不一样。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CpuNum | Double | 1 | CPU 核数。 |
MemInGb | Double | 2 | 内存,单位:GiB。 |
SpecName | String | mongo.config.1c2g | 规格码。 |
MaxConn | Integer | 1000 | 最大连接数。 |
MaxStorage | Integer | 2000 | 本地盘可选存储空间的最大值。单位:GiB。 |
MinStorage | Integer | 20 | 本地盘可选存储空间的最小值。单位:GiB。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AddressDomain | String | mongoreplicae405f8e2c****.mongodb.ivolces.com | 连接地址的域名。 |
AddressIP | String | 100.64.***.*** | 连接地址所对应的 IP。 说明 不建议使用 |
AddressPort | String | 3717 | 连接地址的端口号。 |
AddressType | String | Primary | 节点的连接地址类型,取值范围如下:
说明 仅当连接地址类型为私网连接地址(即 |
EipId | String | eip-2fef2qcfbfw8w5oxruw3w**** | 实例公网地址所绑定的 EIP ID。 说明 仅当连接地址类型为公网连接地址(即 |
NodeId | String | mongo-shard-9a554522****-1 | 连接地址所属的节点 ID。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBAddresses | Array of DBAddressObject | 请参见返回示例。 | 连接地址串信息列表。关于 DBAddresses 的详细信息,请参见数据结构。 |
EndpointId | String | Ak5BUhxJAkgSVR**** | 连接地址 ID。 |
EndpointStr | String | mongodb://<user>:<password>@mongoreplicae405f8e2c****.mongodb.ivolces.com:3717,mongoreplicae405f8e2c****.mongodb.ivolces.com:3717/?authSource=admin&replicaSet=rs-mongo-replica-e405f8e2****&retryWrites=true | 连接地址的字符串信息。 |
EndpointType | String | RelicaSet | 连接地址所对应的节点类型。取值范围如下:
|
NetworkType | String | Private | 连接地址的网络类型,取值范围如下:
|
ObjectId | String | mongo-shard-cd807041**** | 当前连接地址所属组件的 ID。 说明 仅当 |
SubnetId | String | subnet-3rfc6bfv8lssg5zsk2h7z**** | 当前实例所属的子网 ID。 |
VpcId | String | vpc-3tjjjskc6p4d2et2**** | 当前实例所属的私有网络 ID。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AutoRenew | Bool | false | 包年包月实例是否开启自动续费。取值范围如下:
说明 仅包年包月实例支持返回该参数。 |
ChargeStatus | String | Normal | 实例计费状态,取值范围如下:
|
ChargeType | String | PostPaid | 实例计费类型,取值范围如下:
|
ClosedTime | String | 2022-03-19T04:00:00Z | 计划关停时间(UTC)。 说明 仅包年包月实例支持返回该参数。 |
ConfigServers | Array of ConfigServerObject | 请参见返回示例。 | ConfigServers 的信息列表。关于 说明 仅分片集群实例支持返回该参数。 |
ConfigServersId | String | mongo-shard-011d2479****-config | ConfigServers 的 ID。 说明 仅分片集群实例支持返回该参数。 |
CreateTime | String | 2022-03-15T03:57:15Z | 实例创建时间(UTC)。 |
DBEngine | String | MongoDB | 数据库引擎。取值固定为 MongoDB 。 |
DBEngineVersion | String | MongoDB_4_0 | 数据库引擎版本,取值范围如下:
|
DBEngineVersionStr | String | MongoDB 4.0 | 数据库引擎版本的字符串。取值范围如下:
|
ExpiredTime | String | 22022-03-19T03:45:28Z | 实例到期时间(UTC)。 说明 仅包年包月实例支持返回该参数。 |
InstanceId | String | mongo-replica-9b3f8fb9**** | 实例 ID。 |
InstanceName | String | test-mongo | 实例名称。 |
InstanceStatus | String | Running | 实例状态。关于实例状态的更多详情,请参见实例状态说明。 |
InstanceType | String | ReplicaSet | MongoDB 的实例类型,取值范围如下:
|
Nodes | Array of NodeObject | 请参见返回示例。 | 副本集实例中各节点或分片集群 Shard 分片中各节点的信息列表。关于 说明 仅副本集实例或分片集群实例的 Shard 分片中支持返回该参数。 |
Mongos | Array of MongosObject | 请参见返回示例。 | Mongos 的信息列表。关于 说明 仅分片集群实例支持返回该参数。 |
MongosId | String | mongo-shard-011d2479**** | Mongos 的 ID。 说明 仅分片集群实例支持返回该参数。 |
ReclaimTime | String | 2022-03-26T03:45:28Z | 实例的计划回收时间(UTC)。 说明 仅包年包月实例支持返回该参数。 |
Shards | Array of ShardObject | 请参见返回示例。 | Shards 的信息列表。关于 说明 仅分片集群实例支持返回该参数。 |
ProjectName | String | default | 实例所属的项目名称。 |
SubnetId | String | subnet-2743n265pa8zk7fap8st3**** | 实例所属的子网 ID。 |
Tags | Array of TagObject | [ | 实例已绑定的标签信息。关于 Tags 的更多说明,请参见数据结构。 说明 仅已绑定了标签的实例才会返回该参数。 |
UpdateTime | String | 2022-03-19T03:45:28Z | 实例的更新时间(UTC)。 |
VpcId | String | vpc-3tfam26vmy3v**** | 实例所属的私有网络 ID。 |
ZoneId | String | cn-beijing-a | 实例所属的可用区 ID。 说明 若您的实例部署了多可用区,则会同时展示所有节点所在的可用区信息,从左至右依次为主节点、从节点、隐藏节点所在的可用区。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案。 |
StorageType | String | LocalSSD | 实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD )存储。 |
PrivateEndpoint | String | mongodb:// | 实例私网连接地址的字符串信息。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AutoRenew | Bool | false | 包年包月实例是否开启自动续费。取值范围如下:
说明 仅包年包月实例支持返回该参数。 |
ChargeStatus | String | Normal | 实例计费状态,取值范围如下:
|
ChargeType | String | PostPaid | 实例计费类型,取值范围如下:
|
ClosedTime | String | 2022-03-19T04:00:00Z | 计划关停时间(UTC)。 说明 仅包年包月实例支持返回该参数。 |
ConfigServersId | String | mongo-shard-fa8cd21d****-config | ConfigServer 的 ID。 说明 仅分片集群实例支持返回该参数。 |
CreateTime | String | 2022-03-15T03:57:15Z | 实例创建时间(UTC)。 |
DBEngineVersion | String | MongoDB_4_0 | 数据库引擎版本,取值范围如下:
|
DBEngineVersionStr | String | MongoDB 4.0 | 数据库引擎版本的字符串。取值范围如下:
|
ExpiredTime | String | 22022-03-19T03:45:28Z | 实例到期时间(UTC)。 说明 仅包年包月实例支持返回该参数。 |
InstanceId | String | mongo-replica-9b3f8fb9**** | 实例 ID。 |
InstanceName | String | test-mongo | 实例名称。 |
InstanceStatus | String | Running | 实例状态。关于实例状态的更多详情,请参见实例状态说明。 |
InstanceType | String | ReplicaSet | MongoDB 的实例类型,取值范围如下:
|
ProjectName | String | default | 实例所属的项目名称。 |
MongosId | String | mongo-shard-011d2479**** | Mongos 的 ID。 说明 仅分片集群实例支持返回该参数。 |
ReclaimTime | String | 2022-03-26T03:45:28Z | 实例的计划回收时间(UTC)。 说明 仅包年包月实例支持返回该参数。 |
SubnetId | String | subnet-2743n265pa8zk7fap8st3**** | 实例所属的子网 ID。 |
Tags | Array of TagObject | [ | 实例已绑定的标签信息。关于 Tags 的更多说明,请参见数据结构。 说明 仅已绑定了标签的实例才会返回该参数。 |
UpdateTime | String | 2022-03-19T03:45:28Z | 实例的更新时间(UTC)。 |
VpcId | String | vpc-3tfam26vmy3v**** | 实例所属的私有网络 ID。 |
ZoneId | String | cn-beijing-a | 实例所属的可用区 ID。 说明 若您的实例部署了多可用区,则会同时展示所有节点所在的可用区信息,从左至右依次为主节点、从节点、隐藏节点所在的可用区。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案。 |
StorageType | String | LocalSSD | 实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD )存储。 |
PrivateEndpoint | String | mongodb:// | 实例私网连接地址的字符串信息。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CheckingCode | String | 200 - 2000 | 参数的取值范围。 |
ForceModify | Boolean | true | 目标参数是否支持修改参数值。取值范围如下:
|
ForceRestart | Boolean | true | 修改后,新的参数值是否需要重启实例才生效。取值范围如下:
|
ParameterDefaultValue | String | 600 | 目标参数的默认值。 |
ParameterDescription | String | 表示当前实例与其他 mongod 实例通信的连接池的最大连接数 | 参数描述。 |
ParameterNames | String | connPoolMaxConnsPerHost | 参数名。 |
ParameterRole | String | Node | 参数所属的节点类型。取值范围如下:
|
ParameterType | String | Integer | 参数值的类型,取值范围如下:
|
ParameterValue | String | 1 | 目标参数的当前取值。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
MongosNodeId | String | mongo-shard-011d2479****-0 | Mongos 的节点 ID。 |
NodeSpec | String | mongo.mongos.1c2g | 节点规格。 |
NodeStatus | String | Running | 节点状态。 |
TotalMemoryGB | Float | 2 | 总内存。单位:GiB。 |
TotalvCPU | Float | 1 | 总核数。 |
UsedMemoryGB | Float | 0.09878921508789062 | 已用内存。单位:GiB。 |
UsedvCPU | Float | 0.002623241 | 已用核数。 |
ZoneId | String | cn-beijing-a | 当前节点所属的可用区 ID。 说明 若您的实例部署了多可用区,则不同角色节点的所在的可用区不一样。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CpuNum | Double | 1 | CPU 核数。 |
MaxConn | Int64 | 1000 | 最大连接数。 |
MemInGb | Double | 2 | 内存,单位:GiB。 |
SpecName | String | mongo.mongos.1c2g | 规格码。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NodeDelayTime | Integer | 0 | 主从延迟时间。单位:毫秒(ms)。 |
NodeId | String | mongo-shard-011d2479****-s1-0 | 节点 ID。 |
NodeRole | String | Primary | 节点角色,取值范围如下:
|
NodeSpec | String | mongo.shard.1c2g | 节点规格。 |
NodeStatus | String | Running | 节点状态。 |
TotalMemoryGB | Float | 2 | 总内存。单位:GiB。 |
TotalStorageGB | Float | 20 | 该节点的总存储空间。单位:GiB。 |
TotalvCPU | Float | 1 | 总核数。 |
UsedMemoryGB | Float | 0.4655952453613281 | 已用内存。单位:GiB。 |
UsedStorageGB | Float | 0.9955019280314445 | 该节点已用的存储空间。单位:GiB。 |
UsedvCPU | Float | 0.003100326 | 已用核数。 |
ZoneId | String | cn-beijing-a | 当前节点所属的可用区 ID。 说明 若您的实例部署了多可用区,则不同角色节点的所在的可用区不一样。关于多可用区部署的更多详情,请参见多可用区同城容灾解决方案。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CpuNum | Double | 1 | CPU 核数。 |
MaxConn | Integer | 1000 | 最大连接数。 |
MaxStorage | Integer | 2000 | 本地盘可选存储空间的最大值。单位:GiB。 |
MinStorage | Integer | 20 | 本地盘可选存储空间的最小值。单位:GiB。 |
MemInGb | Double | 2 | 内存,单位:GiB。 |
SpecName | String | mongo.1c2g | 规格码。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ModifyTime | String | 2022-07-18 21:05:08 | 目标参数被修改的时间点(UTC时间)。 |
NewParameterValue | String | 600001 | 修改后的参数值。 |
OldParameterValue | String | 600000 | 修改前的参数值。 |
ParameterName | String | cursorTimeoutMillis | 目标参数的名称。 |
ParameterRole | String | Node | 目标参数所属的节点类型,取值范围如下:
|
ParameterStatus | String | Applied | 新参数值是否生效。取值范围如下:
|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ParameterName | String | 是 | cursorTimeoutMillis | 目标参数的名称。 说明 您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情,包括参数名称。 |
ParameterRole | String | 是 | Node | 目标参数所属的节点类型,取值范围如下:
说明 您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情,包括参数所属的节点类型。 |
ParameterValue | String | 是 | 600001 | 目标参数的取值。 说明 您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情,包括目标参数的取值范围(即 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RegionId | String | cn-beijing | 地域 ID。 |
RegionName | String | 华北2(北京) | 地域名称。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Nodes | Array of NodesObject | 请参见返回示例。 | Shard 分片中各节点的信息列表。关于 Nodes 的详细说明,请参见数据结构。 |
ShardId | String | mongo-shard-011d2479****-s0 | Shard 节点的 ID。 说明 仅分片集群实例支持返回该参数。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CpuNum | Double | 1 | CPU 核数。 |
MaxConn | Integer | 1000 | 最大连接数。 |
MaxStorage | Integer | 2000 | 本地盘可选存储空间的最大值。单位:GiB。 |
MinStorage | Integer | 20 | 本地盘可选存储空间的最小值。单位:GiB。 |
MemInGb | Double | 2 | 内存,单位:GiB。 |
SpecName | String | mongo.shard.1c2g | 规格码。 |
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Key | String | 是 | instancetype | 用于查询筛选的标签键。 说明
|
Value | String | 否 | replica | 用于查询筛选的标签键所对应的标签值。 说明
|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Key | String | 是 | instancetype |
|
Value | String | 否 | replica |
|
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ZoneId | String | cn-beijing-a | 可用区 ID。 |
ZoneName | String | 华北 2(北京)- 可用区 A | 可用区名称。 |