按主机名和端口获取一台主机
注意
注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
通过主机名和端口组合获取单个 MongoDB 进程。 您可以指定主节点主机名或别名。
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts/byName/{HOSTNAME}:{PORT}
请求路径参数
Parameter | 类型 | 必要性 | 说明 |
|---|---|---|---|
PROJECT-ID | 字符串 | 必需 | 拥有此 MongoDB 进程的项目的唯一标识符。 |
主机名 | 字符串 | 必需 | Ops Manager 用于连接到此 MongoDB 实例的主节点主机名。此主机名可以是主机名、 FQDN 、 IPv4地址或IPv6地址。 |
端口 | 字符串 | 必需 | MongoDB 进程侦听的端口。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
|---|---|---|
别名 | 字符串数组 | Ops Manager 为 MongoDB 进程发现的备用主机名和端口组合的数组。这些组合可以包括主机名、 FQDN 、 IPv4地址和IPv6地址。 |
alertsEnabled | 布尔 | true 如果此 MongoDB 进程已启用警报。 |
authMechanismName | 字符串 | 用于连接到此 MongoDB 进程的身份验证机制。 这只显示以下值之一：
|
clusterId | 字符串 | MongoDB 进程所属集群的唯一标识符。 |
已创建 | 日期 | Ops Manager 创建或首次发现此 MongoDB 进程的日期。 |
groupId | 字符串 | 拥有该主机的群组的唯一标识符。 |
hasStartupWarnings | 布尔 | true 如果此 MongoDB 进程有初创企业警告。 |
隐藏 | 布尔 | true 如果托管显示在MongoDB Ops Manager用户界面中。 设立为true的主机将从API响应中省略。 |
hiddenSecondary | 布尔 | true 如果此托管是隐藏的从从节点(secondary node from replica set)。 |
hostEnabled | 布尔 | true 如果 MongoDB 进程当前已启用。 |
主机名 | 字符串 | Ops 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 | 日期 | |
链接 | 阵列 | |
logsEnabled | 布尔 | true 如果 Ops Manager 正在收集此 MongoDB 进程的日志。 |
lowUlimit | 布尔 | true 如果此MongoDB进程的托管的ulimit设置较低。 |
端口 | 数字 | MongoDB 进程侦听的端口。 |
profilerEnabled | 布尔 | true 如果 Ops Manager 从此 MongoDB 进程收集配置文件信息。 |
ReplicaSetName | 字符串 | 此进程所属的副本集名称。 仅当该进程是副本集的一部分时才出现。 |
replicaStateName | 字符串 | 副本集中此 MongoDB 进程的当前状态。 仅当该进程是副本集的一部分时才出现。 有关可能的值，请参阅副本集成员状态。 |
shardName | 字符串 | 此进程所属分片的名称。 仅当进程是分片集群的一部分时才出现。 |
secondaryDelaySecs | 数字 | |
sslEnabled | 布尔 | true 如果TLS / SSL且已为此MongoDB进程启用。 |
systemInfo | 对象 | 对象，其中包含操作系统或容器报告的此 MongoDB 进程的服务器的 RAM 和 CPU 信息。 |
systemInfo.memSizeMB | 数字 | RAM 大小（以 MB 为单位）。 |
systemInfo.numCores | 数字 | CPU 核心数。 |
typeName | 字符串 | 此 MongoDB 进程的类型。 可能的值为：
在 Ops Manager 首次收到网络探测（ping）之前，添加到 Ops Manager 的新主机的类型将为 |
uptimeMsec | 数字 | 自此进程上次重新启动以来的毫秒数。 |
版本 | 字符串 | 为此进程运行的 MongoDB 版本。 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts/byName/server1.example.com:27017?pretty=true"
响应示例
响应标头
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
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 "alertsEnabled" : true, 3 "aliases": [ "server1.example.com:27017", "10.1.0.10:27017" ], 4 "authMechanismName" : "SCRAM-SHA-1", 5 "clusterId" : "{CLUSTER-ID}", 6 "created" : "2024-04-22T19:56:50Z", 7 "groupId" : "{PROJECT-ID}", 8 "hasStartupWarnings" : false, 9 "hidden" : false, 10 "hostEnabled" : true, 11 "hostname" : "server1.example.com", 12 "id" : "{HOST-ID}", 13 "ipAddress": "10.1.0.10", 14 "journalingEnabled" : false, 15 "lastDataSizeBytes" : 633208918, 16 "lastIndexSizeBytes" : 101420524, 17 "lastPing" : "2024-08-18T11:23:41Z", 18 "links" : [ ], 19 "logsEnabled" : false, 20 "lowUlimit" : false, 21 "muninEnabled" : false, 22 "port" : 27017, 23 "profilerEnabled" : false, 24 "replicaSetName": "rs1", 25 "replicaStateName" : "PRIMARY", 26 "sslEnabled" : true, 27 "systemInfo" : { 28 "memSizeMB" : 65536, 29 "numCores" : 16 30 }, 31 "typeName": "REPLICA_PRIMARY", 32 "uptimeMsec": 1827300394, 33 "username" : "mongodb", 34 "version" : "4.4.0" 35 }
注意
虽然MongoDB Ops Manager 在响应中返回 muninEnabled ，但 Munin 从MongoDB Ops Manager4 .4 开始不受支持。