Adicionar entradas a uma lista de acesso
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 .
URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
POST /users/{USER-ID}/accessList
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. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
pageNum | número | Opcional | Um inteiro baseado que retorna uma subseção de resultados. | 1 |
itemsPerPage | número | Opcional | Número de itens a serem devolvidos por página, até um máximo de 500. | 100 |
pretty | booleano | Opcional | Sinalizador que indica 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 do 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 uma lista de resultados, o objeto | false |
backupJobsEnabledOnly | booleano | Opcional | Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false. | true |
Parâmetros do corpo da solicitação
O corpo da solicitação deve ser uma array de entidades da lista de acesso, mesmo que haja apenas uma. O único campo que você precisa especificar para cada objeto de solicitação é o IP-ADDRESS.
Se um endereço IP já estiver na lista de acesso, ele será ignorado.
Se você especificar um único endereço IP com a máscara de sub-rede /32 , o Cloud Manager não armazenará o /32, pois o /32 não alterará o endereço.
Exemplo
Um endereço de 12.34.56.78 é o mesmo que 12.34.56.78/32.
Parâmetro | Tipo | Descrição |
|---|---|---|
ipAddress | string | (Obrigatório.) O endereço IP ou bloco CIDR que você deseja adicionar à lista de acesso do usuário especificado. |
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 | array | A array inclui um objeto para cada item detalhado na seção Documento incorporado results . |
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 lista de acesso.
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' \ --header 'Content-Type: application/json' \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList" --data ' [ { "ipAddress" : "192.0.1.15", "comment" : "IP address for Application Server A" }, { "cidrBlock" : "192.0.2.0/24", "comment" : "CIDR block for Application Server B - D" } ]'
Exemplo de resposta
Cabeçalho de resposta
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
201 Created 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
{ "totalCount" : 3, "results" : [ { "cidrBlock" : "12.34.56.78/32", "ipAddress" : "12.34.56.78", "created" : "2014-04-23T16:17:44Z", "lastUsed" : "2016-08-17T19:34:05Z", "lastUsedAddress" : "12.34.56.78", "count" : 0, "links" : [] }, { "cidrBlock" : "76.54.32.10/32", "ipAddress" : "76.54.32.10", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] }, { "cidrBlock" : "2.3.4.5/32", "ipAddress" : "2.3.4.5", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] } ], "links" : [] }