この記事では、APIを使用してZscaler Digital Experience (ZDX)のトラブルシューティングを管理するための情報を提供します。 すべてのAPIはレート制限されています。詳細については、レート制限についてを参照してください。

デバイスのDeep Tracingの開始

デバイスでDeep Tracingセッションを開始するには、エンドポイント/devices/{deviceid}/deeptracesにPOST要求を送信します。要求に次の情報を入力します。

• deviceid：デバイスのID。

たとえば、Pythonでは次のようにします。

payload = { 
   "deviceid":30989301
}

• レスポンスの例を表示します。

  {
    "trace_id": 0,
    "status": "not_started",
    "expected_time": 0
  }

  閉じる

正常なレスポンスは、コード200を返します。詳細は、エラー コードの詳細説明を参照してください。

デバイスのDeep Tracingを停止する

デバイスでDeep Tracingセッションを停止するには、エンドポイント/devices/{deviceid}/deeptracesにDELETE要求を送信します。要求に次の情報を入力します。

これにより、Deep Tracingセッションと関連データが削除されます。

• deviceid：デバイスのID。
• trace_id：停止が必要なDeep Tracing ID。

たとえば、Pythonでは次のようにします。

payload = { 
   "deviceid":30989301,
   "trace_id":0
}

• レスポンスの例を表示します。

  {
    "trace_id": 0
  }

  閉じる

正常なレスポンスは、コード200を返します。詳細は、エラー コードの詳細説明を参照してください。

デバイスのすべてのディープトレースのリストを取得する

特定のデバイス上のすべてのディープトレースのリストを取得するには、エンドポイント/devices/{deviceid}/deeptracesにGET要求を送信します。要求に次の情報を入力します。

• deviceid：デバイスのID。

たとえば、Pythonでは次のようにします。

payload = {  
   "deviceid":30989301
}

• レスポンスの例を表示します。

  {
    "trace_id": 0,
    "trace_details": {
      "session_name": "string",
      "user_id": 0,
      "username": "string",
      "device_id": 30989301,
      "device_name": "string",
      "web_probe_id": 0,
      "web_probe_name": "string",
      "cloudpath_probe_id": 0,
      "cloud_path_name": "string",
      "session_length": 0,
      "probe_device": true
    },
    "status": "not_started",
    "created_at": 0,
    "started_at": 0,
    "ended_at": 0
  }

  閉じる

正常なレスポンスは、コード200を返します。詳細は、エラー コードの詳細説明を参照してください。

Deep Tracingセッション設定の取得

Deep Tracingセッションの設定を取得するには、エンドポイント/devices/{deviceid}/deeptraces/{trace_id}にGETリクエストを送信します。要求に次の情報を入力します。

• deviceid：デバイスのID。
• trace_id：デバイスのDeep Tracing ID。

たとえば、Pythonでは次のようにします。

payload = { 
   "deviceid":30989301,
   "trace_id":0
}

• レスポンスの例を表示します。

  {
    "trace_id": 0,
    "trace_details": {
      "session_name": "string",
      "user_id": 0,
      "username": "string",
      "device_id": 30989301,
      "device_name": "string",
      "web_probe_id": 0,
      "web_probe_name": "string",
      "cloudpath_probe_id": 0,
      "cloud_path_name": "string",
      "session_length": 0,
      "probe_device": true
    },
    "status": "not_started",
    "created_at": 0,
    "started_at": 0,
    "ended_at": 0
  }

  閉じる

正常なレスポンスは、コード200を返します。詳細は、エラー コードの詳細説明を参照してください。