/ /

/ /

Gerente de Operaciones

Agregar entradas a una lista de acceso

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 Obtén todos los usuarios en un proyecto.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.	`false`
envelope	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 `envelope : true` en la consulta. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

Parámetros del cuerpo de la solicitud

El cuerpo de la solicitud debe ser un arreglo de entidades de la lista de accesos, incluso si sólo hay una. El único campo que debes 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 se especifica una única dirección IP con la máscara de subred /32, Ops Manager no almacena la /32, ya que la /32 no cambia la dirección.

Ejemplo

Una dirección de 12.34.56.78 es igual que 12.34.56.78/32.

Parameter	Tipo	Descripción
Dirección IP	string	(Obligatorio). La dirección IP o el bloque CIDR que quieres 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
`results`	arreglo	El arreglo incluye un objeto para cada elemento detallado en la sección del `results` documento incrustado.
`links`	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.
`totalCount`	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 resultado es una lista de acceso.

Nombre	Tipo	Descripción
`cidrBlock`	string	Un rango de direcciones IP con notación CIDR.
`created`	fecha	La fecha en que se agregó esta dirección IP a la lista de acceso.
`ipAddress`	string	Una dirección IP en la lista de acceso.
`lastUsed`	fecha	La fecha de la solicitud más reciente que se originó desde esta dirección IP. Deben tenerse en cuenta que este campo solo se actualiza cuando se accede a un recurso protegido por la lista de acceso.
`lastUsedAddress`	string	La dirección desde la que se emitió la última llamada a la API.
`count`	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.
`links`	arreglo	Enlaces a subrecursos relacionados. Todos los arreglos de enlaces en las respuestas contienen al menos un enlace llamado `self`. Las relaciones entre las URL se explican en la Especificación de vinculación de la web.

Solicitud de ejemplo

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"
      }
    ]'

Respuesta de ejemplo

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 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}

Respuesta del cuerpo

{
  "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" : []
}

Volver

Obtener para dirección IP

Eliminar entrada

Resource

Parámetros de la ruta de solicitud

Parámetros de Solicitud Query

Parámetros del cuerpo de la solicitud

Ejemplo

Respuesta

Documento de respuesta

results embeddedDocument

Solicitud de ejemplo

Respuesta de ejemplo

Encabezado de respuesta

Respuesta del cuerpo

`results` embeddedDocument