このエンドポイントはNetskope Clientに関連する情報を返します。
リクエストエンドポイント
https://<tenant-URL>/api/v1/clients
Valid query parameters are:
| 鍵 | Value | デスクリプション |
|---|---|---|
token | string | 必須。Netskope UI の REST API ページ ( Settings > Tools > Rest API v1 ) から取得したトークンが必要です。エンドポイント URL ではなく、リクエストの本文にトークンを配置することをお勧めします。 |
query | 各種フィールドに対する有効なクエリ。 | これはデータベース内のすべてのエントリに対するフィルターとして機能します。 |
limit | 5000未満の正の整数 | REST APIのレスポンスは、1回のレスポンスで最大5000件のイベントを返すことができます。ページネーションを使用して、より多くの結果を取得できます。 |
skip | 正の整数 | 一部のイベントをスキップします（ページネーションとlimitの組み合わせで便利です）。 |
注記
このエンドポイントのクエリフィールドは、他のエンドポイントとは若干異なります。それを解決するには、まずクライアントのリストを取得し、返されたデータを確認してから、それに応じてクエリを考案する必要があります。
クライアントデータリクエストの例
POST https://<tenant-URL>/api/v1/clients
{
"token": "f32a973eddd7bc1602fc0f48dc0a",
"query": "host_info"}
Response
ホスト名は以下のように返されます。
{
"_id": ,
"client_install_time":
"device_id": ,
"host_info":
{
"device_make": ,
"device_model": ,
"hostname": ,
"os": ,
"os_version":
"nsdeviceuid":
},
"last_event":
{
"actor": ,
"event": ,
"status": ,
"timestamp":
},
"users":
[
{
"_id": ,
"client_version": ,
"device_classification_status": ,
"last_event":
{
"actor": ,
"event": ,
"status": ,
"timestamp":
},
"user_added_time":,
"user_source": ,
"userkey": ,
"username":
}
]
}
したがって、特定のホストに対するクエリはhost_info.hostname eq 'xxx'またはhost_info.hostname eq 'yyy'のようになります。
バックエンドは、多くのフィールドの状態を数値として返します。UI上では読みやすいテキストに変換されますが、REST APIでは変換されません。マッピングは以下のとおりです。
"device_classification_status": {
"managed": 0,
"unmanaged": 1,
"unknown": 2
},
"last_event": {
"status": {
"Disabled": 0,
"Enabled": 1,
"Uninstalled": 2
},
"event": {
"Installed": 0,
"Tunnel Up": 1,
"Tunnel Down": 2,
"Tunnel down due to Secure Forwarder": 3,
"Tunnel down due to config error": 4,
"Tunnel down due to error": 5,
"User Disabled": 6,
"User Enabled": 7,
"Admin Disabled": 8,
"Admin Enabled": 9,
"Uninstalled": 10,
"Installation Failure": 11
},
"actor":{
"User": 0,
"Admin": 1,
"System": 2
}
},
"user_source": {
"Directory": 0,
"Manual": 1
}
"host_info": {
os: {
"Windows": 0,
"Mac": 1,
"Android": 3,
"Windows Server": 4
}
}
階層構造が重要なので、最新のイベントをクエリするには、無効化されたイベントを見つけるためにクエリをlast_events.status = 0にする必要があります。