Página inicial do Docs → MongoDB Ops Manager

Obter todas as funções para chaves de API globais

Nesta página

Recurso

Funções obrigatórias
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

Retorne uma lista de roles globais aceitáveis para chaves deAPI globais.

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

Recurso

GET /admin/apiKeys/roles

Funções obrigatórias

Exige que a chave de API que chama esse endpoint tenha a role 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

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

Resposta

Retorna uma matriz de todas as funções globais aceitáveis para as chaves de API globais.

Exemplo de solicitação

Observação

O usuário que faz a solicitação pode ser formatado como {USERNAME}:{APIKEY} ou {PUBLIC-KEY}:{PRIVATE-KEY}.

1 curl --user "{USERNAME}:{APIKEY}" --digest \
2      --header "Accept: application/json" \
3      --include \
4      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/roles?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   [
3     "GLOBAL_BACKUP_ADMIN",
4     "GLOBAL_BILLING_ADMIN",
5     "GLOBAL_MONITORING_ADMIN",
6     "GLOBAL_READ_ONLY",
7     "GLOBAL_AUTOMATION_ADMIN",
8     "GLOBAL_USER_ADMIN"
9   ]
10 }

← Obter todas as chaves de API globais

Obter uma chave de API global →

1	curl --user "{USERNAME}:{APIKEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/roles?pretty=true"

1	{
2	[
3	"GLOBAL_BACKUP_ADMIN",
4	"GLOBAL_BILLING_ADMIN",
5	"GLOBAL_MONITORING_ADMIN",
6	"GLOBAL_READ_ONLY",
7	"GLOBAL_AUTOMATION_ADMIN",
8	"GLOBAL_USER_ADMIN"
9	]
10	}