コンテンツにスキップ

ログスキーマ情報の取得



GET /api/v1/metric_info/log/schema

概要

ログインデックスで当日に検出されたフィールド名とデータ型を取得します。

呼び出し前の準備と使用手順

クエリ範囲はワークスペースのタイムゾーンにおける当日です。条件に一致するデータがない場合、結果フィールドは対応する空の配列になります。先にログインデックス一覧でインデックス名を確認してから、本 API を呼び出します。値をフィルタリングする必要がある場合は、返されたフィールド名をログタグ値の取得に渡します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y AK 識別子。認証に使用します。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理で、本 API の権限を持つ Key を作成または取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
index string クエリ対象のログインデックス。省略または空白を指定した場合は default を使用します。
null を許可: True
例: default
取得または入力方法: ログインデックス一覧の取得のレスポンスにある content.data[].name から選択します。

パラメータの補足説明

GET を使用して、現在の API Key が属するワークスペースのデータを読み取ります。

リクエスト例

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  "https://openapi.guance.com/api/v1/metric_info/log/schema" \
  --data-urlencode "index=default"

レスポンス

HTTP 200、application/json。

フィールド 型 説明
content.index string 実際にクエリしたログインデックス。
content.fields array<object> 結果リスト。一致する結果がない場合は空の配列になります。
content.fields[].name string フィールド名。後続のクエリで使用できます。
content.fields[].value_type string データソースが返すフィールド値の型。空文字列の場合があります。
content.fields[].type string フィールド分類。固定値は text です。
content.fields[].description string フィールドの説明。現在は空文字列です。
content.declaration object または null ワークスペース宣言。レスポンスにこの共通フィールドが含まれる場合があります。詳細は共通レスポンス構造を参照してください。
{"code": 200, "content": {"index": "default", "fields": [{"name": "service", "value_type": "string", "type": "text", "description": ""}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを指定した リクエストフィールドの検証に失敗しました。メッセージにフィールドまたはルールが示されます。 パラメータ表に記載されているパラメータのみを使用してください。
403 ft.ForbiddenQuery 現在の認証情報に、リクエストに対応するデータをクエリする権限がない クエリ権限が不足しています。 API Key のクエリ権限と対象データの認可範囲を確認してください。
503 ft.QueryServiceUnavailable 依存するクエリサービスが一時的に利用できない クエリサービスが一時的に利用できません。しばらくしてから再試行してください。 content.retryable を確認し、一時的なエラーの場合は遅延して再試行できます。

フィードバック

このページは役に立ちましたか?