非ログテキストデータの Tags 情報を取得¶
GET /api/v1/metric_info/text_data/tags
概要¶
非ログデータの名前空間内で指定したフィールドの値をサンプリング取得します。
呼び出し前の準備と使用手順¶
クエリ範囲はワークスペースのタイムゾーンにおける当日です。条件に一致するデータがない場合、結果フィールドは対応する空の配列になります。空でない値の一部のみを返すため、過去のすべての値を列挙する用途には使用できません。上流のクエリ結果に含まれる null、空文字列、0、false はサンプルリストに含まれません。名前空間が空、サポート対象外、またはフィールド名が空の場合、成功として返され 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取得・入力方法: 書き込むデータの種類に応じて、本表に記載された名前空間から選択します。 |
| tag | string | Y | サンプリングして値を取得するフィールド名。 null の許可: False 例: service取得・入力方法: 同じ名前空間の非ログテキストデータ Schema を取得のレスポンスから content.fields[].name を取得します。 |
| limit | integer | デフォルトは 10 で、10 を超える場合は 10 として処理されます。正の整数を指定してください。 null の許可: True デフォルト値: 10 例: 10取得・入力方法: 呼び出し側が必要とするサンプル数に応じて設定します。1 から 10 を推奨します。 |
パラメータの補足説明¶
GET を使用して、現在の API Key が属するワークスペースのデータを読み取ります。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/metric_info/text_data/tags" \
--data-urlencode "namespace=tracing" \
--data-urlencode "tag=service" \
--data-urlencode "limit=10"
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.namespace | string | 前後の空白を除去したリクエストの名前空間。 |
| content.tag | string | リクエスト内のフィールド名または Tag 名。 |
| content.values | array | サンプリングされた値。要素の型はデータソースのフィールドに依存し、一致する値がない場合は空の配列になります。 |
| content.declaration | object または null | ワークスペース宣言。この共通フィールドはレスポンスに含まれる場合があります。詳細は共通レスポンス構造を参照してください。 |
{"code": 200, "content": {"namespace": "tracing", "tag": "service", "values": ["api", "worker"]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 必須の Query パラメータが不足しているか、宣言されていない Query パラメータが渡された | リクエストフィールドの検証に失敗しました。メッセージにフィールドまたはルールが示されます。 | パラメータ表と例を確認してください。 |
| 403 | ft.ForbiddenQuery | 現在の認証情報に、リクエスト対象データをクエリする権限がない | クエリ権限が不足しています。 | API Key のクエリ権限と対象データの認可範囲を確認してください。 |
| 503 | ft.QueryServiceUnavailable | 依存するクエリサービスが一時的に利用できない | クエリサービスが一時的に利用できません。しばらくしてから再試行してください。 | content.retryable を確認し、一時的なエラーの場合は遅延して再試行できます。 |
| 500 | ft.InternalServerError | limit に整数へ変換できない文字列が渡された | 内部エラー。 | パラメータ表で使用するページネーションフィールドを確認し、10 進整数の文字列を渡してから再試行してください。 |