Todas las solicitudes a este punto final deben provenir de una dirección IP de la lista de acceso a la API del usuario de Ops Manager. Para obtener la documentación completa sobre la configuración de las listas de acceso a la API, consulte Solicite una lista de acceso API para su organización.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Cree una o más nuevas entradas de lista de acceso para la clave API especificada.
Resource
POST /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único de la organización a la que va dirigido el mensaje Pertenece la clave API. Utilice el punto final /orgs para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
| string | Identificador único de la clave API de la organización para la que desea crear una nueva entrada de lista de acceso. |
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). |
| ||||
artículos por página | entero | Número de artículos a devolver por página, hasta un máximo de 500. |
| ||||
bonita | booleano | Indica si el cuerpo de la respuesta debe estar en formato prettyprint. formato. |
| ||||
envolvente | booleano | Indica si se debe envolver o no la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
Para los puntos finales que devuelven una lista de resultados, el objeto | Ninguno |
Parámetros del cuerpo de la solicitud
Especifique una matriz de documentos, donde cada documento representa una entrada de la lista de acceso que desea agregar al proyecto. Debe especificar una matriz incluso si solo asocia una entrada de la lista de acceso al proyecto.
Cuando se envía una solicitud POST que contiene los valores ipAddress o cidrBlock que aún no están presentes en la lista de acceso, Ops Manager agrega esas entradas a la lista de entradas existentes en la lista de acceso. Ops Manager no configura la lista de acceso para que sólo contenga las entradas especificadas en la solicitud.
Nota
Ops Manager admite hasta 500 API en una sola organización.
En la siguiente tabla, [i] representa un índice de matriz.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Dirección IP que se añadirá a la lista de acceso para la clave API. Este campo es mutuamente excluyente con el campo |
| string | Entrada de lista de acceso en notación CIDR que se añadirá para la clave API. Este campo es excluyente con el campo |
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 | La matriz incluye un objeto para cada elemento detallado en la |
| arreglo | La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web. |
| Número | Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado. |
results Documento incrustado
Cada objeto dentro de la matriz results es una entrada de la lista de acceso.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Rango de direcciones IP anotadas en CIDR en la lista de acceso. |
| Número | Número total de solicitudes que se originaron desde esta dirección IP. |
| fecha | Fecha en que se agregó esta dirección IP a la lista de acceso. |
| string | Dirección IP en la lista de acceso. |
| fecha | Fecha de la solicitud más reciente originada desde esta dirección IP. Este campo solo aparece si al menos una solicitud se originó desde esta dirección IP y se actualiza únicamente cuando se recupera un recurso de la lista de acceso. |
| string | Dirección IP desde la que se realizó la última llamada a la API. Este campo solo aparece si al menos una solicitud se originó desde esta dirección IP. |
| arreglo | Una matriz de documentos que representa un enlace a uno o más subrecursos o recursos relacionados, como la paginación de listas. Consulte Enlaces para obtener más información. |
Ejemplo de solicitud
1 curl --user '{USER-ID}:{API-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true" \ 6 --data ' 7 [{ 8 "ipAddress" : "77.54.32.11" 9 }]'
Ejemplo de respuesta
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}
Cuerpo de respuesta
1 { 2 "links" : [ { 3 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "cidrBlock" : "206.252.195.126/32", 8 "count" : 47, 9 "created" : "2019-01-24T16:26:37Z", 10 "ipAddress" : "206.252.195.126", 11 "lastUsed" : "2019-01-25T16:32:47Z", 12 "lastUsedAddress" : "206.252.195.126", 13 "links" : [ { 14 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126", 15 "rel" : "self" 16 } ] 17 }, { 18 "cidrBlock" : "76.54.32.11/32", 19 "count" : 0, 20 "created" : "2019-01-24T21:09:05Z", 21 "ipAddress" : null, 22 "links" : [ { 23 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/76.54.32.11", 24 "rel" : "self" 25 } ] 26 } ], 27 "totalCount" : 2 28 }