Atlas での Edge Server の管理 - プレビュー

Data Services UI に移動する

Atlas UI プロジェクト ダッシュボードでプロジェクトを選択すると、 Data Servicesタブがデフォルトで表示されます。

App ServicesまたはChartsを使用している場合は、 Data Servicesタブを選択します。

Device & Edge Sync を選択する

左側のサイドバーで、 Servicesセクションを参照します。 Device & Edge Syncを選択します。

サービスの作成

作成するサービスの種類を選択し、プロンプトに従って Edge Server Service または Device Sync Service を作成します。

Edge Server Service を作成したら、すぐに Edge Server インスタンスを追加できます。

Device Sync サービスを作成する場合は、左側のナビゲーションにある [ Edge Server ] をクリックします。 これにより、Edge Server インスタンスを追加および表示できるリストが開きます。

[ Add a server ] ボタンをクリックし、プロンプトに従って新しい Edge Server インスタンスに名前を付けて作成します。

Device Sync アプリの作成

App Services Appの作成 に関するドキュメントを参照してください。

アプリの種類を選択するときは、 Device Syncを選択します。 Device Sync を構成した後に、Device Sync アプリに Edge Server を追加できます。

Device Sync サービスへの Edge Server インスタンスの追加

Device Sync サービスを表示しているときに、左側のナビゲーションにある [ Edge Server ] をクリックします。 これにより、Edge Server インスタンスを追加および表示できるリストが開きます。

[ Add a server ] ボタンをクリックし、プロンプトに従って新しい Edge Server インスタンスに名前を付けて作成します。

サーバーを追加する

[ Add a serverをクリックします。 Edge Server に名前を付けるように求められます。

UI にはインストール スクリプトが用意されており、Edge Server コードをインストールするデバイスのターミナルにコピーして貼り付けることができます。 また、Edge Server インスタンスを構成するときに使用するトークンも取得されます。

Edge Server コードのインストールと構成

インストール スクリプトをコピーして、Edge Server コードをインストールするデバイスのターミナルに貼り付けます。 詳細については、 「 Edge Server インスタンスのインストールと構成 」を参照してください。

Edge Server インスタンスを構成して起動すると、Edge Server ダッシュボード内のHealthステータスがPendingからActiveに変わります。

MongoDB Atlas ユーザーの認証

MongoDB Atlas API キー ペアを使用して、管理ユーザー認証エンドポイントを呼び出します。

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>"
  }'

認証に成功すると、レスポンス本文にはaccess_token値を持つ JSON オブジェクトが含まれます。

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

access_tokenは App Services Admin API へのアクセスを許可します。 すべての管理 API リクエストのAuthorizationヘッダーに Bearer トークンとして含める必要があります。

Edge Server インスタンス作成エンドポイントの呼び出し

管理 API 「Edge Server インスタンスの作成」エンドポイントを呼び出して、Edge Server インスタンスをサービスに追加します。

リクエストには、以下の内容が必要です。

• Authorization管理 API アクセス トークンが Bearer トークン として含まれる ヘッダー。

• 新しい Edge Server インスタンスのname

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"
  }'

リクエストが成功すると、 201コードと、新しく作成された Edge Server インスタンスに関する情報を含む JSON オブジェクトが返されます。

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

• id: Edge Server インスタンスの一意の識別子で、ObjectId 型（string）。 この識別子を使用して、Edge Server インスタンスを削除または更新できます。

• user_id: Edge Server 自体はユーザーです。 これは、string としての ObjectId 型の Edge Server ユーザーの一意の識別子です。 この識別子は、権限を設定するときに使用できます。

• registration_key: この情報を保存します。 ホストに Edge Server コードをインストールするときは、この登録トークンを入力します。 Edge Server は、Atlas で認証するために使用する API キーとこれを交換します。 この登録トークンは 1 回だけ使用できます。

Edge Server コードをインストール

インストール スクリプトをコピーして、Edge Server コードをインストールするデバイスのターミナルに貼り付けます。 詳細については、 「 Edge Server インスタンスのインストールと構成 」を参照してください。

MongoDB Atlas ユーザーの認証

MongoDB Atlas API キー ペアを使用して、管理ユーザー認証エンドポイントを呼び出します。

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>"
  }'

認証に成功すると、レスポンス本文にはaccess_token値を持つ JSON オブジェクトが含まれます。

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

access_tokenは App Services Admin API へのアクセスを許可します。 すべての管理 API リクエストのAuthorizationヘッダーに Bearer トークンとして含める必要があります。

Edge Server インスタンスの一覧を取得する

すべての Edge Server インスタンスのリストを取得するには、 Admin API List Edge Serverエンドポイントを呼び出します。

Authorizationリクエストには、管理 API アクセス トークンが Bearer トークン として返される ヘッダーが含まれている必要があります。

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

リクエストが成功すると、 200コードと、 appIdに関連付けられた各 Edge Server インスタンスの概要の詳細を含むオブジェクトの配列であるedge_serversキーが返されます。

{
  "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"
    }
  ]
}

詳しくは、詳細を表示するインスタンスのidを見つけます。

Edge Server 情報エンドポイントの呼び出し

Edge Server インスタンスに関する詳細情報を取得するには、 「Admin API Get Edge Server 情報エンドポイント」を呼び出します。

Authorizationリクエストには、管理 API アクセス トークンが Bearer トークン として返される ヘッダーが含まれている必要があります。

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

リクエストが成功すると、 200コードと、Edge Server インスタンスに関する詳細情報を含む JSON オブジェクトが返されます。

{
  "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...
  ]
}

このレスポンス本体の詳細については、 API 仕様 を参照してください。

Edge Server ダッシュボードを参照する

左側のナビゲーション サイドバーでEdge Server ] オプションをクリックして、Edge Server ダッシュボードを開きます。

Edge Server インスタンスの詳細の表示

リストで削除する Edge Server インスタンスを見つけ、 View Detailsボタンをクリックします。

Edge Server インスタンスの削除

Edge Server の詳細ビューの下部にあるDeleteボタンをクリックします。

削除を確認するプロンプトが表示されます。 プロンプトに従って、Edge Server を削除するかどうかを確認します。

MongoDB Atlas ユーザーの認証

MongoDB Atlas API キー ペアを使用して、管理ユーザー認証エンドポイントを呼び出します。

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>"
  }'

認証に成功すると、レスポンス本文にはaccess_token値を持つ JSON オブジェクトが含まれます。

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

access_tokenは App Services Admin API へのアクセスを許可します。 すべての管理 API リクエストのAuthorizationヘッダーに Bearer トークンとして含める必要があります。

削除する Edge Server の ID を取得する

すべての Edge Server インスタンスのリストを取得するには、 Admin API List Edge Serverエンドポイントを呼び出します。

Authorizationリクエストには、管理 API アクセス トークンが Bearer トークン として返される ヘッダーが含まれている必要があります。

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

リクエストが成功すると、 200コードと、 appIdに関連付けられた各 Edge Server インスタンスの概要の詳細を含むオブジェクトの配列であるedge_serversキーが返されます。

{
  "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"
    }
  ]
}

配列で削除する Edge Server インスタンスのidを見つけます。

削除 エンドポイントの呼び出し

削除する EdgeAPI インスタンスのEdge Server を指定して、 Delete をID 呼び出します。Edge Server

Authorizationリクエストには、管理 API アクセス トークンが Bearer トークン として返される ヘッダーが含まれている必要があります。

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

リクエストが成功すると、 200コードが返されます。