> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager.md).

# Deployment Manager

エッジハードウェアにデプロイされたコンピュータビジョンモデルを管理・監視します。

## 概要

Roboflow Deployment Managerを使うと、エッジデバイス上のコンピュータービジョンモデルを簡単にセットアップ、デプロイ、管理できます。モデルのトレーニングとワークフローの構築が完了したら、デプロイを大規模に展開するためのオールインワンソリューションとして利用できます。

Deployment Managerでは、次のことができます。

1. 次の [Roboflow Inferenceサーバー](https://docs.roboflow.com/deployment/ja/self-hosted/self-hosted.md).
2. デプロイで使用するカメラストリームを設定する。
3. エッジ上に [ワークフロー](https://docs.roboflow.com/workflows) をデプロイする。
4. デプロイ済みエッジデバイスのログ、ストリームのステータス、テレメトリを監視する。

{% hint style="warning" %}
Deployment ManagerはEnterpriseのお客様専用です。 [Roboflowの営業チームにお問い合わせ](https://roboflow.com/sales) いただき、この機能の詳細と、デプロイを大規模に管理する方法をご確認ください。
{% endhint %}

<figure><img src="https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-96d50cdbdfa347cff727c2eddcaa8ee3d85aa550%2Fenterprise-device-overview.png?alt=media" alt="Device overview with service health, disk usage, and running Streams"><figcaption></figcaption></figure>

### 主な要件：

Deployment Managerは、Roboflowがサポートするハードウェア向けに構築されています。

* サポート対象：Roboflow経由で購入したハードウェア
* サポート対象外（自己責任でご使用ください）：NVIDIA Jetson、NVIDIA GPUを搭載したDebianベースのLinuxを実行するx86マシン
* 未サポート：MacまたはWindowsベースのシステム

セットアップ、リモート管理、監視には、デバイスがRoboflowに接続できる必要があります。インターネットに接続できない現場で推論を実行するには、 [デバイスをオフライン運用向けに準備](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/prepare-a-device-for-offline-operation.md).

### エッジサービス

推論サーバーに加えて、デバイスではRoboflowの追加 [サービス](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services.md)を実行できます。デバイスの［Configuration］タブから追加・設定できます。詳細は [デバイス構成の更新](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/update-device-configuration.md).

* [イベントストア](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/event-store.md) は推論イベントをデバイス上に保存し、自動保持と任意のクラウドバックアップに対応します。
* [OPC UAサーバー](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/opc-ua-server.md) データをOPC UAタグとして公開し、PLCやSCADAシステムで利用できるようにします。
* [PLCリレー](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/plc-relay.md) Allen-Bradley、Modbus TCP、またはSiemens S7を介してPLCタグを読み書きします。
* [RTSPシミュレーター](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services/rtsp-simulator.md) アップロードした動画ファイルをRTSPソースとしてストリーミングし、テストに使用します。

各サービスは、デバイスのアドレス上で独自のHTTP APIを提供します。共通のベースURL、認証、エラー形式のルールについては、 [サービス](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services.md#using-the-apis) をご覧ください。

## ウェブアプリ

「Deployments」ページの「Edge Devices」タブを開くと、デバイスを確認できます。過去7日間に確認されたデバイスが先頭に表示されます。「Services」と「Streams」には、正常な状態の設定済みサービス数と、実行中のストリーム数が表示されます。カウントにカーソルを合わせると、ダウンロード中または起動中のサービスや、TensorRTエンジンのコンパイル待ちのストリームを確認できます。コンパイル中にデバイスを再起動すると、コンパイルは破棄されます。「Activity」には、デバイスで実行中のストリームの推論FPSとカメラFPSの合計、およびRoboflowが最後にデバイスから通信を受信した時刻が表示されます。ハートビートが5分間ない場合、デバイスはオフラインとして表示されます。推論FPSがカメラFPSを下回る場合、最大FPS制限またはフレームのドロップにより、デバイスが取り込んだフレームの一部しか処理できていません。

デバイスリストのナビゲーションでInferenceまたはJetPackのバージョングループを選択すると、そのバージョンを実行しているデバイスを確認できます。これらのグループは過去7日間に確認されたデバイスに基づいて自動更新され、名前の変更や削除はできません。Inferenceグループを更新するには、そのグループのデバイスを選択して、 [推論バージョンを設定](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/update-device-configuration.md).

<figure><img src="https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-145e9c9480e2e0ceefa973249b92504a4eab2cab%2Fdevice-version-groups.png?alt=media" alt="Deployment Manager navigation with Inference and JetPack version groups beside the devices running Inference v1.7.4"><figcaption></figcaption></figure>

## ガイド

### セットアップ

デバイスをオンラインにしてワークフローを実行するには、 [セットアップ](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up.md) ガイドを順番に進めてください。

| ガイド                                                                                                                                         | 説明                                          |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| [ハードウェア要件](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/hardware-requirements.md)           | サポート対象のハードウェア、カメラ、ネットワーク、および送信トラフィックに関する要件。 |
| [デバイスを追加](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/add-a-device.md)                     | プロビジョニングして新しいエッジデバイスをアカウントに登録します。           |
| [ストリームを追加](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/add-a-stream.md)                    | ワークフローを実行するカメラストリームを設定します。                  |
| [デバイスアラートを設定](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/set-up-device-alerts.md)         | 接続、ディスク、FPS の問題に関するメールアラートを有効にします。          |
| [メンテナンスウィンドウを設定](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/setup-maintenance-windows.md) | デプロイに影響する変更の適用タイミングをスケジュールします。              |

### 変更の実施

「 [変更の実施](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes.md) 」ガイドでは、セットアップ後のデバイスやストリームの更新、再設定、削除について説明します。

| ガイド                                                                                                                                                            | 説明                                           |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| [デバイス設定を更新](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/update-device-configuration.md)                   | デバイス設定、サービスバージョン、追加サービスを管理します。               |
| [デバイスネットワークを設定](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/configure-device-network.md)                  | クラウドから IP アドレス、ゲートウェイ、DNS、ホスト名を設定します。        |
| [AI1 カメラの設定](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/configure-ai1-camera-settings.md)                | 露出、ゲイン、フォーカスなど、AI1 カメラの設定をライブで調整します。         |
| [カメラに静的 IP を設定](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/set-camera-static-ip.md)                      | GigE Basler または Lucid カメラに永続的な静的 IP を割り当てます。 |
| [PoE ポートを再起動](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/soft-reset-poe-port.md)                         | カメラの PoE ポートを再起動して、応答しなくなったカメラリンクを復旧します。     |
| [ストリームを一時停止・再開](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/stop-a-stream.md)                             | 実行中のストリームを一時停止し、後で再開します。                     |
| [ストリームをトリガー](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/trigger-a-stream.md)                             | トリガーされたストリームに対して、必要に応じてワークフローを実行します。         |
| [ストリームを終了](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/delete-a-stream.md)                                | ストリームとその設定を完全に削除します。                         |
| [Deployment Manager を再デプロイ](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/redeploy-deployment-manager.md)   | 障害発生後にデバイスの設定を復旧します。                         |
| [デバイスを削除](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/delete-a-device.md)                                 | 使用しなくなったデバイスを完全に削除します。                       |
| [Deployment Manager の API キー](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/making-changes/api-keys-for-device-manager.md) | デバイス API キーの生成、スコープ設定、取り消し方法について説明します。       |

### 本番環境へのデプロイ

[デバイスマニフェストを使って本番環境にデプロイ](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/device-manifests.md) テスト済みデバイスをバージョン管理されたマニフェストとして保存し、本番デバイスに展開して、ロールバックする方法を説明します。

### モニタリング

「 [モニタリング](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/monitoring.md) 」ガイドでは、ストリームのステータス、ログ、リソース、Event Store の状態を確認する方法を説明します。

「 [デバイスのアクティビティ](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/monitoring/view-device-activity.md) 」を使って、デプロイに関するエラーを調査し、保存済みの設定を復元します。

| ガイド                                                                                                                                              | 説明                                      |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------- |
| [ストリームを表示](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/monitoring/view-a-stream.md)                        | ストリームのステータス、最新のフレーム、ワークフローの詳細を表示します。    |
| [デバイスログを表示](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/monitoring/view-device-logs.md)                    | Roboflow サービスのログを検索、フィルタリング、ダウンロードします。  |
| [リソースモニターを表示](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/monitoring/view-the-resource-monitor.md)         | ディスク、メモリ、CPU、GPU、サービスコンテナの状態を監視します。     |
| [Event Store のステータスを表示](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/monitoring/view-event-store-status.md) | Event Store の使用状況、バックアップの進行状況、履歴を監視します。 |

## HTTP API

Deployment Manager API を使用すると、Roboflow Deployment Manager（RFDM）デバイスをプログラムから監視および管理できます。

すべてのエンドポイントは、 `/:workspace/devices/v2` パブリック API ホスト（`https://api.roboflow.com`）にマウントされています。読み取りエンドポイントには、次のスコープを持つ [スコープ付き API キー](https://docs.roboflow.com/reference/authentication/authentication/scoped-api-keys) が必要です。 `device:read` スコープ。デバイスを変更するエンドポイントには、次のスコープが必要です。 `device:update`。スコープ一覧が明示されていないワークスペース API キーには、すべてのスコープが暗黙的に付与されます（従来の動作）。明示的な `scopes` 配列を持つキーには、該当するスコープを含める必要があります。

Deployment Manager API では、次の操作を行えます。

* [デバイスの一覧表示と取得](#list-and-get-devices)
* [デバイスの作成](#create-a-device)
* [デバイス設定](#device-config)
* [デバイスコマンド](#device-commands)
* [デバイスストリーム](#device-streams)
* [デバイスログとテレメトリ](#device-logs-and-telemetry)
* [デバイスイベント](#device-events)
* [デバイスサービス](#device-services)
* [デバイスグループ](#device-groups)
* [デバイス管理](#device-management)

オプションのエッジサービス（Event Store、PLC Relay、RTSP Simulator、OPC UA Server）は、 `api.roboflow.com`経由ではなく、デバイスのアドレス上で独自の HTTP API を提供します。これらのサービスは Roboflow API キーを受け付けず、認証方法やエラー形式も以下の内容とは異なります。詳細は、 [サービス](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services.md#using-the-apis).

### 認証

すべてのエンドポイントは、次のいずれかの方法でワークスペース API キーを受け付けます。

* クエリ文字列： `?api_key=YOUR_API_KEY`
* ヘッダー： `Authorization: Bearer YOUR_API_KEY`

#### デバイススコープの API キー

特定のデバイス用に発行された API キー（たとえば、インストール時に RFDM が発行したキー）は、そのデバイス専用に制限されます。キーに紐付けられたデバイスと `:deviceId` パスパラメーターが一致するルートのみ呼び出せます。ワークスペース全体を対象とする一覧・作成エンドポイント、および一致しない **403** の場合は、 `:deviceId` エラーが返されます。

### ワークスペース間の分離

ワークスペース API キーで読み取りまたは変更できるのは、そのワークスペースに属するデバイスのみです。別のワークスペースが所有するデバイス ID を指定したリクエストは、ID 自体が有効であっても **404**を返します。

### エラー

| ステータス | 意味                                                                                                                                                                                        |
| ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400   | 無効なクエリパラメーター（不明な `time_period`、カーソルまたは日付の形式が不正な場合、無効な `direction`など）、またはリクエスト本文が無効な場合。                                                                                                    |
| 401   | APIキーがないか、無効です。                                                                                                                                                                           |
| 403   | 別のデバイスを対象とするデバイススコープのAPIキー、ワークスペース全体を対象とする一覧／作成ルート、複製時に別のワークスペースに属するソースデバイス、または機能制限により拒否されたリクエスト（たとえば、 `offline_mode` がRoboflow Liteモードなしで指定された場合、またはワークスペースでSecure Gatewayが有効になっていない場合）。 |
| 404   | デバイス、ストリーム、設定、またはソースデバイスが見つかりません。別のワークスペースが所有するデバイスIDに対する読み取りリクエストも404を返します。                                                                                                              |
| 429   | レート制限を超えました。ログの読み取りはワークスペースあたり毎分120リクエスト、テレメトリの読み取りはデバイスあたり毎分60リクエスト（10秒間に10リクエストのバーストを含む）に制限されています。                                                                                      |

エラーレスポンスには次の2種類の形式があります。

* ハンドラーレベルのエラー（通常、ハンドラー自体が返す400、403、404、429）は、次の形式で返されます。 `{ "error": "<message>" }`.
* 認証およびワークスペース検証の失敗（通常は401）は、構造化された `error` オブジェクトを返します。 `{ "error": { "message": "...", "status": 401, "type": "OAuthException", "hint": "..." } }`.

ログのレート制限が発動した場合は、プレーンテキスト文字列の本文（JSONではありません）も返されます。 **429**.

### デバイスの一覧表示と取得

#### デバイス一覧の取得

ワークスペース内のデバイスを一覧表示します。表示権限のないフォルダー内のデバイスは除外されます。 `folder` クエリを使うと、指定した1つのフォルダーのみを一覧表示できます。デバイススコープのAPIキーでこのエンドポイントを呼び出すことはできず、 **403**.

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### デバイスの取得

IDを指定して、単一のデバイスを取得します。

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

### デバイスの作成

ワークスペースに新しいデバイスを作成し、インストールに必要な識別子を返します。デバイススコープのAPIキーでこのエンドポイントを呼び出すことはできず、 **403**.

**必要なスコープ：** `device:update`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2" method="post" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

返された `installId` を使って、Roboflow Deployment Managerインストーラーでデバイスを初期設定します。

#### AI1およびRoboflow OSデバイスに関する注意事項

* `offline_mode` は、Roboflow Liteモードが有効なワークスペースで、AI1デバイスおよびRoboflow OSデバイス（`device_type` `"edge"` かつ `os` `"roboflow-os"`）にのみ指定できます。それ以外のデバイスタイプでは **400**が返され、Roboflow Liteモードが有効でないワークスペースでは **403**.
* オフラインモードが適用される場合、レスポンスにはオフラインプロビジョニング用のQRペイロードをエンコードした `offlineProvisioningQrPayload` フィールドも含まれます。

#### 複製に関する注意事項

が `sourceDeviceId` 指定されている場合、新しいデバイスはソースデバイスの設定をコピーして作成されます。ソースデバイスはリクエストと同じワークスペースに属している必要があります。異なる場合、リクエストは **403**を返します。存在しない `sourceDeviceId` を返します **404**.

詳しくは [デバイスの複製](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/add-a-device.md#duplicate-a-device) を参照してください。引き継がれる設定と、複製したデバイスのインストール方法について説明しています。

### デバイス設定

#### ワークスペースのデフォルト設定を取得

ワークスペースレベルのデフォルトデバイス設定を返します。これは、ワークスペースの設定パッチ（ある場合）をマージした基本のデフォルト設定です。新しいデバイスをプロビジョニングする際、次を呼び出す前のテンプレートとして使用してください。 `POST /:workspace/devices/v2`.

**必要なスコープ：** `device:read`

{% hint style="info" %}
これはワークスペース全体を対象とするエンドポイントです。デバイススコープの API キーでは **403** が返されます。パスに `:deviceId` が含まれていないためです。
{% endhint %}

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/default-config" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### ワークスペースのデフォルト設定を更新

ワークスペースの設定パッチを置き換えます。新しいデバイスには、マージ後の設定が適用されます。新しいパッチは古いパッチを置き換えるため、毎回パッチ全体を送信してください。

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/default-config" method="patch" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### 設定を取得

デバイスに保存されている設定を返します。実行中の状態を証明するものではありません。レスポンスの構造は、Roboflow Deployment Manager（RFDM）の設定仕様に準拠しています。

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/config" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

{% hint style="warning" %}
ストリームの認証情報は、デバイスに紐づくキーで自身の設定を読み取る場合を除き、削除されます。この場合は、RFDMが必要とする暗号化済みの認証情報が保持されます。サービスごとの `environment_variables` や、設定に含まれるその他の認証情報は、保存された状態のまま返されます。レスポンス本文は機密情報として扱い、平文でログに記録しないでください。
{% endhint %}

#### 設定を更新

デバイス設定の一部（ストリームのワークフロー、信頼度しきい値、サービス設定など）を変更します。変更するフィールドのみを送信してください。ネストされたオブジェクトはマージされ、 `null` はキーを削除し、配列は配列全体を置き換えます。設定全体を送り返す必要はありません。

設定承認が有効になっているワークスペースの本番デバイスでは、変更に対して次が返されることがあります。 `staged: true` と `configProposal` が返され、承認待ちの状態になります。これによって稼働中の設定が変更されることはありません。未承認の変更はメンテナンスウィンドウ中も保留され、 `forceApply` も `immediateDelta` も承認を回避できません。

承認要件を満たしても、デプロイの変更は [メンテナンスウィンドウ](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/setup-maintenance-windows.md)まで待機することがあります。その場合、 `deferred: true`が返されます。 `forceApply=true` を設定すると、この変更とキューに入っているすべての変更を今すぐ適用するようリクエストできます。または、 `immediateDelta=true` を設定すると、このパッチのみを適用するようリクエストできます。設定を再度読み取り、保存を確認してから、デバイスが報告するサービスバージョン、ストリームの状態、出力を確認し、変更が実行中であることを検証してください。

**必要なスコープ：** `device:update`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/config" method="patch" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### 設定履歴

デバイスの過去の設定リビジョンのメタデータを、新しい順に一覧表示します。

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/config/history" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### サービスバージョンを設定

設定全体を送信せずに、1台のデバイスの推論またはマネージャーのバージョンを設定します。サービスの現在の `image` を [設定を取得](#get-config) から読み取り、新しいバージョンとともに送信してください。読み取り後にイメージが変更されている場合、リクエストは失敗するため、誤ったイメージにバージョンが固定されることはありません。 [メンテナンスウィンドウ](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/setup-maintenance-windows.md)が設定されたデバイスでは、変更は次のウィンドウまで待機します。複数のデバイスを更新するには、デバイスごとにこの処理を呼び出してください。

必要なスコープ： `device:update`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/config/service-version" method="patch" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

### デバイスコマンド

Webアプリから開始した操作（例: デバイスの再起動、ストリームの一時停止、カメラのスキャン）は、コマンドとしてキューに追加されます。デバイスは次回のポーリング時にコマンドを取得します。

#### コマンドをキューに追加

デバイスが次回のポーリング時に実行するコマンドをキューに追加します。デバイスを再起動したりストリームを開始したりするときにWebアプリが行う処理を、APIから実行します。

**必要なスコープ：** `device:update`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/commands" method="post" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

### デバイスストリーム

#### ストリームの一覧表示

デバイスに設定されているすべてのストリームを一覧表示します。

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/streams" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### ストリームを取得

単一のストリームを取得します。

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/streams/{streamId}" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

### デバイスログとテレメトリ

#### ログ

ページネーションされたデバイスログを返します。

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/logs" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

**レート制限:** ワークスペースごとに毎分120リクエストです。ログの読み取りとログの取り込みには別々のレート制限枠が適用されるため、ログをポーリングしても取り込み枠は消費されません（逆も同様です）。

#### テレメトリ

デバイスの集計ハードウェアメトリクス（CPU、メモリ、ディスク、GPU）と、一定の時間枠ごとに集計したストリーム別FPSを返します。

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/telemetry" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

**レート制限**

このエンドポイントには、デバイスごとに次のレート制限が適用されます: **毎分60リクエスト** さらに、次の制限があります: **10秒あたり10リクエスト** のバースト制限。超過したリクエストは **429**を返します。同じデバイスのテレメトリ取り込み経路とデバイスごとのテレメトリ枠を共有するため、過剰な読み取りによって同じデバイスの取り込みに影響が出ることがあります。

### デバイスイベント

デバイスとストリームのライフサイクルイベント（例: デバイスの起動、ストリームの開始と停止、エラー、設定変更）を返します。

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/events" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

デフォルトでは、フィード内の繰り返しイベントは状態変化にまとめられます。このため、同じイベント名を再利用する定期的なテレメトリは表示されません。すべての生データ行を読み取るには、 `dedupe=false` と `entity_type` および `entity_id` の両方を指定します。1つの値を時系列でグラフ化するには、代わりに [サービス系列エンドポイント](#device-services) を使用してください。エンティティIDは自動的に解決されます。

### デバイスサービス

デバイスが実行する [サービス](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/services.md) と、それらのライブステータス（コンテナの状態、イメージのバージョン、PLCの接続状態やEvent Storeの容量など、種類ごとのステータス）を関連付けて返します。

**必要なスコープ：** `device:read`

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/services" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/services/{serviceName}" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

これらのエンドポイントを使用してデバイス群をポーリングします。サービスが稼働し、レポートを送信していることを確認するには `include=status` を指定し、CPUとメモリを取得するには `include=metrics` を追加します。

{% hint style="info" %}
`include=config` は、保存されている環境変数の値をそのまま返します。これらの値には、ブローカーのパスワードやAPIキーなどの認証情報が含まれていることがよくあります。そのため、デフォルトでは無効になっています。 `config` を含むレスポンスは機密情報として扱ってください。
{% endhint %}

サービスは、サービスの種類に基づくエンティティIDでテレメトリを報告します。そのため、同じデバイス上に同じ種類のサービスが2つあると、各サービスに固有の `DEVICE_EVENT_ENTITY_ID`を設定しない限り、IDが重複します。この場合、APIは共有IDを `signal_conflicts` に一覧表示し、 `status` を `null`。どのコンテナが測定値を送信したのか判別できないためです。カスタムエンティティ IDには、英字、数字、ハイフン、アンダースコアのみを使用してください。次の文字 `.`, `/`, `*`, `~`, `[`と `]` を使うとステータスキャッシュが破損し、サービスからステータスがまったく報告されなくなります。

#### サービスメトリクスの時系列

グラフ表示用に、1つのサービスの1つのメトリクスを時系列で返します。

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/services/{serviceName}/series" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

### デバイスグループ

デバイスをグループ化して、まとめて検索・管理できます（例：同じライン上のすべてのカメラ）。

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/groups" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/groups" method="post" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/groups/{groupId}" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/groups/{groupId}" method="patch" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/groups/{groupId}" method="delete" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

少数のデバイスを追加または削除する場合は、デバイスグループの更新にメンバーリスト全体を送信する代わりに、こちらを使用してください。

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/groups/{groupId}/devices" method="post" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/groups/{groupId}/devices" method="delete" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

### デバイス管理

これらのエンドポイントを使うと、Webアプリのデバイスページで行う操作をAPIから実行できます。削除と再デプロイにはワークスペースAPIキーが必要なため、デバイス自身のキーを使ってデバイスを削除または再インストールすることはできません。

#### デバイスを更新

デバイスの名前を変更するか、環境変数を設定します。

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}" method="patch" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### デバイスを削除

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}" method="delete" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### デバイスを再デプロイ

新しい `installId` を使用して、 [デバイスを作成](#create-a-device).

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/redeploy" method="post" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### 保留中の設定を適用

次のデバイスでは、 [メンテナンス時間帯](https://docs.roboflow.com/deployment/ja/self-hosted/enterprise/deployment-manager/setting-up/setup-maintenance-windows.md)承認済みの設定変更を次の時間帯まで保留できます。今すぐ適用するようリクエストするには、こちらを呼び出してください。設定承認が有効になっているワークスペース内の本番デバイスでは、キューに入っているすべての変更を事前に承認する必要があります。

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/config/apply-pending" method="post" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### フレームをプロジェクトにキャプチャ

学習用に、ストリームの最新フレームをキャプチャします。 `status: "screening"` を含むレスポンスは、アップロード審査の判定を待って画像が保留されており、まだプロジェクトに追加されていないことを示します。返されるプロジェクトの詳細には、指定された保存先が示されます。

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/streams/{streamId}/capture" method="post" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### ライブフレームをサンプリング

カメラの最近のフレームを画像URLとして取得します（例：カメラの映像を確認する場合や、画像をワークフローに渡す場合）。ストリームに10秒以内のフレームがあれば、すぐに取得できます。ない場合は、Roboflowがデバイスに新しいフレームを要求し、最大 `timeout_seconds`まで待機します。このURLはフレームのコピーを指しているため、1時間有効です。

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/streams/{streamId}/sample" method="post" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### アラートを一時停止

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/{deviceId}/alerts/snooze" method="post" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

#### 全デバイスを対象とする読み取り

これらはワークスペース内のすべてのデバイスからデータを読み取るため、ワークスペースAPIキーが必要です。

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/events" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/inference-versions" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/875bfb9d5cb6123044c119d00cb0dca6857749d2" path="/{workspace}/devices/v2/stream-options" method="get" %}
[deployment-manager.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-c0c85d357919aff42b11960838e00e7abf0f0e2e%2Fdeployment-manager.yaml?alt=media)
{% endopenapi %}

## MCPサーバー

AIエージェント（例：Claude、Cursor、ChatGPT、Codex）を [Roboflow MCPサーバー](https://docs.roboflow.com/agents/mcp-server) に接続すると、自然な言葉で指示してデバイスを管理できます。エージェントは、アカウントの権限を用いてWebアプリと同じAPIを使用します。

{% hint style="info" %}
[Roboflow MCPサーバーをセットアップ](https://docs.roboflow.com/agents/mcp-server#adding-mcp) すれば数分で完了し、その後はエージェントにデバイスについて質問できます。
{% endhint %}

MCPサーバーに接続すると、エージェントで次のことができます。

* フリートの状態を確認：オフラインのデバイスを見つけ、ログやテレメトリを読み取り、最近のエラーについて説明します。
* カメラ映像を確認：ライブフレームを取得して場面を確認し、デプロイ前にその映像でワークフローをテストします。
* デバイスを変更：メンテナンス時間帯を尊重しながら、設定を更新したり、推論バージョンを固定したり、名前を変更したりします。
* ストリームを操作：ストリームの追加、一時停止、再開、トリガー、削除を行い、停止したカメラのPoEポートを再起動します。
* デバイスを整理：デバイスグループを作成し、デバイスをグループ間で移動します。

次のように質問してみてください。

* 「オフラインになっているデバイスはどれで、その原因は何ですか？」
* 「積み込み場のカメラに今どのように映っていますか？」
* 「Line 3グループのすべてのデバイスで、推論をバージョン1.2.3に設定してください。」

すべてのデバイスツールについては、 [MCPサーバーのツール一覧](https://docs.roboflow.com/agents/mcp-server#devices-and-streams).
