エージェントステータス変更

エージェントのステータスを変更するためのAPIです。Manager画面で［エージェント］を選択したときに表示される画面の［操作］ボタンで、［使用開始］または［待機］を選択したときの操作に相当します。

= 備考 =

次のAPIは同一です (/api/v1/agents/agentId)。

  • エージェントステータス変更API
  • エージェント動作設定変更API
  • ユニット変更API
  • プロファイル変更API
  • モジュールバージョン変更API

このマニュアルでは、目的に応じたリクエストパラメータに変更して、個別に記載しています。
書式
curl -X PUT --header 'Content-Type: application/json'
            --header 'X-API-KEY:APIキー'
            -d 'JSON形式のリクエストボディ'
            'http://ホスト名:ポート番号/api/v1/agents/agentId'
リクエストボディ（JSON形式）
{
   "status": "ON"
}
リクエストパラメータ（JSON形式）
項目名 リクエストパラメータ 型 値 省略値
Agentのステータス status 文字列

"ON"　|　"OFF"

•　ON：Agentが使用中

•　OFF：Agentが待機

 省略不可
リクエストパラメータ（パス形式）
項目名 リクエストパラメータ 型 値 省略値
エージェントID agentId 文字列   省略不可