检索一个项目的所有主机分配。
所需角色
您的 API 密钥必须具有Global Owner角色才能成功调用此资源。
请求
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/groups/{groupId}/hosts请求路径参数
Ops Manager 需要所有路径参数：
路径参数 | 类型 | 说明 |
|---|---|---|
groupId | 字符串 | 与所需主机关联的项目的唯一标识符。 |
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否采用 pretty-print 格式的标志。 |
|
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
|
|
查询参数 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
startDate | 字符串 | 必需 | 托管分配列表的开始日期（采用 ISO8601 日期格式）。 | |
endDate | 字符串 | 必需 | ||
pageNum | 整型 | 必需 | 要返回的托管分配的起始群组。群组大小由 itemsPerPage 定义。该值以 1 开头。 | |
itemsPerPage | 整型 | 必需 | 一个群组中要返回的主机分配数量。 |
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应元素 | 类型 | 说明 |
|---|---|---|
主机 | 字符串数组 | 绑定到所提供物理主机的虚拟主机列表。 |
hosts | 字符串 | Ops Manager 将此虚拟主机置于其中的项目的唯一标识符。 |
hosts | 字符串 | 绑定到物理主机的虚拟主机的FQDN 。 |
processes | 对象数组 | 在虚拟主机上运行的 MongoDB 进程。 |
processes | 对象 | MongoDB 进程所属集群的名称。 |
进程 | 字符串 | MongoDB 进程所属的项目名称。 |
processes | 字符串 | MongoDB 进程所属的组织名称。 |
进程 | 字符串 | MongoDB 进程所属项目的唯一标识符。 |
processes | 布尔 | 指示该节点是否具有与其他节点不同的服务器类型的标志。 |
processes | 字符串 | 托管 MongoDB 进程的节点的名称。 |
processes | 整型 | 表示 MongoDB 进程类型的数字。 |
serverType | 对象 | 物理主机的服务器类型。 要学习；了解更多信息，请参阅MongoDB使用页面。 |
serverType.name | 字符串 | Ops Manager 返回以下值之一：
|
serverType.label | 字符串 | Ops Manager 返回以下值之一：
|
请求示例
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/usage/groups/{groupId}/hosts?startDate=2020-07-23&endDate=2020-07-28&pageNum=1&itemsPerPage=100&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}响应体
{ "links": [{ "rel": "self", "href": "http://usage.example.com/api/public/v1.0/usage/assignments?startDate=2020-07-23&endDate=2020-07-28&pageNum=1&itemsPerPage=100" }], "totalCount": 3, "results": [{ "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0", "processes": [{ "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaPrimary-0-proc0-run51839", "processType": 7 }, { "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaPrimary-0-proc1-run51839", "processType": 7 } ], "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server" }, "isChargeable": true, "memSizeMB": 178 }, { "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1", "processes": [{ "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaSecondary-0-proc0-run51839", "processType": 8 }, { "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaSecondary-0-proc1-run51839", "processType": 8 } ], "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server" }, "isChargeable": true, "memSizeMB": 178 }, { "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-2", "processes": [{ "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaSecondary-0-proc1-run51839", "processType": 8 }, { "cluster": "sdivabux", "groupName": "{projectName}", "orgName": "{orgName}", "groupId": "{groupId}", "hasConflictingServerType": true, "name": "replicaSecondary-0-proc0-run51839", "processType": 8 } ], "serverType": { "name": "RAM_POOL", "label": "RAM Pool" }, "isChargeable": true, "memSizeMB": 178 } ] }