Obter todas as entradas da lista de acesso para uma chave de API global

Nesta página

Resource

Funções obrigatórias
Parâmetros da solicitação
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

O MongoDB Ops Manager v6.0 será EOL em janeiro 2025. Atualize para uma versão superior do MongoDB Ops Manager o mais rápido possível.

Retornar todas as entradas da lista de acesso global para o Ops Manager.

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

Resource

GET /admin/accessList

Funções obrigatórias

Requer que a chave deAPI que chama esse endpoint tenha a função Global Read Only .

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

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 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 uma lista de resultados, o objeto `results` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	`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

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

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 `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 global.

Nome	Tipo	Descrição
`cidrBlock`	string	Faixa de endereços IP em uma lista de acesso em notação CIDR IPv4 ou IPv6 .
`created`	string	Registro de data/hora, em segundos decorridos desde a UNIX epoch quando você adicionou este bloco CIDR à Lista de acesso global.
`description`	string	Explicação do propósito desta entrada da lista de acesso global.
`id`	string	Identificador exclusivo para esta entrada da lista de acesso global.
`type`	string	Escopo da entrada da lista de acesso global.
`updated`	string	Registro de data/hora, em segundos decorridos desde a UNIX epoch quando você alterou pela última vez o bloco CIDR desta entrada da lista de acesso global.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/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

{
  "results" : [ {
    "cidrBlock" : "251.207.34.78/32",
    "created" : "2019-09-05T04:02:46Z",
    "description" : "Test Global Access List Entry 1",
    "id" : "5d4d7b9cf20ce440466a30bd",
    "type" : "GLOBAL_ROLE",
    "updated" : "2019-09-05T04:02:46Z"
  }, {
    "cidrBlock" : "2001:db8::/48",
    "created" : "2019-09-05T04:02:46Z",
    "description" : "Test Global Access List Entry 2",
    "id" : "5d6fe33787d9d6689b3427ec",
    "type" : "GLOBAL_ROLE",
    "updated" : "2019-09-05T04:02:46Z"
  } ]
  "totalCount" : 2
}

Voltar

Lista de acesso global

Obter uma entrada