学習データセット一覧取得

検索条件に一致する学習データセット一覧を取得します。

必要な権限

MEMBER以上のロールが必要です。

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/machine-learning/inputs

リクエストパラメータ

正常応答

{
  "total_count": 1,
  "inputs": [
    {
      "id": 1,
      "guid": "99999999-8888-7777-6666-555555555555",
      "user_guid": "11111111-2222-3333-4444-555555555555",
      "user_name": "admin",
      "name": "トラフィック学習データセット",
      "description": "ネットワークトラフィック学習用データセット",
      "size": 12000,
      "fields": [
        {
          "name": "src_ip",
          "type": "string"
        },
        {
          "name": "label",
          "type": "string",
          "target": true,
          "values": ["normal", "anomaly"],
          "cardinality": 2
        }
      ],
      "configs": {
        "query": "table traffic | fields src_ip, dst_ip, label"
      },
      "created": "2024-06-18 09:30:25+0900",
      "updated": "2024-06-18 09:30:25+0900"
    }
  ]
}

• total_count (32ビット整数): 検索条件に一致する全件数
• inputs (配列): 学習データセット一覧
  • id (32ビット整数): データセット通し番号
  • guid (文字列): データセット識別子
  • user_guid (文字列): 作成したユーザの識別子
  • user_name (文字列): 作成したユーザの名前
  • name (文字列): データセット名
  • description (文字列): データセットの説明
  • size (64ビット整数): レコード数
  • fields (配列): データセットフィールド一覧
    • name (文字列): フィールド名
    • type (文字列): フィールドのデータタイプ
    • target (ブール, オプション): 対象フィールドかどうか。trueの場合のみ含まれます
    • values (文字列リスト, オプション): カテゴリ値一覧。設定されている場合のみ含まれます
    • cardinality (32ビット整数, オプション): カテゴリ値の個数。valuesが設定されている場合のみ含まれます
    • importance (64ビット実数, オプション): フィールド重要度。0より大きい場合のみ含まれます
  • configs (マップ): データソース設定のキー/値
  • created (文字列): 作成時刻。yyyy-MM-dd HH:mm:ssZ形式です
  • updated (文字列): 更新時刻。yyyy-MM-dd HH:mm:ssZ形式です

エラー応答

offset, limitの値が整数でない場合

HTTPステータスコード 400 応答

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}

権限がない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}