コンテンツにスキップ

ログインデックスの Tags 情報を取得



GET /api/v1/metric_info/log/tags

概要

特定のログインデックス内にある指定フィールドの値をサンプリングして取得します。

呼び出し前の確認と使用手順

クエリ範囲はワークスペースのタイムゾーンにおける当日です。条件に一致するデータがない場合、結果フィールドは対応する空の配列になります。空でない値の一部を返すため、過去のすべての値を列挙する目的には使用できません。上流のクエリ結果に含まれる null、空文字列、0、false はサンプルリストに含まれません。インデックス名またはフィールド名を空にした場合は成功を返し、content は {} です。

リクエストヘッダー

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

Query リクエストパラメータ

パラメータ名 型 必須 説明
index string Y ログインデックス名。レスポンスの元の値を使用します。
null の許可: False
例: default
取得または入力方法: ログインデックス一覧の取得レスポンスの content.data[].name から値を取得します。
tag string Y ログインデックス内のフィールド名。たとえば service です。
null の許可: False
例: service
取得または入力方法: ログスキーマの取得レスポンスの 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/log/tags" \
  --data-urlencode "index=default" \
  --data-urlencode "tag=service" \
  --data-urlencode "limit=10"

レスポンス

HTTP 200、application/json。

フィールド 型 説明
content.index string リクエスト内のログインデックス。
content.tag string リクエスト内のフィールドまたは Tag 名。
content.values array サンプリング値。要素の型はデータソースのフィールドによって異なります。一致する値がない場合は空の配列です。
content.declaration object または null ワークスペース宣言。この共通フィールドがレスポンスに含まれる場合があります。詳細は共通レスポンス構造を参照してください。
{"code": 200, "content": {"index": "default", "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 進整数の文字列を渡して再試行してください。

フィードバック

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