列出一个项目中的所有主机分配

在此页面上

所需角色

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

Ops Manager v 6 。 0将于2025 1 月停产。尽快升级到更高的 Ops Manager 版本。

检索一个项目的所有主机分配。

所需角色

您的 API 密钥必须具有 Global Owner角色才能成功调用此资源。

请求

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /usage/groups/{groupId}/hosts

请求路径参数

Ops Manager 需要所有路径参数：

路径参数	类型	说明
groupId	字符串	与所需主机关联的项目的唯一标识符。

请求查询参数

名称

类型

必要性

说明

默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

名称	说明
状态	HTTP 响应代码
envelope	预期响应正文

false

查询参数	类型	必要性	说明	默认
startDate	字符串	必需	ISO8601 的日期主机分配列表开始的日期格式。
endDate	字符串	必需	ISO8601 的日期主机分配列表结束时的日期格式。
pageNum	整型	必需	要返回的主机分配的起始群组。群组大小在itemsPerPage中定义。该值从 1 开始。
itemsPerPage	整型	必需	一个群组中要返回的主机分配数量。	`100`

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

响应元素	类型	说明
主机	字符串数组	绑定到所提供物理主机的虚拟主机列表。
主机 .groupId	字符串	Ops Manager 将此虚拟主机置于其中的项目的唯一标识符。
主机 .hostname	字符串	绑定到物理主机的虚拟主机的FQDN 。
processes	对象数组	在虚拟主机上运行的 MongoDB 进程。
processes .[n].cluster	对象	MongoDB 进程所属集群的名称。
processes .[n].groupName	字符串	MongoDB 进程所属的项目名称。
processes .[n].orgName	字符串	MongoDB 进程所属的组织名称。
processes .[n].groupId	字符串	MongoDB 进程所属项目的唯一标识符。
processes .[n].hasConflictingServerType	布尔	指示该节点是否具有与其他节点不同的服务器类型的标志。
processes .[n].name	字符串	托管 MongoDB 进程的节点的名称。
processes .[n].processType	整型	表示 MongoDB 进程类型的数字。
serverType	对象	物理主机的服务器类型。提示另请参阅： MongoDB 使用情况
serverType.name	字符串	Ops Manager 返回以下值之一： `DEV_SERVER` `TEST_SERVER` `PRODUCTION_SERVER` `RAM_POOL`
serverType.label	字符串	Ops Manager 返回以下值之一： `Dev Server` `Test Server` `Production Server` `Ram Pool`

请求示例

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 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 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      "links": [{
3        "rel": "self",
4        "href": "http://usage.example.com/api/public/v1.0/usage/assignments?startDate=2020-07-23&endDate=2020-07-28&pageNum=1&itemsPerPage=100"
5      }],
6      "totalCount": 3,
7      "results": [{
8        "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0",
9        "processes": [{
10          "cluster": "sdivabux",
11          "groupName": "{projectName}",
12          "orgName": "{orgName}",
13          "groupId": "{groupId}",
14          "hasConflictingServerType": true,
15          "name": "replicaPrimary-0-proc0-run51839",
16          "processType": 7
17        },
18        {
19          "cluster": "sdivabux",
20          "groupName": "{projectName}",
21          "orgName": "{orgName}",
22          "groupId": "{groupId}",
23          "hasConflictingServerType": true,
24          "name": "replicaPrimary-0-proc1-run51839",
25          "processType": 7
26        }
27      ],
28        "serverType": {
29          "name": "PRODUCTION_SERVER",
30          "label": "Production Server"
31        },
32        "isChargeable": true,
33        "memSizeMB": 178
34      },
35      {
36        "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
37        "processes": [{
38          "cluster": "sdivabux",
39          "groupName": "{projectName}",
40          "orgName": "{orgName}",
41          "groupId": "{groupId}",
42          "hasConflictingServerType": true,
43          "name": "replicaSecondary-0-proc0-run51839",
44          "processType": 8
45        },
46        {
47          "cluster": "sdivabux",
48          "groupName": "{projectName}",
49          "orgName": "{orgName}",
50          "groupId": "{groupId}",
51          "hasConflictingServerType": true,
52          "name": "replicaSecondary-0-proc1-run51839",
53          "processType": 8
54        }
55      ],
56        "serverType": {
57          "name": "PRODUCTION_SERVER",
58          "label": "Production Server"
59        },
60        "isChargeable": true,
61        "memSizeMB": 178
62      },
63      {
64        "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-2",
65        "processes": [{
66          "cluster": "sdivabux",
67          "groupName": "{projectName}",
68          "orgName": "{orgName}",
69          "groupId": "{groupId}",
70          "hasConflictingServerType": true,
71          "name": "replicaSecondary-0-proc1-run51839",
72          "processType": 8
73        },
74        {
75          "cluster": "sdivabux",
76          "groupName": "{projectName}",
77          "orgName": "{orgName}",
78          "groupId": "{groupId}",
79          "hasConflictingServerType": true,
80          "name": "replicaSecondary-0-proc0-run51839",
81          "processType": 8
82        }
83      ],
84        "serverType": {
85          "name": "RAM_POOL",
86          "label": "RAM Pool"
87        },
88        "isChargeable": true,
89        "memSizeMB": 178
90      }
91    ]
92    }

← 列出所有主机分配

获取一个项目的默认服务器类型 →

1	{
2	"links": [{
3	"rel": "self",
4	"href": "http://usage.example.com/api/public/v1.0/usage/assignments?startDate=2020-07-23&endDate=2020-07-28&pageNum=1&itemsPerPage=100"
5	}],
6	"totalCount": 3,
7	"results": [{
8	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0",
9	"processes": [{
10	"cluster": "sdivabux",
11	"groupName": "{projectName}",
12	"orgName": "{orgName}",
13	"groupId": "{groupId}",
14	"hasConflictingServerType": true,
15	"name": "replicaPrimary-0-proc0-run51839",
16	"processType": 7
17	},
18	{
19	"cluster": "sdivabux",
20	"groupName": "{projectName}",
21	"orgName": "{orgName}",
22	"groupId": "{groupId}",
23	"hasConflictingServerType": true,
24	"name": "replicaPrimary-0-proc1-run51839",
25	"processType": 7
26	}
27	],
28	"serverType": {
29	"name": "PRODUCTION_SERVER",
30	"label": "Production Server"
31	},
32	"isChargeable": true,
33	"memSizeMB": 178
34	},
35	{
36	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
37	"processes": [{
38	"cluster": "sdivabux",
39	"groupName": "{projectName}",
40	"orgName": "{orgName}",
41	"groupId": "{groupId}",
42	"hasConflictingServerType": true,
43	"name": "replicaSecondary-0-proc0-run51839",
44	"processType": 8
45	},
46	{
47	"cluster": "sdivabux",
48	"groupName": "{projectName}",
49	"orgName": "{orgName}",
50	"groupId": "{groupId}",
51	"hasConflictingServerType": true,
52	"name": "replicaSecondary-0-proc1-run51839",
53	"processType": 8
54	}
55	],
56	"serverType": {
57	"name": "PRODUCTION_SERVER",
58	"label": "Production Server"
59	},
60	"isChargeable": true,
61	"memSizeMB": 178
62	},
63	{
64	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-2",
65	"processes": [{
66	"cluster": "sdivabux",
67	"groupName": "{projectName}",
68	"orgName": "{orgName}",
69	"groupId": "{groupId}",
70	"hasConflictingServerType": true,
71	"name": "replicaSecondary-0-proc1-run51839",
72	"processType": 8
73	},
74	{
75	"cluster": "sdivabux",
76	"groupName": "{projectName}",
77	"orgName": "{orgName}",
78	"groupId": "{groupId}",
79	"hasConflictingServerType": true,
80	"name": "replicaSecondary-0-proc0-run51839",
81	"processType": 8
82	}
83	],
84	"serverType": {
85	"name": "RAM_POOL",
86	"label": "RAM Pool"
87	},
88	"isChargeable": true,
89	"memSizeMB": 178
90	}
91	]
92	}