Roles necesarios
Este recurso requiere que la clave API tenga el rol de Global Owner.
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/groups/{physicalHostId}Parámetros de ruta de solicitud
Ops Manager requiere todos los parámetros de ruta de solicitud:
Path Parameter | Tipo | Descripción |
|---|---|---|
physicalHostId | string | Identificador único del host físico a recuperar. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Descripción | predeterminado |
|---|---|---|---|
Num. de pág. | entero | Número de página (basado en índice a partir de 1). |
|
elementosPorPágina | entero | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Indica si el cuerpo de la respuesta debe estar en un formato prettyprint. |
|
envelope | booleano | 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 corregir esto, establezca Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | Ninguno |
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 objetos | 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. |
ID | string | Identificador único del host físico al que Ops Manager vinculó los hosts virtuales. |
Nombre | string | Etiqueta que diste al host físico. |
Tipo de servidor | string | Tipo de servidor del host físico. Ops Manager devuelve uno de los siguientes valores:
Para obtener más información, consulta la Página de uso de MongoDB. |
Solicitud de ejemplo
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups/{physicalHostId}?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
{ "hosts": [ { "groupId": "{PROJECT-ID}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-2" }, { "groupId": "{PROJECT-ID}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-3" }, { "groupId": "{PROJECT-ID}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-4" }, { "groupId": "{PROJECT-ID}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-5" }, { "groupId": "{PROJECT-ID}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-6" }, { "groupId": "{PROJECT-ID}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-7" }, { "groupId": "{PROJECT-ID}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-8" }, { "groupId": "{PROJECT-ID}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-9" } ], "id": "{PHYSICAL-HOST-ID}", "name": "physicalDevHostA", "serverType": "DEV_SERVER"}