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 clave API que llama a este punto final tiene la
Global Read Only role.
Request Parameters
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 | 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 un impresión bonita formato. |
|
envolvente | 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 puntos finales que devuelven una lista de resultados, el objeto |
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la 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 | 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 entrada de la lista de acceso global.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Rango de direcciones IP en una lista de acceso en notación CIDR IPv4 o IPv.6 |
| string | Marca de tiempo, en la cantidad de segundos que han transcurrido desde la época UNIX en que agregó este bloque CIDR a la Lista de acceso global. |
| string | Explicación del propósito de esta entrada de lista de acceso global. |
| string | Identificador único para esta entrada de lista de acceso global. |
| string | Alcance de la entrada de la lista de acceso global. |
| string | Marca de tiempo, en la cantidad de segundos que han transcurrido desde la época UNIX en la que modificó por última vez el bloque CIDR de esta entrada de lista de acceso global. |
Ejemplo de solicitud
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"
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
{ "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 }