Gerencie servidores de borda no Atlas - Visualizar

Navegue até a UI do Data Services

Quando você seleciona um projeto no painel do projeto da interface do usuário do Atlas , a guia Data Services é exibida por padrão.

Se você estiver em App Services ou Charts, selecione a guia Data Services .

Selecione Device & Edge Sync

Na barra lateral esquerda, navegue até a seção Services . Selecione Device & Edge Sync.

Criar um serviço

Selecione o tipo de serviço que deseja criar e siga as instruções para criar um Edge Server Service ou Device Sync Service.

Depois de criar um serviço de Edge Server , você pode adicionar imediatamente instâncias de Edge Server .

Se você criar um Device Sync Service, clique em Edge Server na navegação à esquerda. Isso abre uma lista onde você pode adicionar e visualizar instâncias Edge Server .

Clique no botão Add a server e siga as instruções para nomear e criar sua nova instância do Edge Server.

Criar um aplicativo de Device Sync

Consulte a documentação para Criar um App Services App.

Ao escolher o tipo de aplicativo, selecione Device Sync. Você pode adicionar servidores de borda ao seu aplicativo Device Sync depois de configurar o Device Sync.

Adicionar instâncias de Edge Server ao seu serviço de Device Sync

Enquanto visualiza seu Device Sync Service, clique em Edge Server na navegação à esquerda. Isso abre uma lista onde você pode adicionar e visualizar instâncias Edge Server .

Clique no botão Add a server e siga as instruções para nomear e criar sua nova instância do Edge Server.

Adicionar um servidor

Clique em Add a server. Você será solicitado a nomear seu Edge Server.

A UI fornece um script de instalação, que você pode copiar e colar no terminal do dispositivo em que deseja instalar o código do Edge Server. Você também recebe um token, que usará ao configurar a instância do Edge Server .

Instalar e configurar o código do Edge Server

Copie e cole o script de instalação no terminal do dispositivo em que você deseja instalar o código do Edge Server. Para obter mais detalhes, consulte Instalar e configurar a instância do Edge Server .

Após configurar e iniciar a instância do Edge Server , seu status Health no painel do Edge Server muda de Pending para Active.

Autenticar um usuário do MongoDB Atlas

Chame o endpoint de autenticação do usuário administrador com seu par de chaves da API do MongoDB Atlas:

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "username": "<Public API Key>",
    "apiKey": "<Private API Key>"
  }'

Se a autenticação for bem-sucedida, o corpo da resposta conterá um objeto JSON com um valor access_token :

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

O access_token concede acesso à App Services Admin API. Você deve incluí-lo como um token do portador no cabeçalho Authorization para todas as solicitações de API Admin.

Chame o endpoint de criação de instância do Edge Server

Ligue para a API Admin Criar um endpoint de instância do Edge Server para adicionar uma instância do Edge Server ao seu serviço.

Sua solicitação deve incluir:

• Um Authorization cabeçalho com seu token de acesso à API Admin como um token do portador.

• Um name para a nova instância do Edge Server

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/edge \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <AccessToken>' \
  -d '{
    "name": "YOUR-EDGE-SERVER-INSTANCE-NAME"
  }'

Uma solicitação bem-sucedida retorna um código 201, bem como um objeto JSON com informações sobre a instância do Edge Server recém-criada:

{
  "id": "6622b8f5118368b943d228a9",
  "user_id": "6622b8f5118368b943d2288a",
  "registration_key": "Qi4GgpvVduwwt4k1w77ZzaQ1n4SdTWC8rLBD9vyTib1w9G3CX2ta8WrJvt3giEK7"
}

• id: o identificador exclusivo da instância do Edge Server , do tipo ObjectId, como uma string. Você pode usar esse identificador para excluir ou atualizar a instância do Edge Server .

• user_id: o próprio Edge Server é um usuário. Este é o identificador exclusivo do usuário do Edge Server , do tipo ObjectId, como uma string. Você pode usar esse identificador ao configurar permissões.

• registration_key: Salve estas informações. Ao instalar o código do Edge Server no host, insira este token de registro. O Edge Server troca isso por uma chave de API que ele usa para autenticar com o Atlas. Você só pode usar este token de registro uma vez.

Instale o código do Edge Server

Copie e cole o script de instalação no terminal do dispositivo em que você deseja instalar o código do Edge Server. Para obter mais detalhes, consulte Instalar e configurar a instância do Edge Server .

Autenticar um usuário do MongoDB Atlas

Chame o endpoint de autenticação do usuário administrador com seu par de chaves da API do MongoDB Atlas:

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "username": "<Public API Key>",
    "apiKey": "<Private API Key>"
  }'

Se a autenticação for bem-sucedida, o corpo da resposta conterá um objeto JSON com um valor access_token :

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

O access_token concede acesso à App Services Admin API. Você deve incluí-lo como um token do portador no cabeçalho Authorization para todas as solicitações de API Admin.

Obtenha a lista de instâncias do Edge Server

Ligue para o endpoint List Edge Servers da API Admin para obter uma lista de todas as instâncias de servidores de borda.

Sua solicitação deve incluir um Authorization cabeçalho com seu token de acesso à API Admin como um token de portador.

curl -X GET \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/edge \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <AccessToken>'

Uma solicitação bem-sucedida retorna um código 200 e uma chave edge_servers cujos valores são uma array de objetos contendo detalhes resumidos para cada instância do Edge Server associada ao appId.

{
  "edge_servers": [
    {
      "id": "6622b8f5118368b943d228a9",
      "created": "2024-04-19T08:51:00Z",
      "name": "Edge-Store-42",
      "user_id": "6622b8f5118368b943d2288a",
      "status": "active",
      "hostname": "ec2-13-58-70-88.us-east-2.compute.amazonaws.com",
      "last_connection": "2024-04-19T09:51:00Z"
    }
  ]
}

Para obter informações mais detalhadas, encontre o id da instância cujos detalhes você deseja visualizar.

Ligue para o endpoint de informações do Edge Server

Ligue para o API Edge Server endpoint de informações do Obter de Administração para obter informações detalhadas sobre uma Edge Server instância do .

Sua solicitação deve incluir um Authorization cabeçalho com seu token de acesso à API Admin como um token de portador.

curl -X GET \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/edge/{edgeServerId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <AccessToken>'

Uma solicitação bem-sucedida retorna um código 200, bem como um objeto JSON com informações detalhadas sobre a instância do Edge Server :

{
  "id": "6622b8f5118368b943d228a9",
  "created": "2024-04-19T08:51:00Z",
  "name": "Edge-Store-42",
  "user_id": "6622b8f5118368b943d2288a",
  "status": "active",
  "hostname": "ec2-13-58-70-88.us-east-2.compute.amazonaws.com",
  "last_connection": "2024-04-19T09:51:00Z",
  "query": {
    "Item": "(store_id == \"641cb3d99e425c794ef69315\")"
  },
  "package_version": "v0.21.2",
  "latest_package_version": "v0.22.2",
  "metrics": [
    {
      "key": "edge_host_memory_percent",
      "name": "Memory Usage",
      "category": "host",
      "detail": "Percentage of memory used by the edge container",
      "value": 15,
      "unit": "%"
    },
    ...additional Edge Server metrics...
  ]
}

Para obter mais informações sobre esse corpo de resposta, consulte a especificação da API.

Navegue até o Painel do Edge Server

Clique na opção Edge Server na barra lateral de navegação à esquerda para abrir o dashboard do Edge Server .

Ver os detalhes da instância do Edge Server

Encontre a instância do Edge Server que você deseja excluir na lista e clique no botão View Details.

Excluir a Instância do Edge Server

Clique no botão Delete na parte inferior da exibição de detalhes do Edge Server .

Você será solicitado a confirmar a exclusão. Siga as instruções para confirmar que você deseja excluir o Edge Server.

Autenticar um usuário do MongoDB Atlas

Chame o endpoint de autenticação do usuário administrador com seu par de chaves da API do MongoDB Atlas:

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "username": "<Public API Key>",
    "apiKey": "<Private API Key>"
  }'

Se a autenticação for bem-sucedida, o corpo da resposta conterá um objeto JSON com um valor access_token :

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

O access_token concede acesso à App Services Admin API. Você deve incluí-lo como um token do portador no cabeçalho Authorization para todas as solicitações de API Admin.

Obtenha o ID do Edge Server a ser excluído

Ligue para o endpoint List Edge Servers da API Admin para obter uma lista de todas as instâncias do Edge Server .

Sua solicitação deve incluir um Authorization cabeçalho com seu token de acesso à API Admin como um token de portador.

curl -X GET \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/edge \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <AccessToken>'

Uma solicitação bem-sucedida retorna um código 200 e uma chave edge_servers cujos valores são uma array de objetos contendo detalhes resumidos para cada instância do Edge Server associada ao appId.

{
  "edge_servers": [
    {
      "id": "6622b8f5118368b943d228a9",
      "created": "2024-04-19T08:51:00Z",
      "name": "Edge-Store-42",
      "user_id": "6622b8f5118368b943d2288a",
      "status": "active",
      "hostname": "ec2-13-58-70-88.us-east-2.compute.amazonaws.com",
      "last_connection": "2024-04-19T09:51:00Z"
    }
  ]
}

Encontre o id da instância do Edge Server que você deseja excluir na array.

Chame o endpoint de exclusão

Ligue para a API Admin Exclua um endpoint de instância do Edge Server com o ID da instância do Edge Server que você deseja excluir.

Sua solicitação deve incluir um Authorization cabeçalho com seu token de acesso à API Admin como um token de portador.

curl -X DELETE \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/edge/{edgeServerId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <AccessToken>'

Uma solicitação bem-sucedida retorna um código 200 .