非ログテキストデータのスキーマ情報を取得¶
GET /api/v1/metric_info/text_data/schema
概要¶
指定した非ログデータネームスペースで当日に検出されたフィールド名とデータ型を取得します。
呼び出し前と使用手順¶
検索範囲は、ワークスペースのタイムゾーンにおける当日です。条件に一致するデータがない場合、結果フィールドは対応する空の配列になります。 ネームスペースが空またはサポート対象外の場合は成功を返し、content は {} になります。ログフィールドの場合は、ログスキーマの取得を呼び出してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | AK 識別子。認証に使用します。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理で、この API の権限を持つ Key を作成または取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| namespace | string | Y | 「lineage」、「object」、「object_history」、「custom_object」、「custom_object_history」、「keyevent」、「audit_event」、「unrecovered_event」、「tracing」、「rum」、「security」、「network」、「backup_log」、「profiling」、「rum_metric」、「network_metric」、「tracing_metric」、「billing」、「dialtest」、「execution_log」、「llm」、「agent_monitor」、「errorhub」をサポートします。大文字と小文字を区別せず、前後の空白を削除します。 null の許可: False 例: tracing取得または入力方法: 書き込むデータ型に応じて、この表に記載されたネームスペースから選択します。 |
パラメータの補足説明¶
GET を使用して、現在の API Key が所属するワークスペースのデータを読み取ります。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/metric_info/text_data/schema" \
--data-urlencode "namespace=tracing"
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.namespace | 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": {"namespace": "tracing", "fields": [{"name": "service", "value_type": "string", "type": "text", "description": ""}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}
エラー応答¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 必須の Query パラメータが不足している、または宣言されていない Query パラメータが渡された | リクエストフィールドの検証に失敗しました。メッセージにはフィールドまたはルールが示されます。 | パラメータ表と例を確認してください。 |
| 403 | ft.ForbiddenQuery | 現在の認証情報に、リクエストに対応するデータをクエリする権限がない | クエリ権限が不足しています。 | API Key のクエリ権限と対象データの認可範囲を確認してください。 |
| 503 | ft.QueryServiceUnavailable | 依存するクエリサービスが一時的に利用不可 | クエリサービスが一時的に利用できません。しばらくしてから再試行してください。 | content.retryable を確認してください。一時的なエラーの場合は、時間をおいて再試行できます。 |