Devolver todas las entradas de la Lista de Acceso Global para Ops Manager.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/accessList
Roles necesarios
Requiere que el La API Key que llama a este endpoint tiene la
Global Read Only role.
Request Parameters
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 | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
Num. de pág. | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver 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 endpoints que devuelven una lista de resultados, el objeto |
|
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 resultado es una entrada de la lista de acceso global.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Rango de direcciones IP en una lista de acceso en notación IPv4 o IPv6 CIDR. |
| string | Marca de tiempo, en la cantidad de segundos que han transcurrido desde la Unix epoch cuando agregaste este bloque CIDR a la Lista Global de Acceso. |
| string | Explicación del propósito de esta entrada de la lista de acceso global. |
| string | Identificador único de esta entrada de la lista de acceso global. |
| string | Alcance de la entrada de la lista de acceso global. |
| string | Marca de tiempo, en número de segundos transcurridos desde la Unix epoch cuando cambiaste por última vez el bloque CIDR de esta entrada de lista de acceso global. |
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList?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
{ "results" : [ { "cidrBlock" : "251.207.34.78/32", "created" : "2019-09-05T04:02:46Z", "description" : "Test Global Access List Entry 1", "id" : "5d4d7b9cf20ce440466a30bd", "type" : "GLOBAL_ROLE", "updated" : "2019-09-05T04:02:46Z" }, { "cidrBlock" : "2001:db8::/48", "created" : "2019-09-05T04:02:46Z", "description" : "Test Global Access List Entry 2", "id" : "5d6fe33787d9d6689b3427ec", "type" : "GLOBAL_ROLE", "updated" : "2019-09-05T04:02:46Z" } ] "totalCount" : 2 }