注意
注意:群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。终结点仍如文档中所述。
根据主机名和端口返回一个主机,包括该主机的副本集成员的复制健康状况。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v2.0
Resource
GET /groups/{PROJECT-ID}/hosts/byName/{HOSTNAME-PORT}所需角色
The API key that makes this request must have the Project Read Only role.
请求路径参数
名称 | 类型 | 必要性 | 说明 |
|---|---|---|---|
PROJECT-ID | 字符串 | 必需 | 标识项目的唯一 24 位十六进制数字字符串。 |
主机名-端口 | 字符串 | 必需 | The host, as |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否采用 pretty-print 格式的标志。 |
|
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
|
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
The response contains the same fields as the v1.0 endpoint.
名称 | 类型 | 说明 |
|---|---|---|
别名 | 字符串数组 | MongoDB Ops Manager 检测到的针对 MongoDB 进程的备用主机名和端口组合数组。这些组合可以包括主机名、FQDN、IPv4 地址和 IPv6 地址。 |
alertsEnabled | 布尔 |
|
authMechanismName | 字符串 | 用于连接到此 MongoDB 进程的身份验证机制。 这只显示以下值之一:
|
clusterId | 字符串 | MongoDB 进程所属集群的唯一标识符。 |
已创建 | 日期 | Ops Manager 创建或首次发现此 MongoDB 进程的日期。 |
groupId | 字符串 | 拥有该主机的群组的唯一标识符。 |
hasStartupWarnings | 布尔 |
|
隐藏 | 布尔 |
|
hiddenSecondary | 布尔 |
|
hostEnabled | 布尔 |
|
主机名 | 字符串 | 主节点 (primary node in the replica set) 主机名,由 MongoDB Ops Manager 最好地确定。这可以是主机名、FQDN、IPv4 地址或 IPv6 地址。 |
id | 字符串 | 唯一标识符。 |
IP 地址 | 字符串 | IPv4 或 IPv6 地址,与此 MongoDB 进程的 |
journalingEnabled | 布尔 |
|
lastDataSizeBytes | 数字 | 磁盘上主机数据库的未压缩大小(不包括索引)。 |
lastIndexSizeBytes | 数字 | 磁盘上主机数据库索引的未压缩大小(以字节为单位)。 此数字不包括本地数据库索引的大小。 |
lastPing | 日期 | 收到此MongoDB进程的最后一次网络探测(ping)的时间戳,采用 ISO 8601 日期和时间格式(UTC 时间)。 |
lastRestart | 日期 | 上次重新启动此进程时采用 ISO 8601 日期和时间格式(UTC 时间)的时间戳。如果MongoDB进程从未重新启动过,则省略 |
链接 | 阵列 | 包含一个或多个指向子资源和/或相关资源的链接的数组。URL 之间的关系在Web 链接规范中进行了解释。 |
logsEnabled | 布尔 |
|
lowUlimit | 布尔 |
|
端口 | 数字 | MongoDB 进程侦听的端口。 |
profilerEnabled | 布尔 |
|
ReplicaSetName | 字符串 | 此进程所属的副本集名称。 仅当该进程是副本集的一部分时才出现。 |
replicaStateName | 字符串 | 副本集中此 MongoDB 进程的当前状态。 仅当该进程是副本集的一部分时才出现。 有关可能的值,请参阅副本集成员状态。 |
shardName | 字符串 | 此进程所属分片的名称。 仅当进程是分片集群的一部分时才出现。 |
secondaryDelaySecs | 数字 | |
sslEnabled | 布尔 |
|
systemInfo | 对象 | 对象,其中包含操作系统或容器报告的此 MongoDB 进程的服务器的 RAM 和 CPU 信息。 |
systemInfo.memSizeMB | 数字 | RAM 大小(以 MB 为单位)。 |
systemInfo.numCores | 数字 | CPU 核心数。 |
typeName | 字符串 | 此 MongoDB 进程的类型。 可能的值为:
在 Ops Manager 首次收到网络探测(ping)之前,添加到 Ops Manager 的新主机的类型将为 |
uptimeMsec | 数字 | 自此进程上次重新启动以来的毫秒数。 |
版本 | 字符串 | 为此进程运行的 MongoDB 版本。 |
The v2.0 endpoint also returns the following fields.
名称 | 类型 | 说明 |
|---|---|---|
太陈旧了 | 布尔 |
|
最后一次复制错误 | 字符串 | The member's last replication error, from the |
Both fields describe this host's own member entry in its replica set. Ops Manager omits them for hosts that aren't replica set members, and omits lastReplError when the member reports no error.
请求示例
The following example retrieves the host running on node1.example.com:27017.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v2.0/groups/{PROJECT-ID}/hosts/byName/node1.example.com:27017?pretty=true"响应示例
响应标头
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}响应体
为了简洁起见,文档已进行删减。运维管理器返回完整的主机文档。
{ "id": "5f5f8e2b1c9d440b8c1a2b3c", "groupId": "5c8100bcf2a30b12ff88258f", "clusterId": "5e84bd8c87d9d6044a1d76c5", "hostname": "node1.example.com", "port": 27017, "replicaSetName": "rs0", "replicaStateName": "RECOVERING", "tooStale": true, "lastReplError": "error RS102 too stale to catch up", "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v2.0/groups/5c8100bcf2a30b12ff88258f/hosts/5f5f8e2b1c9d440b8c1a2b3c", "rel": "self" }, { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/5c8100bcf2a30b12ff88258f", "rel": "http://mms.mongodb.com/group" } ]}响应代码
HTTP Status | 错误代码 | 说明 |
|---|---|---|
200 | -- | 返回宿主文档。 |
404 | 主机名和端口未找到 |
|
Other response codes match the v1.0 endpoint.