コンテンツにスキップ

データクエリタスクの結果取得



GET /api/v1/log_backup_query/get_result

概要

非同期クエリタスクのステータスおよびマスキング結果を取得します。

呼び出し前および使用手順

query_task が返す task_id を Query.taskId としてポーリングします。ステータスと結果フィールドはダウンストリームから返され、task_status=completed の場合のみ完了として処理します。その他のステータスでは、待機を継続するか、レスポンス情報に基づいて失敗を処理する必要があり、HTTP 200 だけで完了を判断してはいけません。完了時、Studio はルールの dataType、syncExtensionField および現在のアイデンティティに従ってマスキングを実行し、その後、完了クエリの監査を記録します(タスク単位で重複排除)。

message はテキストまたは JSON 文字列の可能性があるため、データカテゴリと実際の結果に応じて解析し、固定のオブジェクト構造を前提としないでください。is_truncated/token は後続バッチのクエリに使用します。元のクエリ条件を維持し、token を query_task に渡してください。クエリコンテキストのキャッシュは 12 時間保持されます。完了時にコンテキストが失われている場合は 410 を返すため、クエリを再作成する必要があります。この期間は、ダウンストリームタスク自体の保持を保証するものではありません。この結果ルートはルール readPermissionSet を再確認しませんが、現在のインターフェースの認証およびデータマスキングは引き続き適用されます。タスク ID を権限のないアイデンティティに共有しないでください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証資格情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
taskId string Y 必須の元タスク ID。コロンなどの文字を含む場合は URL エンコードを使用し、token と混在させないでください。
null 許容: False
例: task_example
取得または入力方法: query_task レスポンスの content.task_id から取得します。

パラメータ補足説明

レスポンス結果のフィールド説明。

パラメータ名 type 説明
token string クエリカーソル。ページングしてクエリする場合は、リクエスト結果の token を含める必要があります
row string 検索された行情報
task_status string タスクステータス(created、running、completed、failed)
total_files integer 総ファイル数

注: タスクステータスが created および running の場合はまだ検索中です。completed、failed は検索が終了したことを示します。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/log_backup_query/get_result' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode taskId=task_example

レスポンス

HTTP 200、application/json。以下の例は直接読み取れる主要なフィールドを示します。

フィールド 型 説明
content.task_status string ダウンストリームタスクのステータス。completed は完了済み、その他の値はそのまま返されます。
content.row array<object> 完了後のクエリ行。空の場合があり、未完了の場合は省略されることがあります。
content.row[].message string または JSON マスキング後のデータペイロード。通常は元のテキストまたはシリアライズされた JSON で、オブジェクトに固定されません。
content.row[].date integer 上流レコードの時刻。既存のプロトコル例では Unix ミリ秒です。ルールの createAt の Unix 秒ではありません。
content.row[].その他の列 JSON データ型に応じて上流レコードの列が追加される場合があります。
content.token string 条件を維持して次のラウンドのタスクを引き続き作成するための透過カーソル。空または省略される場合があります。
content.is_truncated boolean 現在の結果が切り詰められているかどうか。token と組み合わせて次のバッチを手配します。省略される場合があります。
content.total_files integer 上流から返される検索ファイル統計。省略される場合があります。
content.search_completed number 上流の検索完了統計値。Studio は正規化しません。完了ブール値やパーセンテージとして扱わないでください。完了判定は task_status を参照します。
content.declaration object 空でないオブジェクトの共通宣言。
{
  "code": 200,
  "content": {
    "token": "CURSOR-EXAMPLE",
    "row": [
      {
        "message": "{\"message\":\"error: example\",\"service\":\"checkout-api\"}",
        "date": 1785427200000
      }
    ],
    "is_truncated": true,
    "total_files": 2,
    "search_completed": 0,
    "task_status": "completed",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

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

以下のダウンストリームクエリのビジネスエラーでは、SDK が実際の上流 4xx ステータスを保持します。ローカルのデフォルト 406 のみで判断することはできません。未識別のダウンストリーム error_code は、上流 4xx 時に ft.BackuplogInternalServerError にマッピングされ、実際の HTTP を保持します。元のエラーと traceId を記録して調査してください。通常の上流 5xx、タイムアウトなどは最終的に一律 500 ft.InternalServerError になります。

errorCode トリガーと処理
ft.BackuplogInvalidAPIArgs ダウンストリームクエリの時間、フィルター、カーソルなどのパラメータが不適合。ダウンストリームのメッセージに従ってパラメータを修正し、継続クエリでは同じ条件を維持します。
ft.BackuplogBucketNotFound 対象オブジェクトストレージが存在しない。ルールの対象とバケットのライフサイクルを確認します。
ft.BackuplogRuleNameInvalid ダウンストリームのルール名が無効、または設定が同期されていない。現在のルールとバックエンドの状態を確認してから再試行します。
ft.BackuplogOSAccessDenied ダウンストリームに対象データを読み取る権限がない。対象の認可、ロール、およびリソースアクセスポリシーを確認します。
HTTP ステータス errorCode トリガー条件 メッセージまたはレスポンスの説明 処理方法
406 ft.ParameterValidationFailed 未宣言の Query パラメータを使用、またはパラメータがルールに違反 パラメータの解析に失敗 Query パラメータ表と例を確認してください。
410 ft.BackuplogQueryContextExpired 完了結果にマスキングが必要だが、クエリコンテキストが失われている/12 時間を超えている 転送データクエリのコンテキストが期限切れです。クエリタスクを再作成してください 元の条件でタスクを再作成してから結果を取得してください。マスキングを回避することはできません。
500 ft.InternalServerError ダウンストリームの通常 5xx、結果マスキング、キャッシュ、または完了監査の処理に失敗 内部エラー taskId/traceId を保持し、クエリの現在の状態を確認して再試行してください。失敗が続く場合は管理者に連絡してください。

フィードバック

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