Criar uma chave de API do agente
Nesta página
O MongoDB Ops Manager v6.0 será EOL em janeiro 2025. Atualize para uma versão superior do MongoDB Ops Manager o mais rápido possível.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/agentapikeys
Este endpoint é restrito a usuários com a função Project Owner .
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
ID do projeto | string | Identificador exclusivo doprojeto que possui a chave de API do agente. |
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 da 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
Nome | Tipo | Descrição |
|---|---|---|
desc | string | Etiqueta para esta chave de API do agente. |
Resposta
Nome | Tipo | Descrição |
|---|---|---|
id | string | Identificador exclusivo desta chave de API do agente. |
chave | string | chave de API do agente. Depois de criar essa chave de API do agente, as solicitações subsequentes retornam os últimos quatro caracteres das chaves de API do agente. |
desc | string | Etiqueta para esta chave de API do agente. Limitado a 1.000 caracteres. |
createdTime | string | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a chave de API do agente foi criada. |
createdUserId | string | Identificador exclusivo do usuário que criou essa chave de API do agente. |
createdIpAddr | string | Endereço IP que criou essa chave de API do agente. |
createdBy | string | Fonte desta chave de API do agente. Os valores aceitos são:
|
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?pretty=true" \ --data ' { "desc": "Agent API Key for this project" }'
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
{ "_id" : "{AGENT-API-KEY-ID}", "createdBy" : "PUBLIC_API", "createdIpAddr" : "{IP-ADDRESS}", "createdTime" : 1520458807291, "createdUserId" : "{USER-ID}", "desc" : "Agent API Key for this project", "key" : "{AGENT-API-KEY}" }