- API >
- Public API Resources >
- Server Pool >
- Group Server Pool
Group Server Pool¶
On this page
The groups/{GROUP-ID}/serverPool
resource returns the state of Ops Manager
server pool. It is the root resource of the group’s serverPool
resource set and is a resource subset of groups
.
For detailed information on Server pools, see Provision Servers for the Server Pool.
For a list of all resources in the server pool resource set, see Server Pool.
Base URL: {opsManagerHost}:{port}
¶
Syntax¶
Request Parameters¶
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default |
---|---|---|---|
pageNum |
integer | Page number (1-based). | 1 |
itemsPerPage |
integer | Maximum number of items to return, up to a maximum of 100. | 100 |
pretty |
boolean | Display response in human-readable format. | false |
Get the State of the Server Pool¶
Sample Entity¶
Entity Fields¶
Name | Type | Description |
---|---|---|
enabled |
boolean | If true , the server pool is enabled. |
Links¶
Relation | Description |
---|---|
self |
Me |
http://mms.mongodb.com/serverPoolServers |
The servers in the pool. |
http://mms.mongodb.com/serverPoolProperties |
The properties used to identify servers in the server pool. |
http://mms.mongodb.com/serverPoolRequests |
All requests for servers from the server pool. |