开始监控一台主机

在此页面上

Resource

请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。

用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。: 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth 2.0身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。

注意

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

开始监控新的 MongoDB 进程。监控开始监控您指定的主机名和端口上的 MongoDB 进程。 Cloud Manager 仅了解您提供的信息。在 Cloud Manager 完成 MongoDB 进程配置的发现之前，响应文档包含空白值。

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

Resource

POST /groups/{PROJECT-ID}/hosts

请求路径参数

Parameter	类型	必要性	说明
PROJECT-ID	字符串	必需	拥有此 MongoDB 进程的项目的唯一标识符。

请求查询参数

以下查询参数为可选参数：

名称

类型

必要性

说明

默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

请求正文参数

名称	类型	必要性	说明
alertsEnabled	布尔	Optional	如果应为此 MongoDB 进程启用警报，则设置为`true` 。
authMechanismName	字符串	Optional	指定应使用哪种身份验证机制连接到此 MongoDB 进程。可能的值为： `MONGODB_CR` （涵盖 SCRAM-SHA-1、SCRAM-SHA-256 和 MONGODB-CR。） `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
主机名	字符串	必需	设置 Cloud Manager 用于连接到此 MongoDB 实例的主节点主机名。
logsEnabled	布尔	Optional	如果 Cloud Manager 应收集此 MongoDB 进程的日志，则设置为`true` 。
密码	字符串	Optional	与`username`关联的密码，用于连接到此 MongoDB 进程。在以下情况下设置此参数： `"authMechanismName" : "MONGODB_CR"` Cloud Manager 不会在任何 Host \|\|响应。
端口	数字	必需	MongoDB 进程侦听的端口。
profilerEnabled	布尔	Optional	指示 Cloud Manager 是否从此 MongoDB 进程收集配置文件信息的标志。
sslEnabled	布尔	可选的	指示是否应为此 MongoDB 进程启用TLS的标志。 `true`如果，则设置为`"authMechanismName" : "MONGODB_X509"` 。
用户名	字符串	可选的	连接到此 MongoDB 进程所需的用户名。在以下情况下为必填项： `"authMechanismName" : "MONGODB_CR"`

响应

名称	类型	说明
别名	字符串数组	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 版本。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts?pretty=true" \
     --data '
       {
         "hostname": "server1.example.com",
         "port": 27017
       }'

响应示例

响应标头

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 201 Created
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   "alertsEnabled" : true,
3   "authMechanismName" : "NONE",
4   "created" : "2014-04-22T19:56:50Z",
5   "groupId" : "{PROJECT-ID}",
6   "hasStartupWarnings" : false,
7   "hidden" : false,
8   "hostEnabled" : true,
9   "hostname" : "server1.example.com",
10   "id" : "{HOST-ID}",
11   "journalingEnabled" : false,
12   "links" : [  ],
13   "logsEnabled" : false,
14   "lowUlimit" : false,
15   "port" : 27017,
16   "profilerEnabled" : false,
17   "sslEnabled" : false
18   "systemInfo" : {
19     "memSizeMB" : 65536,
20     "numCores" : 16
21   },
22 }

后退

按主机名和端口获取一台主机

来年

更新一台受监控主机的配置

1	{
2	"alertsEnabled" : true,
3	"authMechanismName" : "NONE",
4	"created" : "2014-04-22T19:56:50Z",
5	"groupId" : "{PROJECT-ID}",
6	"hasStartupWarnings" : false,
7	"hidden" : false,
8	"hostEnabled" : true,
9	"hostname" : "server1.example.com",
10	"id" : "{HOST-ID}",
11	"journalingEnabled" : false,
12	"links" : [ ],
13	"logsEnabled" : false,
14	"lowUlimit" : false,
15	"port" : 27017,
16	"profilerEnabled" : false,
17	"sslEnabled" : false
18	"systemInfo" : {
19	"memSizeMB" : 65536,
20	"numCores" : 16
21	},
22	}