QueryHub 非同期クエリのキャンセル¶
POST /api/v1/df/async_query/delete
概要¶
同じ API Key が現在のワークスペースで送信した QueryHub タスクをキャンセルします。開始済みのクエリはタイムアウトまで実行され続ける可能性があり、Studio は遅延した結果を破棄します。
呼び出し前の準備と使用手順¶
- 現在の API Key を使用して非同期データクエリを送信し、QueryHub データソースを選択します。
- 返された content.data[*].async_id から、qhtask_ で始まるタスク識別子を取得します。送信時と同じ Key およびワークスペースを使用する必要があります。
- リクエストはリストの順序でキャンセルします。途中でいずれかの項目が失敗した場合、それ以前にキャンセルされたタスクはロールバックされません。確認が必要な場合は、それぞれ対応するタスクをポーリングしてください。
キャンセルに成功した後も、タスクに対して非同期クエリのエンドポイントを引き続き呼び出せます。POST JSON {"queries":[{"qtype":"queryhub","async_id":"qhtask_0123456789abcdef0123456789abcdef"}]}。キャンセル済みタスクは、レコードの有効期間中、query_status=failed、query_error.errorCode=QueryHubTaskCancelled、is_running=false、async_id="" を報告します。タスクレコードはデフォルトで送信時点から 300 秒間保持されます。レコードの有効期間中は、キャンセル済みタスクを再度キャンセルしても成功します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | OpenAPI アクセスキー 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理で、このインターフェースの権限を持つ Key を作成または取得します。 |
リクエスト Body パラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| asyncIds | array | Y | QueryHub 非同期タスク ID のリスト、1~20 項目 null の許可: False 例: ["qhtask_0123456789abcdef0123456789abcdef"]取得または入力方法: QueryHub 非同期クエリの送信レスポンスにある content.data[*].async_id からそのままコピーします。最大 20 項目とし、他のエンジンのタスク識別子は入力しないでください。 |
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/df/async_query/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"asyncIds":["qhtask_0123456789abcdef0123456789abcdef"]}'
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 成功時は {}。バックグラウンドエグゼキューターは引き続き実行されている可能性があり、遅延した結果は呼び出し元に渡されません。 |
| レスポンスヘッダー | 型 | 説明 |
|---|---|---|
| Cache-Control | string | 成功時および QueryHub エラー応答のいずれも no-store です。 |
{
"code": 200,
"content": {},
"errorCode": "",
"success": true,
"message": "",
"traceId": "trace-example"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーの詳細については、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | フィールドの型、必須項目、または制約がパラメータ表に一致しない | リクエストフィールドの検証に失敗しました。メッセージにフィールドまたはルールが示されます。 | フィールド、型、制約を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー。 | content 内の reason、line、column を確認して修正してください。 |
| 400 | forethought.QueryHubInvalidFields | リストが空、20 項目を超える、または QueryHub タスク ID でない | メッセージが空の場合があります。 | ID のプレフィックスと件数を項目ごとに確認してください。 |
| 400 | forethought.QueryHubInvalidId | qhtask_ 識別子に不正な文字が含まれる、または長すぎる | メッセージが空の場合があります。 | タスク送信時のレスポンスから完全な async_id をコピーしてください。 |
| 403 | forethought.QueryHubForbidden | ID がこのインターフェースに適用されない、またはクエリ権限がない | クエリ権限がありません。 | 呼び出し権限を持つ OpenAPI Key を使用してください。 |
| 404 | forethought.QueryHubTaskNotFound | タスクが無効、存在しない、または現在の Key に属していない | クエリタスクは無効になりました。再送信してください。 | ワークスペース、Key、タスクの状態を確認してください。 |
| 503 | forethought.QueryHubUnavailable | QueryHub が現在利用できない、または有効化されていない | クエリサービスまたはデータソースが一時的に利用できません。 | サービスが有効化されていることを確認してから、状態に応じて再試行してください。 |