- API >
- Public API Resources >
- Server Pool >
- Server Pool Requests
Server Pool Requests¶
Server Pools deprecated as of Ops Manager 4.0
As of Ops Manager 4.0, server pools are deprecated and disabled by default.
On this page
Note
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
The serverPool/requests
resource provides access to requests for
server pool’s servers. The pool provides Ops Manager users
with pre-provisioned servers for deploying MongoDB.
For a list of all server pool API resources, see Server Pool. For information on the server pool, see Provision Servers for the Server Pool.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Endpoints¶
Get All Server Pool Requests¶
To filter by request status, use the status
query parameter:
STATUS
can be one of the following values:
EXECUTING
CANCELLING
CANCELLED
FAILED
COMPLETED
You must have the Global Read Only role or higher to use this endpoint.
Get a Specific Server Pool Request¶
REQUEST-ID
is the string specified in the id
field of the
serverPool/requests
entity.
You must have the Global Read Only role or higher to use this endpoint.
Cancel a Server Pool Request¶
REQUEST-ID
is the string specified in the id
field of the
serverPool/requests
entity.
You must have the Global Owner role to use this endpoint.
Sample Entity¶
Entity Fields¶
Name | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
string | A unique identifier for the request. | ||||||||||
numServers |
number | The number of servers requested. | ||||||||||
created |
date | The date and time the request was issued. | ||||||||||
expires |
date | The date and time the request expires if no server is available. | ||||||||||
completeDate |
date | The date and time the request was completed. | ||||||||||
cancelDate |
date | The date and time the request was cancelled. | ||||||||||
groupId |
string | The project for which the server is requested. | ||||||||||
properties |
object of key/value pairs | The properties that identify the type of server requested. | ||||||||||
statusName |
string | The status of the request. Possible values are:
|
Links¶
Relation | Description |
---|---|
self | Me |
http://mms.mongodb.com/serverPool |
The server pool. |
http://mms.mongodb.com/serverPoolRequests |
The server pool requests. |