Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Obter todas as chaves de API globais

Retornar todas as chaves de API globais para o Ops Manager.

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

GET /admin/apiKeys

Exige que a API Key chamando este ponto de extremidade tenha o Global Read Only função.

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

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 formato de impressão bonita.

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 content é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

false

O documento JSON de resposta inclui uma array de objetos de result, uma array de objetos de link e uma contagem do número total de objetos de 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.

Cada resultado é uma chave de API.

Nome
Tipo
Descrição

desc

string

Descrição desta chave de API global.

id

string

Identificador exclusivo para esta chave de API global.

links

string

Um array de documentos que representa um link para um ou mais sub-recursos ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações.

privateKey

string

Chave privada editada para esta chave de API global.

publicKey

string

Chave pública para esta chave de API global.

roles

array de objetos

Funções que esta chave de API global tem. Essa matriz retorna todos os roles globais que o usuário tem no Ops Manager.

roles.roleName

string

Nome da função. Esse recurso retorna todos os roles que o usuário tem no Ops Manager. Os valores possíveis são:

Observação

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true"
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "desc" : "Test Global API Key 1", "id" : "5d669ce780eef52a42cf0e1e", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e", "rel" : "self" } ], "privateKey" : "********-****-****-54d9792d337d", "publicKey" : "zrefxaep", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_BILLING_ADMIN" } ] }, { "desc" : "Test Global API Key 2", "id" : "5d6fec4180eef54728814b14", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14", "rel" : "self" } ], "privateKey" : "********-****-****-fe646723a586", "publicKey" : "qlgofmne", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" } ] }, { "desc" : "Test Global API Key 3", "id" : "5d6fecfc80eef547288207f3", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3", "rel" : "self" } ], "privateKey" : "********-****-****-fe348ed1796f", "publicKey" : "cfswjfck", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_BILLING_ADMIN" }, { "roleName" : "GLOBAL_USER_ADMIN" } ] } ], "totalCount" : 3}