URL base: https://cloud.mongodb.com/api/public/v1.0
Recupere informações sobre uma única entrada da lista de acesso da chave de API usando o identificador exclusivo para a chave de API e o endereço IP desejado.
Resource
GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/{ACCESS-LIST-ENTRY}Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
| 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. |
| string | Identificador exclusivo da chave de API para a qual você deseja recuperar entradas da lista de acesso. Solicite ao ponto de extremidade /orgs/{ORG-ID}/apiKeys para recuperar todas as chaves API para a organização especificada a que o usuário autenticado tem acesso. |
| string | O IP ou endereço CIDR. Se a entrada incluir uma máscara de sub-rede, como |
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). |
|
itemsPerPage | inteiro | Número de itens a serem devolvidos por página, até um máximo de 500. |
|
pretty | booleano | Indica se o corpo da resposta deve ser retornado em um formato prettyprint. |
|
envelope | booleano | Indica se deve 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, configure Para endpoints que retornam um resultado, o corpo da resposta inclui:
Para endpoints que retornam uma lista de resultados, o objeto | none |
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 |
|---|---|---|
| string | Faixa de endereços IP com notação CIDR na lista de acesso. |
| número | Número total de solicitações originadas deste endereço IP. |
| data | Data em que este endereço IP foi adicionado à lista de acesso. |
| string | Endereço IP na lista de acesso. |
| 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. |
| 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. |
| 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/192.0.2.0%2F24?pretty=true"Exemplo de resposta
Cabeçalho de resposta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Corpo de resposta
{ "cidrBlock": "192.0.2.0/24", "count": 0, "created": "2019-11-01T14:44:44Z", "links": [ { "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24", "rel": "self" }, { "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}", "rel": "http://mms.mongodb.com/apiKeys" } ] }