/ /

/ /

Gerente de Operaciones

API

Recursos

Uso del servidor

Crear un host físico

Roles necesarios

Este recurso requiere el Clave API para tener la Global Owner role.

Resource

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /usage/groups

Parámetros de la ruta de solicitud

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Descripción

predeterminado

número de página

entero

Número de página (basado en el índice 1).

1

artículos por página

entero

Número de artículos a devolver por página, hasta un máximo de 500.

100

bonita

booleano

Indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

booleano

Indica si se debe envolver o no 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 "envelope" : true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

Para los puntos finales que devuelven una lista de resultados, el objeto results es un sobre. Ops Manager añade el campo status al cuerpo de la respuesta.

Ninguno

Parámetros del cuerpo de la solicitud

Body Parameter	Tipo	Necesidad	Descripción
hosts virtuales	matriz de cadenas	Requerido	Lista de hosts virtuales vinculados al host físico proporcionado.
virtualHosts .groupId	string	Opcional	Identificador único del proyecto en el que Ops Manager coloca este host virtual.
virtualHosts .hostname	string	Opcional	FQDN del host virtual vinculado al host físico.
Nombre	string	Requerido	Etiqueta que asignaste al host físico. Este valor debe ser único.
tipo de servidor	string	Requerido	Tipo de servidor del host físico. Puede configurarlo con uno de los siguientes valores: `DEV_SERVER` `TEST_SERVER` `PRODUCTION_SERVER` `RAM_POOL` Para obtener más información, consulte la página de uso de MongoDB.

Respuesta

Elemento de respuesta	Tipo	Descripción
Hospedadores	matriz 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 coloca 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 le diste al host físico.
tipo de servidor	string	Tipo de servidor del host físico. Ops Manager devuelve uno de los siguientes valores: DEV_SERVER TEST_SERVER SERVIDOR DE PRODUCCIÓN RAM_POOL Para obtener más información, consulte la página de uso de MongoDB.

Ejemplo de solicitud

1 curl --user "{publicApiKey}:{privateApiKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \
6      --data '{
7                "name": "physicalHostA",
8                "serverType":
9                  {
10                    "name": "PRODUCTION_SERVER",
11                    "label": "Production Server",
12                  },
13                "virtualHosts": [
14                  {
15                    "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
16                    "groupId": "{groupId}"
17                  }
18                ]
19              }'

Ejemplo de respuesta

Encabezado de respuesta

HTTP/1.1 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

HTTP/1.1 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}

Cuerpo de respuesta

1 {
2   "hosts": [
3     {
4       "groupId": "{groupId}",
5       "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
6     }
7   ],
8   "id": "{physicalHostID}",
9   "name": "physicalHostA",
10   "serverType":
11     {
12       "name": "PRODUCTION_SERVER",
13       "label": "Production Server",
14     },
15 }

Volver

Recuperar un host físico

Actualizar el host físico

1	curl --user "{publicApiKey}:{privateApiKey}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \
6	--data '{
7	"name": "physicalHostA",
8	"serverType":
9	{
10	"name": "PRODUCTION_SERVER",
11	"label": "Production Server",
12	},
13	"virtualHosts": [
14	{
15	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
16	"groupId": "{groupId}"
17	}
18	]
19	}'

1	{
2	"hosts": [
3	{
4	"groupId": "{groupId}",
5	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
6	}
7	],
8	"id": "{physicalHostID}",
9	"name": "physicalHostA",
10	"serverType":
11	{
12	"name": "PRODUCTION_SERVER",
13	"label": "Production Server",
14	},
15	}