削除¶
POST /api/v1/dialing_task/delete
概要¶
Synthetic テストを一括削除し、対応するリモート設定を停止します。
呼び出し前の確認と使用手順¶
まず、すべての UUID と影響範囲を確認してください。通常タスクは、現在のすべてのノードに停止を配信してから設定をソフト削除します。ノードを持たない履歴タスクはリモート配信をスキップします。モバイルは、まずリモートタスクを削除してからローカルをソフト削除します。モバイルサービスのスイッチがオフの場合でも停止/削除は実行できますが、バインドが欠落している場合やリモートが不明確な場合は失敗することがあります。ローカルでの削除をプラットフォーム側の停止とみなさないでください。元の Synthetic テストデータおよび既存のイベントは、この操作では削除されません。すべての項目の削除が完了した後にのみ、Synthetic テストのタグ参照をクリーンアップします。入力集合全体に残るタグ参照もクリーンアップされる可能性があり、主レコードに一致しなかったものが影響をまったく受けないことを保証するものではありません。
デフォルトでは、本ワークスペース内の削除されていない一致対象のみを処理します。空の配列、またはすべて一致しない場合も true で成功し、項目ごとの一致リストは返しません。タスク間、およびリモートとローカルはアトミックなバッチではありません。前の項目がコミット済みで後の項目が失敗しても、全体がロールバックされることはありません。エラーが発生した場合は、まず各 task.status と一覧上の存在を読み戻してください。モバイルの remoteStatus は常に unknown であり、未実行を意味するものではありません。エラーの taskUUID/outcomeUnknown に基づいてプラットフォーム側を確認してください。結果が不明な状態で、むやみに並行リトライしないでください。
本 OpenAPI モジュールには、Front のデバッグ/インポートと同名の公開エンドポイントはありません。これを根拠に推測で URL を構築しないでください。設定の有効化は、測定結果を取得済みであることや通知が配信済みであることを意味しません。
通常の旧 HTTP/TCP/ICMP/SSL/multi/browser/NetPath は、停止や削除の配信時にもそのタイプの検証がトリガーされる場合があります。DNS の stop/delete のみが DNS コントラクトをスキップし、TCP の stop/delete は success_when キーのみを要求して timeout/connection を再検証しません。停止/削除を一律に「旧設定を無視する」と表現することはできません。
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| taskUUIDs[*] | string | タスク名、ノード、上流の taskId ではありません。 例: dial_example取得または入力方法: 本ワークスペース内の単一タスクの UUID を取得します。 |
|
| taskUUIDs | array | Y | 必須の配列で、空でないことを推奨します。dial_ タスクのみを選択し、ノード/テンプレート/リモート id を混在させないでください。一致しない UUID や削除済みの UUID は項目ごとにエラーを報告しません。null を許可: False 例: ["dial_example"]取得または入力方法: Synthetic テスト一覧から、本ワークスペース内の削除されていないタスクの uuid を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"taskUUIDs":["dial_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true です。一致件数や項目ごとの結果ではなく、リモートで 1 回の実行が完了したことを保証するものでもありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
通常の SDK では、dialtesting.invalidRegion を ft.DialingRegionError にマッピングし、実際の HTTP を保持します。その他の下流の 4xx は実際の HTTP および error_code/message を保持し、記載のないコードが現れることもあります。通常の 5xx は一律で 500 ft.InternalServerError になります。モバイルの失敗時には taskUUID/remoteStatus/outcomeUnknown が付与されることがあり、エラーが返された時点で前の項目がすでにコミットされている可能性があります。停止/削除は、すべての履歴タスクの現在の作成コントラクトを強制的に再検証するものではないため、これを根拠に旧設定を再有効化できると判断しないでください。
| HTTP ステータス | errorCode | トリガー条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドが欠落している、またはフィールド値が宣言された検証条件に違反している | パラメーター解析に失敗しました | パラメーターの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効です | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | Body の最上位がオブジェクトではありません | 一部の json ファイルの形式エラー | taskUUIDs および対応するスイッチを含む JSON オブジェクトを送信してください。 |
| 409 | ft.MobileDialingOperationBusy | モバイルタスクを含むバッチがワークスペースの同時操作ロックを待機してタイムアウトし、今回の操作は実行されませんでした | 現在、このワークスペースで別の操作が進行中です。今回の操作は実行されていません。しばらくしてから再試行してください。 | retryable/operationExecuted に従ってバックオフしてリトライしてください。 |
| 404 | ft.NotFoundDialTask | 待機中に元のモバイルタスクが削除された、または集合が変化した | 指定された Synthetic テストが見つかりません | 現在の一覧を読み直してから対象を選択し直してください。 |
| 406 | ft.NotFoundWorkspace | 書き込み先のワークスペースがすでに存在しません | 指定されたワークスペースが見つかりません | ワークスペースが有効であることを確認し、解放済みのワークスペースに対してリトライしないでください。 |
| 406 | ft.DialingBrandNoSetError | 通常タスクの配信時に対応するサービス設定が欠落している | {} ブランドの Synthetic テスト設定が構成されていません。 |
管理者がワークスペースの Synthetic テストサービスを確認してください。 |
| 400 | ft.DialingAKNoSetError | 通常の Synthetic テスト配信時に署名情報が欠落している | Synthetic テストの AK 情報が構成されていません。Launcher のアクティベーション設定を確認してください。 | 管理者がサービスのアクティベーションを確認してください。 |
| 400 | ft.DialingServerError | モバイルプラットフォームのバインド/リモート呼び出しに失敗した、または通常の下流 400 が失敗した | Synthetic テストサービス API の呼び出しに失敗しました | content.reason/taskUUID/outcomeUnknown とコミット済みのサブセットを確認し、重複操作を避けてください。 |
| 400 | ft.DialingRegionError | 通常の Synthetic テストの下流 400 でノードの無効と判定された | 現在のタスクには無効な Synthetic テストノードが一部存在します。設定を更新して再保存してください。 | 無効なノードと現在のタスク状態を確認してください。停止/削除は再設定とは意図が異なるため、必要に応じて管理者が対応してください。 |
| 500 | ft.InternalServerError | 通常の下流 5xx/接続異常、または捕捉されていないデータベース、設定形式、参照処理のエラー | 内部エラー | コミット済みのサブセットとリモート状態を読み戻し、traceId を提供したうえで段階ごとに対処してください。 |
| 406 | ft.InvalidCrontabFormat | 旧 NetPath の schedule_type=crontab かつ式が不正な場合、有効化/停止/削除の配信前にも検証されます | 無効な crontab 形式 | まず NetPath の完全な設定を修正するか、管理者に対応を依頼してください。NetPath は DNS/TCP の終了検証の免除を受けません。 |
| 406 | ft.MissingSuccessWhen | 通常の旧 HTTP でスクリプト代替がなく、または TCP/ICMP/SSL などの保存設定に success_when が欠落している。停止/削除時にも検証される場合があります | 使用可能な判定 success_when が欠落しています |
まず旧設定とプロトコルを確認してください。DNS の停止/削除は DNS コントラクトをスキップしますが、TCP の停止/削除は引き続きこのキーを要求します。 |
| 406 | ft.MissingMethod | 通常の HTTP またはマルチステップ HTTP の保存ステップに method が欠落している(停止/削除の配信を含む) | リクエストメソッド method が指定されていません |
完全な旧設定を修復するか、管理者が異常なタスクを処理してから操作してください。 |
| 400 | ft.MissingCustomParameters | SSL の保存設定に host/port が欠落している、または NetPath の厳格な必須フィールドが欠落している | {} フィールドが欠落しています | 元のタイプに従って修復してください。停止/削除でもこれらのチェックが一律にスキップされるわけではありません。 |
| 406 | ft.FirstStepsNotWait | 既存のマルチステップ設定の最初のステップが wait であり、再配信または削除・停止前の検証に失敗した | 無効なステップパラメーターです。最初のステップを待機にすることはできません | マルチステップフローを修正するか、管理者が旧設定を処理してください。 |
| 406 | ft.InvalidDialingTask | 旧 browser スクリプトが空/無効、または旧 multi HTTP のステップ名/URL が無効 | 無効な task パラメーター | 現在の OpenAPI の browser 書き込みはホワイトリストで制限されています。サポート対象のエンドポイント/管理者を通じて修復した後に再試行してください。 |
| 400 | ft.ParamsValidateError | NetPath/browser などの保存設定が停止/削除前のタイプ検証で不正 | パラメーター検証に失敗しました: {} | 元のタイプの完全な設定を確認してください。すべての停止/削除がコントラクトを回避するわけではありません。 |