URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /users/{USER-ID}/accessList
Parámetros de la ruta de solicitud
Parameter | Tipo | Descripción |
|---|---|---|
ID DE USUARIO | string | (Obligatorio) Identificador único del usuario actual. Para obtener el ID del usuario actual, consulte Obtenga todos los usuarios en un proyecto. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
número de página | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
artículos por página | Número | Opcional | Número de artículos a devolver por página, hasta un máximo de 500. |
|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
|
envolvente | booleano | Opcional | Bandera que 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 puntos finales que devuelven una lista de resultados, el objeto |
|
trabajos de respaldo habilitados solamente | booleano | Opcional | Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en |
|
Parámetros del cuerpo de la solicitud
El cuerpo de la solicitud debe ser una matriz de entidades de lista de acceso, incluso si solo hay una. El único campo que debe especificar para cada objeto de solicitud es la dirección IP.
Si una dirección IP ya está en la lista de acceso, será ignorada.
Si especifica una única dirección IP con la máscara de subred /32, Ops Manager no almacena /32, ya que /32 no cambia la dirección.
Ejemplo
Una dirección de 12.34.56.78 es la misma que 12.34.56.78/32.
Parameter | Tipo | Descripción |
|---|---|---|
dirección IP | string | (Obligatorio) La dirección IP o el bloque CIDR que desea agregar a la lista de acceso del usuario especificado. |
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 resultado es una lista de acceso.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Un rango de direcciones IP anotadas en CIDR. |
| fecha | La fecha en que se agregó esta dirección IP a la lista de acceso. |
| string | Una dirección IP en la lista de acceso. |
| fecha | La fecha de la solicitud más reciente originada desde esta dirección IP. Tenga en cuenta que este campo solo se actualiza cuando se accede a un recurso protegido por la lista de acceso. |
| string | La dirección desde la que se emitió la última llamada a la API. |
| Número | Número total de solicitudes originadas desde esta dirección IP. Tenga en cuenta que este campo solo se actualiza cuando se accede a un recurso protegido por la lista de acceso. |
| arreglo | Enlaces a subrecursos relacionados. Todas las matrices de enlaces en las respuestas contienen al menos un enlace |
Ejemplo de solicitud
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/users/{USER-ID}/accessList" --data ' [ { "ipAddress" : "192.0.1.15", "comment" : "IP address for Application Server A" }, { "cidrBlock" : "192.0.2.0/24", "comment" : "CIDR block for Application Server B - D" } ]'
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
201 Created 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
{ "totalCount" : 3, "results" : [ { "cidrBlock" : "12.34.56.78/32", "ipAddress" : "12.34.56.78", "created" : "2014-04-23T16:17:44Z", "lastUsed" : "2016-08-17T19:34:05Z", "lastUsedAddress" : "12.34.56.78", "count" : 0, "links" : [] }, { "cidrBlock" : "76.54.32.10/32", "ipAddress" : "76.54.32.10", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] }, { "cidrBlock" : "2.3.4.5/32", "ipAddress" : "2.3.4.5", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] } ], "links" : [] }