Chaves SSH

Esta versão da documentação foi arquivada e não é mais suportada. Consulte a documentação atual do para saber como atualizar sua versão do MongoDB Ops Manager.

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.

O recurso sshKeys exibe as chaves públicas disponíveis para escolha quando você provisiona servidores por meio da integração MongoDB Ops Manager com um provedor de serviços de nuvem. Quando você provisiona um novo servidor, o MongoDB Ops Manager adiciona a chave pública à lista de chaves autorizadas do servidor. Você deve ter a chave privada correspondente para fazer login no servidor provisionado.

Para mais informações sobre a integração MongoDB Ops Manager com provedores de serviço de nuvem, consulte Servidores de provisionamento.

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

Endpoints

Obtenha todas as chaves SSH para o projeto

GET /groups/{PROJECT-ID}/sshKeys

Obter uma chave SSH por ID

GET /groups/{PROJECT-ID}/sshKeys/KEY-ID

Obter uma chave SSH por nome

GET /groups/{PROJECT-ID}/sshKeys/byName/KEY-NAME

Adicionar uma chave SSH

POST /groups/{PROJECT-ID}/sshKeys

Excluir uma chave SSH

DELETE /groups/{PROJECT-ID}/sshKeys/KEY-ID

Entidade de amostra

{
  "id" : "545e3e3ae4b08a04fbc21005",
  "name" : "myKey",
  "publicKey" : "<ssh-key>",
  "links" : []
}

Campos da entidade

Nome	Tipo	Descrição
id	string	Identificador único.
name	string	O nome da chave pública como aparece no MongoDB Ops Manager Provisioning Settings. Para obter mais informações sobre provisionamento, consulte Servidores de provisionamento.
publicKey	string	O conteúdo da chave pública.

links

Relação	Descrição
auto	Eu
`http://mms.mongodb.com/group`	O projeto ao qual a chave SSH pertence

Exemplos

Obter todas as chaves SSH

Solicitar

curl -u "username:apiKey" --digest -i "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/sshKeys"

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

{
  "totalCount" : 1,
  "results" : [ {
    "id" : "545e3e3ae4b08a04fbc21005",
    "name" : "myKey",
    "publicKey" : "<ssh-key>",
    "links" : []
  }, { ...} ],
  "links" : []
}

Obter uma chave SSH por ID

Solicitar

curl -u "username:apiKey" --digest -i "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/sshKeys/545e3e3ae4b08a04fbc21005"

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

{
  "id" : "545e3e3ae4b08a04fbc21005",
  "name" : "myKey",
  "publicKey" : "<ssh-key>",
  "links" : []
}

Adicionar uma chave SSH

Solicitar

curl -u "username:apiKey" --digest -i -H "Content-Type: application/json" -X POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/sshKeys" --data '
{
  "name" : "myKey",
  "publicKey" : "<ssh-key>"
}'

Resposta

HTTP/1.1 201 Created
{
  "id" : "54c7a8bee4b0b5a9451be44e",
  "name" : "myKey",
  "publicKey" : "<ssh-key>",
  "links" : []
}

Excluir uma chave SSH

Solicitar

curl -u "username:apiKey" --digest -i -X DELETE "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/sshKeys/545e3e3ae4b08a04fbc21005"

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}

Este endpoint não retorna um corpo de resposta.

MongoDB Ops Manager