Menu Docs

Página inicial do DocsMongoDB Ops Manager

Obter uma entrada da lista de acesso global

Nesta página

  • Recurso
  • Funções obrigatórias
  • Parâmetros da solicitação
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Elementos de resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Retorne uma entrada da lista de acesso global usando o identificador exclusivo para o endereço IP desejado.

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

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

Requer que a chave deAPI que chama esse endpoint tenha a role Global Read Only .

Nome
Tipo
Descrição
ACCESS-LIST-ID
string
Identificador exclusivo para a entrada da lista de acesso global.

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
default
pretty
boleano
Opcional
Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.
false
envelope
boleano
Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição
Status
Código de resposta HTTP
envelope
Corpo de resposta esperado
false

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Nome
Tipo
Descrição
cidrBlock
string
Faixa de endereços IP em uma lista de acesso em notação CIDR IPv4 ou IPv6 .
created
string
Registro de data/hora, em segundos decorridos desde a UNIX epoch quando você adicionou este bloco CIDR à Lista de acesso global.
description
string
Explicação do propósito desta entrada da lista de acesso global.
id
string
Identificador exclusivo para esta entrada da lista de acesso global.
type
string
Escopo da entrada da lista de acesso global.
updated
string
Registro de data/hora, em segundos decorridos desde a UNIX epoch quando você alterou pela última vez o bloco CIDR desta entrada da lista de acesso global.
1curl --user "{USERNAME}:{APIKEY}" --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"
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}
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}
← Obter todas as entradas da lista de acesso para uma chave de API global