Roles necesarios
Este recurso requiere el
Clave API para tener el Global Owner role.
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/groups
Parámetros de la ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
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(a) pretty-print formato. |
| ||||||
envelope | booleano | Indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure 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
Documento de respuesta
El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| arreglo | El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web. |
| Número | Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado. |
results embeddedDocument
Cada elemento de la matriz de resultados es un host físico.
Elemento de respuesta | Tipo | Descripción |
|---|---|---|
host | Arreglo de objetos | Lista de hosts virtuales vinculados al host físico proporcionado. |
hosts .[n].groupId | string | Identificador único del proyecto en el que Ops Manager ubica este host virtual. |
hosts .[n].hostname | 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
1 curl --user "{publicApiKey}:{privateApiKey}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true"
Respuesta de ejemplo
Encabezado de respuesta
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
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}
Respuesta del cuerpo
1 { 2 "links": [ 3 { 4 "href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pageNum=1&itemsPerPage=100", 5 "rel": "self" 6 } 7 ], 8 "results": [ 9 { 10 "hosts": [ 11 { 12 "groupId": "{projectId1}", 13 "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-7" 14 }, 15 { 16 "groupId": "{projectId1}", 17 "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-8" 18 } 19 ], 20 "id": "{physicalHostId1}", 21 "name": "physicalHostA", 22 "serverType": "DEV_SERVER" 23 }, 24 { 25 "hosts": [ 26 { 27 "groupId": "{projectId2}", 28 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0" 29 }, 30 { 31 "groupId": "{projectId2}", 32 "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1" 33 } 34 ], 35 "id": "{physicalHostId2}", 36 "name": "physicalHostB", 37 "serverType": "DEV_SERVER" 38 }, 39 ], 40 "totalCount": 2 41 }