Recupera todas las asignaciones de host.
Roles necesarios
Tu clave API debe tener el rol Global Owner para llamar correctamente a este recurso.
Solicitud
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/assignmentsParámetros de ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetro query | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
startDate | string | Requerido | Fecha en formato de fecha ISO 8601 ISO cuando la lista de asignaciones de host comience. | |
endDate | string | Requerido | Fecha en ISO 8601 formato de fecha cuando termina la lista de asignaciones de host. | |
Num. de pág. | entero | Requerido | Grupo inicial de asignaciones del host para devolver. El tamaño del grupo está definido por itemsPerPage. Este valor comienza con 1. | |
elementosPorPágina | entero | Requerido | Número de asignaciones de host que se devolverán en un grupo. |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Elemento de respuesta | Tipo | Descripción |
|---|---|---|
host | Arreglo de cadenas | Lista de hosts virtuales vinculados al host fÃsico proporcionado. |
hosts | string | Identificador único del proyecto en el que Ops Manager ubica este host virtual. |
hosts | string | FQDN del host virtual vinculado al host fÃsico. |
Procesos | Arreglo de objetos | Procesos de MongoDB ejecutándose en el host virtual. |
processes | Objeto | Nombre del clúster al que pertenece el proceso de MongoDB. |
procesos | string | Nombre del proyecto al que pertenece el proceso de MongoDB. |
processes | string | Nombre de la organización a la que pertenece el proceso MongoDB. |
procesos | string | Identificador único del proyecto al que pertenece el proceso de MongoDB. |
procesos | Booleano | Indicador que señala si el nodo tiene un tipo de servidor distinto al de los demás nodos. |
processes | string | Nombre del nodo que aloja el proceso de MongoDB. |
procesos | entero | Número que representa el tipo de proceso de MongoDB. |
Tipo de servidor | Objeto | Tipo de servidor del host fÃsico. Para obtener más información, consulta la Página de uso de MongoDB. |
serverType.name | string | Ops Manager devuelve uno de los siguientes valores:
|
serverType.label | string | Ops Manager devuelve uno de los siguientes valores:
|
Solicitud de ejemplo
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/usage/assignments?startDate=2020-07-23&endDate=2020-07-28&pageNum=1&itemsPerPage=100&pretty=true'Respuesta de ejemplo
Encabezado de respuesta
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}Respuesta del cuerpo
{ "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 } ] }