Menu Docs
Página inicial do Docs
/ /
Chaves de API globais
Página inicial do Docs
/ /
Chaves de API programáticas
/
Chaves de API globais
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Chaves de API programáticas
/
Chaves de API globais

Obter uma chave de API global

Retorne uma chave deAPI global para o Ops Manager usando o identificador exclusivo para essa chave.

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

Resource

GET /admin/apiKeys/{API-KEY-ID}

Funções obrigatórias

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

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição

API-KEY-ID

string

Identificador único da chave de API global que você deseja recuperar.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

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, 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

envelope

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

Elementos de resposta

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

Uma array de documentos, representando um link para um ou mais sub-recursos e/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:

Valor da função na API
Função

GLOBAL_AUTOMATION_ADMIN

Global Automation Admin

GLOBAL_BACKUP_ADMIN

Global Backup Admin

GLOBAL_MONITORING_ADMIN

Global Monitoring Admin

GLOBAL_OWNER

Global Owner

GLOBAL_READ_ONLY

Global Read Only

GLOBAL_USER_ADMIN

Global User Admin

Exemplo de solicitação

1curl --user "{USERNAME}:{APIKEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-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  "desc" : "Test Global API Key 1",
3  "id" : "{API-KEY-ID}",
4  "links" : [ {
5    "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY-ID}",
6    "rel" : "self"
7  } ],
8  "privateKey" : "********-****-****-54d9792d337d",
9  "publicKey" : "zrefxaep",
10  "roles" : [ {
11    "roleName" : "GLOBAL_READ_ONLY"
12  }, {
13    "roleName" : "GLOBAL_BILLING_ADMIN"
14  } ]
15}

Voltar

Obter todas as funções

Próximo

criar

Nesta página