Obter lista de acesso para um endereço IP

Nesta página

Resource

Resposta
Exemplo de solicitação
Exemplo de resposta

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

Recupera uma entidade de lista de acesso se o valor de IP-ADDRESS for igual ao valor do campo ipAddress da entidade. Isso não recupera um objeto cujo valor de IP-ADDRESS está contido dentro dos valores permitidos pelo campo cidrBlock .

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /users/{USER-ID}/accessList/{ACCESS-LIST-ENTRY}

Parâmetros do caminho da solicitação

Parâmetro	Tipo	Descrição
ID DE USUÁRIO	string	(Obrigatório.) Identificador único do usuário atual. Para recuperar o ID do usuário atual, consulte Obter todos os usuários em um projeto.
`ACCESS-LIST-ENTRY`	string	O endereço IP ouCIDR do . Se a entrada incluir uma máscara de sub-rede, como `192.0.2.0/24`, use o valor codificado em URL `%2F` para a barra `/`.

Solicitar parâmetros de query

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

Nome

Tipo

necessidade

Descrição

Default

pretty

booleano

Opcional

Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

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
`content`	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

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

Resposta

Nome	Tipo	Descrição
`cidrBlock`	string	Uma faixa de endereços IP com notação CIDR.
`created`	data	A data em que esse endereço IP foi adicionado à lista de acesso.
`ipAddress`	string	Um endereço IP na lista de acesso.
`lastUsed`	data	A data da solicitação mais recente originada desse endereço IP. Observe que esse campo só é atualizado quando um recurso protegido pela lista de acesso é acessado.
`lastUsedAddress`	string	O endereço do qual foi emitida a última chamada para a API.
`count`	número	O número total de solicitações originadas deste endereço IP. Observe que esse campo só é atualizado quando um recurso protegido pela lista de acesso é acessado.
`links`	array	Links para sub-recursos relacionados. Todas as arrays de links em respostas contêm pelo menos um link chamado `self`. As relações entre URLs são explicadas na Especificação de links da web.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList/192.0.2.0%2F24"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList/?pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "cidrBlock": "192.0.2.0/24",
      "count": 0,
      "created": "2019-11-01T15:18:12Z",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList/192.0.2.0%2F24",
          "rel": "self"
        }
      ]
    },
  ],
  "totalCount": 1
}

Voltar

Obter para o usuário atual

Adicionar entradas