Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
部署
/
主机

获取一个项目中的所有主机

在此页面上

  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 响应文档
  • results 嵌入式文档
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

获取项目中的所有 MongoDB 主机。 使用CLUSTER-ID查询参数仅获取属于指定集群的主机。 响应按HOSTNAME:PORT的字母顺序对主机进行排序。

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/hosts
GET /groups/{PROJECT-ID}/hosts?clusterId={CLUSTER-ID}

请求路径参数

Parameter
类型
必要性
说明

PROJECT-ID

字符串

必需

拥有此 MongoDB 主机的项目的唯一标识符。

请求查询参数

名称
类型
必要性
说明
默认

pageNum

数字

Optional

从一开始的整数，用于返回结果的一部分。

1

itemsPerPage

数字

Optional

每页要返回的项目数，最多 500 个。

100

pretty

布尔

Optional

指示响应正文是否应采用 美观打印 的标志 格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 envelope : true。

对于返回结果列表的端点，content 对象是一个信封。Cloud Manager 将 status 字段添加到响应正文。

false

backupJobsEnabledOnly

布尔

Optional

指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为false以包含将backupJobsEnabled标志设置为false的守护进程配置。

true

Parameter
类型
必要性
说明

CLUSTER-ID

字符串

必需

此 MongoDB 进程所属集群的唯一标识符。

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

响应文档

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称
类型
说明

results

阵列

数组为results 嵌入式文档 部分中详细介绍的每一项包含一个对象。

links

阵列

数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

totalCount

数字

结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。

results 嵌入式文档

每个结果都是一个主机。

名称
类型
说明

别名

字符串数组

Cloud Manager 为 MongoDB 进程发现的备用主机名和端口组合的数组。这些组合可以包括主机名、 FQDN 、 IPv4地址和IPv6地址。

alertsEnabled

布尔

true 如果此 MongoDB 进程已启用警报。

authMechanismName

字符串

用于连接到此 MongoDB 进程的身份验证机制。 这只显示以下值之一：

  • MONGODB_CR （涵盖 SCRAM-SHA-1、SCRAM-SHA-256 和 MONGODB-CR。）

  • GSSAPI

  • PLAIN

  • MONGODB_X509

  • NONE

clusterId

字符串

MongoDB 进程所属集群的唯一标识符。

已创建

日期

Cloud Manager 创建或首次发现此 MongoDB 进程的日期。

groupId

字符串

拥有该主机的群组的唯一标识符。

hasStartupWarnings

布尔

true 如果此 MongoDB 进程有初创企业警告。

隐藏

布尔

true 如果托管显示在Cloud Manager用户界面中。 设立为true的主机将从API响应中省略。

hiddenSecondary

布尔

true 如果此托管是隐藏的从从节点(secondary node from replica set)。

hostEnabled

布尔

true 如果 MongoDB 进程当前已启用。

主机名

字符串

Cloud Manager 可以确定的最佳主节点主机名。这可以是主机名、 FQDN 、 IPv4地址或IPv6地址。

id

字符串

唯一标识符。

IP 地址

字符串

与此 MongoDB 进程的hostname关联的IPv4或IPv6地址。 其他可访问的IPv4或IPv6地址可能会显示在aliases数组中。

journalingEnabled

布尔

true 如果为此 MongoDB 进程启用了日志功能。

lastDataSizeBytes

数字

磁盘上主机数据库的未压缩大小（不包括索引）。 lastDataSizeBytes不包括本地数据库中的数据。

lastIndexSizeBytes

数字

磁盘上主机数据库索引的未压缩大小（以字节为单位）。 此数字不包括本地数据库索引的大小。

lastPing

日期

ISO8601 格式的时间戳 收到此 MongoDB 进程的最后一次 ping 时的日期和时间格式（ UTC 格式）。

lastRestart

日期

ISO8601 格式的时间戳 此进程上次重新启动时的日期和时间格式（ UTC 格式）。如果 MongoDB 进程从未重新启动过，则省略lastRestart字段。

链接

阵列

包含一个或多个指向子资源和/或相关资源的链接的数组。 URL 之间的关系在 Web 链接规范 中进行了解释 。links数组至少包含一个名为self的链接。

logsEnabled

布尔

true 如果 Cloud Manager 正在收集此 MongoDB 进程的日志。

lowUlimit

布尔

true 如果此MongoDB进程的托管的ulimit设置较低。

端口

数字

MongoDB 进程侦听的端口。

profilerEnabled

布尔

true 如果 Cloud Manager 从此 MongoDB 进程收集配置文件信息。

ReplicaSetName

字符串

此进程所属的副本集名称。 仅当该进程是副本集的一部分时才出现。

replicaStateName

字符串

副本集中此 MongoDB 进程的当前状态。 仅当该进程是副本集的一部分时才出现。 有关可能的值，请参阅副本集成员状态。

shardName

字符串

此进程所属分片的名称。 仅当进程是分片集群的一部分时才出现。

secondaryDelaySecs

数字

此副本集节点的数据落后于主节点的秒数。 如果将此值设置为0 ，则不会将该成员配置为延迟成员。 有关从节点延迟的更多详细信息，请参阅延迟的副本集节点

sslEnabled

布尔

true 如果TLS / SSL且已为此MongoDB进程启用。

systemInfo

对象

对象，其中包含操作系统或容器报告的此 MongoDB 进程的服务器的 RAM 和 CPU 信息。

systemInfo.memSizeMB

数字

RAM 大小（以 MB 为单位）。

systemInfo.numCores

数字

CPU 核心数。

typeName

字符串

此 MongoDB 进程的类型。 可能的值为：

  • STANDALONE

  • REPLICA_PRIMARY

  • REPLICA_SECONDARY

  • REPLICA_ARBITER

  • RECOVERING

  • SHARD_MONGOS

  • SHARD_CONFIG

  • SHARD_STANDALONE

  • SHARD_PRIMARY

  • SHARD_SECONDARY

  • NO_DATA

在监控首次收到网络探测（ping）之前，添加到 Cloud Manager 的新主机的类型将为NO_DATA 。

uptimeMsec

数字

自此进程上次重新启动以来的毫秒数。

版本

字符串

为此进程运行的 MongoDB 版本。

注意

某些主机不返回clusterId 。 当mongos进程将数据操作路由到不存储数据的分片时，就会发生这种情况。 Cloud Manager 不会向某些非数据承载节点分配clusterId 。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts?pretty=true"

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

1{
2  "totalCount" : 2,
3  "results" : [
4    {
5      "alertsEnabled" : true,
6      "aliases": [ "{HOSTNAME}:26000", "{IP-ADDRESS}:26000" ],
7      "authMechanismName" : "SCRAM-SHA-1",
8      "clusterId" : "{CLUSTER-ID}",
9      "created" : "2014-04-22T19:56:50Z",
10      "groupId" : "{PROJECT-ID}",
11      "hasStartupWarnings" : false,
12      "hidden" : false,
13      "hostEnabled" : true,
14      "hostname" : "{HOSTNAME}",
15      "id" : "{HOST-ID}",
16      "ipAddress": "127.0.0.1",
17      "journalingEnabled" : false,
18      "lastDataSizeBytes" : 633208918,
19      "lastIndexSizeBytes" : 101420524,
20      "lastPing" : "2016-08-18T11:23:41Z",
21      "links" : [  ],
22      "logsEnabled" : false,
23      "lowUlimit" : false,
24      "muninEnabled" : false,
25      "port" : 26000,
26      "profilerEnabled" : false,
27      "replicaSetName": "rs1",
28      "replicaStateName" : "PRIMARY",
29      "sslEnabled" : true,
30      "systemInfo" : {
31        "memSizeMB" : 65536,
32        "numCores" : 16
33      },
34      "typeName": "REPLICA_PRIMARY",
35      "uptimeMsec": 1827300394,
36      "username" : "mongo",
37      "version" : "4.0.0"
38    },
39    {
40
41    }
42  ]
43}

注意

虽然 Cloud Manager 在响应中返回 muninEnabled ，但 Munin 不受支持。

后退

主机

来年

通过ID获取