Menu Docs

Página inicial do Docs → MongoDB Ops Manager

Criar entradas da lista de acesso para uma chave de API da organização

Nesta página

  • Recurso
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • documento de resposta
  • results documento incorporado
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Todas as solicitações para esse endpoint devem ser originadas de um endereço IP na lista de acesso à API do usuário do Ops Manager. Para obter a documentação completa sobre a configuração das listas de acesso à API, consulte Exigir uma lista de acesso à API para sua organização.

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

Crie uma ou mais novas entradas de lista de acesso para a chave API especificada.

Recurso

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

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição
ORG-ID
string
Identificador único para a organização à qual pertence a chave deAPI do destino. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.
API-KEY-ID
string
Identificador exclusivo da chave de API da organização para a qual você deseja criar uma nova entrada da lista de acesso.

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
boleano
Indica se o corpo da resposta deve estar em um prettyprint formato.
false
envelope
boleano

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, configure "envelope" : true na query.

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

Status
Código de resposta HTTP
envelope
Corpo de resposta esperado

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

none

Parâmetros do corpo da solicitação

Especifique uma matriz de documentos, onde cada documento representa uma entrada da lista de acesso que você deseja adicionar ao projeto. Você deve especificar uma matriz mesmo se estiver associando apenas uma única entrada da lista de acesso ao projeto.

Quando você envia uma solicitação de POST contendo valores ipAddress ou cidrBlock que ainda não estão presentes na lista de acesso, o Ops Manager adiciona essas entradas à lista de entradas existentes na lista de acesso. O Ops Manager não define a lista de acesso para conter apenas as entradas especificadas na solicitação.

Observação

O Ops Manager oferece suporte a até 500 chaves de API dentro de uma única organização.

Na tabela seguinte, [i] representa um índice de array.

Nome
Tipo
Descrição
[i].ipAddress
string
Endereço IP a ser adicionado à lista de acesso da chave de API. Este campo é mutuamente exclusivo com o campo cidrBlock .
[i].cidrBlock
string
Entrada da lista de acesso na notação CIDR a ser adicionada para a chave de API. Este campo é mutuamente exclusivo com o campo ipAddress .

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome
Tipo
Descrição
results
variedade
A array inclui um objeto para cada item detalhado na seção Documento incorporadoresults .
links
variedade
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 objeto na matriz results é 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
variedade
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

1curl --user '{USER-ID}:{API-KEY}' --digest \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json' \
4--include \
5--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true" \
6--data '
7  [{
8    "ipAddress" : "77.54.32.11"
9  }]'

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://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100",
4    "rel" : "self"
5  } ],
6  "results" : [ {
7    "cidrBlock" : "206.252.195.126/32",
8    "count" : 47,
9    "created" : "2019-01-24T16:26:37Z",
10    "ipAddress" : "206.252.195.126",
11    "lastUsed" : "2019-01-25T16:32:47Z",
12    "lastUsedAddress" : "206.252.195.126",
13    "links" : [ {
14      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126",
15      "rel" : "self"
16    } ]
17  }, {
18    "cidrBlock" : "76.54.32.11/32",
19    "count" : 0,
20    "created" : "2019-01-24T21:09:05Z",
21    "ipAddress" : null,
22    "links" : [ {
23      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/76.54.32.11",
24      "rel" : "self"
25    } ]
26  } ],
27  "totalCount" : 2
28}
← Obter uma entrada da lista de acesso para uma chave de API da organização
Excluir uma entrada da lista de acesso para uma chave de API →

Nesta página