Docs Home

/ /

Lista global de acceso

Docs Home

/ /

Claves de API programáticas

Lista global de acceso

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Claves de API programáticas

Lista global de acceso

Obtener una entrada de lista de acceso global

Devuelve una entrada de la lista de acceso global utilizando el identificador único para la dirección IP deseada.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /admin/accessList/{ACCESS-LIST-ID}

Roles necesarios

Requiere que la clave de API que llama a este endpoint tenga el rol de Global Read Only.

Request Parameters

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`ACCESS-LIST-ID`	string	Identificador único para la entrada de lista de acceso global.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que especifica si el cuerpo de la respuesta está en formato legible.	`false`
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 o al código de estado de la respuesta HTTP. Para resolver esto, establece envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye: `status`: Código de respuesta HTTP `content`: Cuerpo de respuesta esperado	`false`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Elementos de respuesta

Nombre	Tipo	Descripción
`cidrBlock`	string	Rango de direcciones IP en una lista de acceso en notación IPv4 o IPv6 CIDR.
`created`	string	Marca de tiempo, en el número de segundos que han transcurrido desde la Unix epoch cuando añadió este CIDR bloque a la Lista de Acceso Global.
`description`	string	Explicación del propósito de esta entrada de la lista de acceso global.
`id`	string	Identificador único de esta entrada de la lista de acceso global.
`type`	string	Alcance de la entrada de la lista de acceso global.
`updated`	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

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --include \
4      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList/{ACCESS-LIST-ID}?pretty=true"

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

1 {
2   "cidrBlock" : "73.73.45.150",
3   "created" : "2019-09-05T04:02:46Z",
4   "description" : "Test Global Access List Entry 1",
5   "id" : "5d6fe33787d9d6689b3427ec",
6   "type" : "GLOBAL_ROLE",
7   "updated" : "2019-09-05T04:02:46Z"
8 }

Volver

Obtener todas las entradas

Crear entrada

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList/{ACCESS-LIST-ID}?pretty=true"

1	{
2	"cidrBlock" : "73.73.45.150",
3	"created" : "2019-09-05T04:02:46Z",
4	"description" : "Test Global Access List Entry 1",
5	"id" : "5d6fe33787d9d6689b3427ec",
6	"type" : "GLOBAL_ROLE",
7	"updated" : "2019-09-05T04:02:46Z"
8	}