ビュー:

ウイルスバスター Corp.クライアントなどの管理下の製品エージェントのリストを取得します。

HTTP要求

GET /WebApp/API/AgentResource/ProductAgents

パラメータ

パラメータ

種類

説明

オプションのパラメータ

entity_id

文字列

管理下の製品エージェントのGUID

ip_address

文字列

管理下の製品エージェントのIPアドレス

mac_address

文字列

管理下の製品エージェントのMACアドレス

host_name

文字列

管理下の製品エージェントのエンドポイント名

product

文字列

エージェントの対象のトレンドマイクロ製品

使用可能な値については、自動APIの製品値を参照してください。

managing_server_id

文字列

エージェントを管理する製品サーバのGUID

HTTP要求の例

GET /WebApp/API/ServerResource/ProductAgents?
ip_address=192.168.121.132&mac_address=00-0C-29-9B-AB-65&
host_name=OSCECLIENT

HTTP要求本文

次のHTTPヘッダを含むJSONオブジェクトを指定します。

  • HTTPヘッダ:

    フィールド名

    Authorization

    Bearer [生成されたJWT認証トークン]

  • 要求本文: [空白]

応答メッセージ

成功すると、HTTP 200 OKステータスコードと、以下に該当する応答本文が返されます。

  • "result_code"1である

  • "result_content"が、指定したすべてのパラメータに一致するエージェントのリストである

{
 "result_code":1,
 "result_description":"Operation successful",
 "result_content":[
   {
     "entity_id":"8a1a84550462-40bc9afc-3770-16ac-cd6c",
     "product":"SLF_PRODUCT_OFFICESCAN_CE",
     "managing_server_id":
        "026332F39EBC-41C19604-02DD-2C5F-EDE5",
     "ad_domain":"",
     "folder_path":"Workgroup",          
     "ip_address_list":"192.168.121.132",
     "mac_address_list":"00-0C-29-9B-AB-65",          
     "host_name":"OSCECLIENT",
     "isolation_status":"normal",          
     "capabilities":[
        "cmd_uninstall_agent",
        "cmd_relocate_agent",
        "cmd_isolate_agent",
        "cmd_restore_isolated_agent"
      ]
    }
  ]
}

次の表は、result_contentリストの使用可能なパラメータについて示しています。

パラメータ

種類

説明

entity_id

文字列

管理下の製品エージェントのGUID

product

文字列

エージェントが対象としているトレンドマイクロ製品

使用可能な値については、自動APIの製品値を参照してください。

managing_server_id

文字列

エージェントを管理する製品サーバのGUID

ad_domain

文字列

エージェントが属するActive Directoryドメイン (該当する場合)

folder_path

文字列

管理サーバ上でエージェントが配置されるフォルダパス (たとえば、エージェントが表示されているウイルスバスター Corp.ドメイン)

ip_address_list

文字列

エージェントエンドポイント上のIPアドレスを一覧表示します

mac_address_list

文字列

エージェントエンドポイント上のMACアドレスを一覧表示します

host_name

文字列

管理下の製品エージェントのエンドポイント

isolation_status

文字列

エージェントの隔離ステータスを示します (該当する場合)。

使用可能な値については、自動APIの隔離ステータスを参照してください。

capabilities

文字列

エージェント上で実行可能なAPI処理を一覧表示します

使用可能な値については、自動APIの処理と機能を参照してください。