Atualizar uma entrada da lista de acesso 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
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

Atualize os valores de uma entrada da lista de acesso global usando o identificador exclusivo para o endereço IP desejado.

Para encontrar uma entrada específica da lista de acesso global, obtenha a lista de entradas da lista de acesso global e encontre o {ACCESS-LIST-ID} que você precisa.

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

Resource

PATCH /admin/accessList/{ACCESS-LIST-ID}

Funções obrigatórias

Requer que a chave deAPI que chama esse endpoint tenha a role Global Owner .

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
`ACCESS-LIST-ID`	string	Identificador exclusivo para a entrada da lista de acesso global.

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:

Nome	Descrição
`status`	Código de resposta HTTP
`content`	Corpo de resposta esperado

false

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
`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 "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2   --header "Accept: application/json" \
3   --header "Content-Type: application/json" \
4   --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList/{ACCESS-LIST-ID}?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

1 {
2   "cidrBlock" : "127.0.0.1/32",
3   "created" : "2019-09-04T17:45:33Z",
4   "description" : "Docs Example",
5   "expires" : null,
6   "id" : "{ACCESS-LIST-ID}",
7   "lastUsed" : null,
8   "type" : "GLOBAL_ROLE",
9   "updated" : "2019-09-04T17:45:33Z"
10 }

Voltar

Criar entrada

Excluir entrada

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList/{ACCESS-LIST-ID}?pretty=true"

1	{
2	"cidrBlock" : "127.0.0.1/32",
3	"created" : "2019-09-04T17:45:33Z",
4	"description" : "Docs Example",
5	"expires" : null,
6	"id" : "{ACCESS-LIST-ID}",
7	"lastUsed" : null,
8	"type" : "GLOBAL_ROLE",
9	"updated" : "2019-09-04T17:45:33Z"
10	}