Criar uma entrada na lista de acesso global
Nesta página
Crie uma entrada na lista de acesso global para o Ops Manager.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /admin/accessList
Funções obrigatórias
Requer que a chave deAPI que chama esse endpoint tenha a função Global Owner .
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 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando 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, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
| false |
Parâmetros do corpo da solicitação
Especifique um documento que represente uma entrada da lista de acesso que você deseja adicionar.
Quando você envia uma solicitação POST contendo um valor cidrBlock que ainda não está presente 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.
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
description | string | Obrigatório | Descrição da entrada da lista de acesso global. Deve ter entre 1 e 250 caracteres. |
cidrBlock | string | Obrigatório | Entrada da lista de acesso na notação CIDR IPv4 ou IPv6 a ser adicionada. |
Resposta
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
1 curl --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/admin/accessList?pretty=true" \ 6 --data ' 7 { 8 "cidrBlock" : "127.0.0.1/32", 9 "description" : "Docs Example" 10 }'
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
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 "cidrBlock" : "127.0.0.1/32", 3 "created" : "2019-09-04T17:45:33Z", 4 "description" : "Docs Example", 5 "expires" : null, 6 "id" : "5d6ff83dff4ab7133648b584", 7 "lastUsed" : null, 8 "type" : "GLOBAL_ROLE", 9 "updated" : "2019-09-04T17:45:33Z" 10 }