所需角色
此资源需要API 密钥才能具有Global Owner角色。
Resource
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/groups请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 说明 | 默认 |
|---|---|---|---|
pageNum | 整型 | 页码（从 1 开始）。 |
|
itemsPerPage | 整型 | 每页要返回的项目数，最多 500 个。 |
|
pretty | 布尔 | 指示显示正文是否应采用 prettyprint 格式。 |
|
envelope | 布尔 | 指示是否要将响应封装在信封中。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 对于返回一个结果的终结点，响应体包括：
对于返回结果列表的端点， | 无 |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应 JSON 文档包括 result 对象数组、link 对象数组和检索到的 result 对象的总数。
名称 | 类型 | 说明 |
|---|---|---|
| 阵列 | 数组为 |
| 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
| 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。 |
results 嵌入式文档
结果数组中的每个元素都是一个物理主机。
响应元素 | 类型 | 说明 |
|---|---|---|
主机 | 对象数组 | 绑定到所提供物理主机的虚拟主机列表。 |
hosts | 字符串 | Ops Manager 将此虚拟主机置于其中的项目的唯一标识符。 |
hosts | 字符串 | 绑定到物理主机的虚拟主机的FQDN 。 |
id | 字符串 | Ops Manager 将虚拟主机绑定到的物理主机的唯一标识符。 |
名称 | 字符串 | 您为物理主机提供的标签。 |
serverType | 字符串 |
请求示例
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?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": [ { "href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "hosts": [ { "groupId": "{projectId1}", "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-7" }, { "groupId": "{projectId1}", "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-8" } ], "id": "{physicalHostId1}", "name": "physicalHostA", "serverType": "DEV_SERVER" }, { "hosts": [ { "groupId": "{projectId2}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0" }, { "groupId": "{projectId2}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1" } ], "id": "{physicalHostId2}", "name": "physicalHostB", "serverType": "DEV_SERVER" }, ], "totalCount": 2}