コンテンツにスキップ

非ログテキストデータのスキーマ情報を取得¶

GET /api/v1/metric_info/text_data/schema

概要¶

namespace に基づいて、非ログテキストデータのスキーマ情報（フィールド構造は時系列データと同一ですが、field には tags フィールドは含まれません）を取得します。

Query リクエストパラメータ¶

パラメータ名	型	必須	説明
namespace	string	Y	名前空間。LLM、分散型トレーシング、RUM などの非ログテキストデータタイプを区別します。空を許可: False

パラメータ補足説明¶

show_xxxx_field('*') 関数を使用して非ログテキストデータのスキーマ情報を取得します。xxxx は namespace のマッピングから決定されます。

サポートされる namespace は次のとおりです。

namespace	説明
`object`	オブジェクトデータ
`object_history`	オブジェクト履歴
`custom_object`	カスタムオブジェクト
`custom_object_history`	カスタムオブジェクト履歴
`keyevent`	イベント
`audit_event`	監査イベント
`unrecovered_event`	未復旧イベント
`tracing`	分散型トレーシング
`rum`	リアルユーザーモニタリング（RUM）
`security`	セキュリティ
`network`	ネットワーク
`backup_log`	バックアップログ
`profiling`	プロファイリング
`rum_metric`	RUM メトリクス
`network_metric`	ネットワークメトリクス
`tracing_metric`	分散型トレーシングメトリクス
`billing`	課金
`dialtest`	Synthetic テスト
`execution_log`	実行ログ
`llm`	大規模言語モデル
`agent_monitor`	Agent モニタリング
`errorhub`	エラー追跡

リクエスト例¶

curl -k 'https://openapi.guance.com/api/v1/metric_info/text_data/schema?namespace=llm' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "declaration": {
            "business": "",
            "organization": "663dbba102482200070bbb02"
        },
        "fields": [
            {
                "description": "",
                "name": "output_tokens",
                "type": "text",
                "value_type": "long"
            },
            {
                "description": "",
                "name": "create_time",
                "type": "text",
                "value_type": "long"
            },
            {
                "description": "",
                "name": "llm_provider",
                "type": "text",
                "value_type": "keyword"
            },
            {
                "description": "",
                "name": "ttft",
                "type": "text",
                "value_type": "long"
            },
            {
                "description": "",
                "name": "metadata",
                "type": "text",
                "value_type": "keyword"
            }
        ],
        "namespace": "llm"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "69ba6c7800000000411c4a258db89fbe"
}