Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs
Página inicial do Docs
/ /
Listas de acesso
Página inicial do Docs
/ /
Chaves de API programáticas
/
Listas de acesso
Página inicial do Docs
/
Gestão
/
Cloud Manager
/
Recursos
/
Chaves de API programáticas
/
Listas de acesso

Obter todas as entradas da lista de acesso para uma chave de API da organização

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

Recupere informações sobre todas as entradas da lista de acesso para a chave de API especificada.

Resource

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição

ORG-ID

string

Identificador exclusivo da organização à qual pertence a chave API de destino. Solicite ao endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.

API-KEY-ID

string

Unique identifier for the API Key for which you want to retrieve access list entries. Request the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys for the specified organization to which the authenticated user has access.

Solicitar parâmetros de query

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

Nome
Tipo
Descrição
Default

pageNum

inteiro

Número da página (com base em índice 1).

1

itemsPerPage

inteiro

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Indica se o corpo da resposta deve estar em formato prettyprint.

false

envelope

booleano

Indica se deseja ou não envolver a resposta em um envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set "envelope" : true in the 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

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Cloud Manager adiciona o campo status ao corpo da resposta.

none

Parâmetros do corpo da solicitação

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

Resposta

documento de resposta

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Nome
Tipo
Descrição

results

array

A array inclui um objeto para cada item detalhado na seção results Documento incorporado.

links

array

A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.

totalCount

número

Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

results documento incorporado

Cada resultado é uma entrada da lista de acesso.

Nome
Tipo
Descrição

cidrBlock

string

Faixa de endereços IP com notação CIDR na lista de acesso.

count

número

Número total de solicitações originadas deste endereço IP.

created

data

Data em que este endereço IP foi adicionado à lista de acesso.

ipAddress

string

Endereço IP na lista de acesso.

lastUsed

data

Data da solicitação mais recente originada deste endereço IP. Esse campo só aparece se pelo menos uma solicitação tiver sido originada desse endereço IP e só é atualizado quando um recurso é recuperado da lista de acesso.

lastUsedAddress

string

Endereço IP do qual foi emitida a última chamada para a API. Este campo só aparece se pelo menos uma solicitação tiver sido originada deste endereço IP.

links

array

Uma array de documentos, representando um link para um ou mais sub-recursos e/ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true"

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

1{
2  "links" : [ {
3  "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/599c510c80eef518f3b63fe1/apiKeys/5c49e72980eef544a218f8f8/accessList/?pretty=true&pageNum=1&itemsPerPage=100",
4  "rel" : "self"
5  } ],
6  "results" : [ {
7    "cidrBlock" : "147.58.184.16/32",
8    "count" : 0,
9    "created" : "2019-01-24T16:34:57Z",
10    "ipAddress" : "147.58.184.16",
11    "lastUsed" : "2019-01-24T20:18:25Z",
12    "lastUsedAddress": "147.58.184.16",
13    "links" : [ {
14      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/147.58.184.16",
15      "rel" : "self"
16    } ]
17  }, {
18    "cidrBlock" : "84.255.48.125/32",
19    "count" : 0,
20    "created" : "2019-01-24T16:26:37Z",
21    "ipAddress" : null,
22    "lastUsed" : "2019-01-24T20:18:25Z",
23    "lastUsedAddress": "84.255.48.125",
24    "links" : [ {
25      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126",
26      "rel" : "self"
27    } ]
28  } ],
29  "totalCount" : 2
30}
Voltar
criar
Próximo
Pegue um
Avalie esta página

Nesta página