マルチステップ API テストタスクを変更¶
POST /api/v1/dialing_task/{task_uuid}/multi_task_modify
概要¶
既存のマルチステップ API テストフローを全体置換します。
呼び出し前の確認と使用手順¶
事前に GET で対象が type=multi であることを確認し、すべてのステップ/ノード/タグをバックアップしてください。部分変更ではなく全体置換です。現在の公開アダプターは task.status を強制的に ok にするため、元のタスクが stop であっても今回の変更で有効化される可能性があります。停止状態を維持する必要がある場合は、2 つのステップ間の実行ウィンドウを評価し、変更後に再度無効化してください。1 回も実行されないことは保証できません。各 stepId は無条件に再生成されるため、古い識別子を引き続き参照として使用することはできません。
HTTP ステップのリクエスト本文はオブジェクトですが、サーバー側で保存前に JSON 文字列へ変換されます。レスポンス内の steps[].task はオブジェクトではありません。GET/POST/PUT/HEAD のみをサポートし、URL は公開正規表現を満たす必要があります。スクリプト/条件は post_mode と競合してはいけません。extracted_vars は構造と依存関係のみをチェックします。現在 check_extracted_vars のオンライン抽出チェックは実行されず、field が実際に存在することや後続の変数参照が成功することは保証されません。wait の業務要件では 1~180 秒を明示してください。空のステップや待機値の欠落は、事前に拒否されない場合もありますが、サポートされる実行設定ではありません。
ノード/配信/データベースコミットはアトミックトランザクションではありません。失敗時にはリモート側に実行設定が既に存在する可能性があるため、まず uuid/名前で読み戻し、重複作成しないでください。変更時に tags を省略するとタグがクリアされ、regions は全体置換されます。無料/体験ワークスペースの頻度制限は通常タスクと同じです。カスタム Synthetic テストを参照して HTTP の詳細項目を理解してください。
ルートパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| task_uuid | string | Y | 現在のマルチステップタスクである必要があり、ステップ ID やノード UUID ではありません。 例: dial_example取得/入力方法: リストからこのワークスペースの type=multi タスクの uuid を取得します。 |
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得/入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト Body パラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| regions[*] | string | 単一ノードの UUID。異なるプロトコルのノード機能は実際のプラットフォームで確認してください。 例: reg_example取得/入力方法: 現在使用可能なノードレコードの uuid を使用し、ノード名/都市名や keycode は使用しません。 |
|
| tags[*] | string | 名前で重複排除され、tag_ UUID ではありません。Synthetic テストのスコープに合わない場合はエラーになります。 例: production取得/入力方法: 単一の業務タグ名を取得します。 |
|
| task.steps[*] | json | 単一のステップオブジェクト。宣言されていない追加のステップキーは許可されません。 例: {"type": "http", "task": {"name": "检查健康", "method": "GET", "url": "https://example.com/health", "post_mode": "default", "success_when": [{"status_code": [{"is": "200"}]}]}}取得/入力方法: 必要に応じて http リクエストまたは wait 待機ステップを選択します。 |
|
| task.steps[*].type | string | 必須。http/wait。 例: http取得/入力方法: 実際の HTTP フローとステップ要件に従って構築します。 |
|
| task.steps[*].allow_failure | boolean | http のみで任意。失敗時に後続ステップを続行するかどうかであり、タスク全体の成功を保証するものではありません。 例: false取得/入力方法: 実際の HTTP フローとステップ要件に従って構築します。 |
|
| task.steps[*].stepId | string | 任意の空でないステップ識別子。追加時に省略するとサーバー側で生成され、変更時は各 stepId が無条件に再生成されます。安定した外部参照の維持には使用できません。 例: STEP-ID取得/入力方法: 実際の HTTP フローとステップ要件に従って構築します。 |
|
| task.steps[*].value | integer | wait の待機秒数。業務上は 1~180 を指定してください。現在のバリデーションは整数かつ 180 以下であることのみを確認し、必須や下限は強制しません。負の値や省略時の未定義の実行動作に依存しないでください。 例: 5取得/入力方法: 実際の HTTP フローとステップ要件に従って構築します。 |
|
| task.steps[*].extracted_vars | array | 任意の抽出変数配列。field が実際に生成されるかをその場でスクリプト実行して検証するものではありません。 例: []取得/入力方法: 実際の HTTP フローとステップ要件に従って構築します。 |
|
| task.steps[*].task | json | HTTP ステップの業務上必須のリクエストオブジェクト。以下の表のフィールドに限られます。wait では指定しないでください。 例: {}取得/入力方法: 実際の HTTP フローとステップ要件に従って構築します。 |
|
| task.steps[*].extracted_vars[*].name | string | name/field/secure のいずれかを指定する場合は、残りの 2 つも指定する必要があります。任意の配列では各項目を完全なオブジェクトとして送信します。変数名です。 例: TOKEN取得/入力方法: ステップの post_script で実際に生成されるフィールドと後続の参照定義から取得します。 |
|
| task.steps[*].extracted_vars[*].field | string | name/field/secure のいずれかを指定する場合は、残りの 2 つも指定する必要があります。任意の配列では各項目を完全なオブジェクトとして送信します。現在のステップのスクリプト出力から抽出するフィールドであり、直接の変数値ではありません。 例: token取得/入力方法: ステップの post_script で実際に生成されるフィールドと後続の参照定義から取得します。 |
|
| task.steps[*].extracted_vars[*].secure | boolean | name/field/secure のいずれかを指定する場合は、残りの 2 つも指定する必要があります。任意の配列では各項目を完全なオブジェクトとして送信します。安全な変数かどうか。実行プラットフォームが処理します。この API が任意の値をその場で検証/暗号化することを意味するものではありません。 例: true取得/入力方法: ステップの post_script で実際に生成されるフィールドと後続の参照定義から取得します。 |
|
| task.steps[*].task.name | string | 必須の空でないステップリクエスト名。 例: 检查健康取得/入力方法: 現在のステップの対象 API と検証済みの HTTP 判定設定から構築します。 |
|
| task.steps[*].task.method | string | 必須。GET/POST/PUT/HEAD。通常の HTTP の任意メソッドをそのまま適用することはできません。 例: GET取得/入力方法: 現在のステップの対象 API と検証済みの HTTP 判定設定から構築します。 |
|
| task.steps[*].task.url | string | 必須の空でない絶対 HTTP(S) URL。現在のドメイン/TLD 正規表現を通過する必要があります。生 IP/localhost/テンプレートアドレスはこの公開バリデーションで拒否される可能性があるため、先に実際のターゲットで検証してください。 例: https://example.com/health取得/入力方法: 現在のステップの対象 API と検証済みの HTTP 判定設定から構築します。 |
|
| task.steps[*].task.advance_options | json | 任意の HTTP リクエスト/認証/Body/証明書などの詳細オブジェクト。 例: {}取得/入力方法: 現在のステップの対象 API と検証済みの HTTP 判定設定から構築します。 |
|
| task.steps[*].task.success_when | array | デフォルトの判定では指定が必要です。post_mode=default の場合のみ指定でき、スクリプトが空でなければ通常の HTTP 必須条件を代替できます。 例: [{"status_code": [{"is": "200"}]}]取得/入力方法: 現在のステップの対象 API と検証済みの HTTP 判定設定から構築します。 |
|
| task.steps[*].task.success_when_logic | string | and/or。post_mode=default の場合のみ指定できます。 例: and取得/入力方法: 現在のステップの対象 API と検証済みの HTTP 判定設定から構築します。 |
|
| task.steps[*].task.post_mode | string | 必須。default/script。省略可能なデフォルトフィールドではありません。 例: default取得/入力方法: 現在のステップの対象 API と検証済みの HTTP 判定設定から構築します。 |
|
| task.steps[*].task.post_script | string | post_mode=script の場合のみ指定できます。検証済みの Pipeline スクリプトを指定します。空でなければ success_when を代替できます。 例: 取得/入力方法: 現在のステップの対象 API と検証済みの HTTP 判定設定から構築します。 |
|
| task.steps[*].task.advance_options.request_options | json | HTTP/WebSocket に適用可能。任意。HTTP/WebSocket リクエストオプション。 例: {}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_options.follow_redirect | boolean | HTTP/WebSocket に適用可能。任意。リダイレクトに従うかどうか。省略時は実行側のデフォルトに従います。 例: false取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_options.headers | json | HTTP/WebSocket に適用可能。任意。リクエストヘッダー名から文字列値へのマッピング。実際の認証情報をサンプルに書き込まないでください。 例: {"Accept": "application/json"}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_options.headers.请求头名 | string | HTTP/WebSocket に適用可能。任意。動的なリクエストヘッダー値。名前には実際のインターフェースで必要な header 名を指定します。 例: application/json取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_options.cookies | string | HTTP/WebSocket に適用可能。任意。Cookie テキスト。省略可能。 例: 取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_options.auth | json | HTTP/WebSocket に適用可能。任意。HTTP Basic のユーザー名/パスワード設定。省略可能。 例: {}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_options.auth.username | string | HTTP/WebSocket に適用可能。任意。Basic ユーザー名。対象インターフェースの管理者から提供されます。 例: USER-PLACEHOLDER取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_options.auth.password | string | HTTP/WebSocket に適用可能。任意。Basic パスワード。安全な認証情報ソースから注入してください。 例: PASSWORD-PLACEHOLDER取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_body | json | HTTP/WebSocket に適用可能。任意。リクエスト Body の形式と内容。 例: {}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_body.body_type | string | HTTP/WebSocket に適用可能。任意。リクエストの Content-Type。例: application/json/text/plain/text/xml/multipart/form-data。 例: application/json取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_body.body | string | HTTP/WebSocket に適用可能。任意。リクエスト本文の文字列。変更時は必要な業務内容を保持する必要があります。 例: {"check":true}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_body.form | json | HTTP/WebSocket に適用可能。任意。multipart フォームフィールドから文字列へのマッピング。省略可能。 例: {"check": "true"}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_body.form.字段名 | string | HTTP/WebSocket に適用可能。任意。単一のフォーム値。 例: true取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.request_timeout | string | HTTP/WebSocket に適用可能。任意。HTTP の総タイムアウト duration。実行側のデフォルトは 60s です。Studio は実際の実行側の検証を代替しません。 例: 60s取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.protocol | string | HTTP/WebSocket に適用可能。任意。HTTP プロトコル auto/http/1.1/http/2/http/2-only/http/3。サポート状況はノードのバージョンに依存します。HTTP3 では同時にプロキシを設定しないでください。 例: auto取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.certificate | json | HTTP/WebSocket に適用可能。任意。リクエストの TLS 証明書設定。 例: {}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.certificate.ignore_server_certificate_error | boolean | HTTP/WebSocket に適用可能。任意。証明書検証エラーを無視するかどうか。 例: false取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.certificate.certificate | string | HTTP/WebSocket に適用可能。任意。PEM クライアント証明書。対象サービスから提供されます。 例: CERTIFICATE-PLACEHOLDER取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.certificate.private_key | string | HTTP/WebSocket に適用可能。任意。証明書に対応する PEM 秘密鍵。安全なソースを使用してください。 例: PRIVATE-KEY-PLACEHOLDER取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.certificate.ca | string | HTTP/WebSocket に適用可能。任意。CA の内容。一部の HTTP 実行側では保持されるが使用されません。DNS では certificate.ca を直接そのプロトコルに従って解釈します。 例: CA-PLACEHOLDER取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.proxy | json | HTTP/WebSocket に適用可能。任意。HTTP プロキシオブジェクト。ノードがあらゆるプロキシにアクセスできると仮定しないでください。 例: {}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.proxy.url | string | HTTP/WebSocket に適用可能。任意。プロキシ URL。 例: http://proxy.example.com:8080取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.proxy.headers | json | HTTP/WebSocket に適用可能。任意。プロキシ専用の文字列 header マッピング。 例: {}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.proxy.headers.请求头名 | string | HTTP/WebSocket に適用可能。任意。単一のプロキシリクエストヘッダー値。 例: VALUE-PLACEHOLDER取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.secret | json | HTTP/WebSocket に適用可能。任意。過去の HTTP リクエストデータ保存オプション。実行側のサポート状況に従います。 例: {}取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.advance_options.secret.not_save | boolean | HTTP/WebSocket に適用可能。任意。リクエスト内容を保存しないかどうか。返却ドキュメント/ログのマスキングを代替するものではありません。 例: true取得/入力方法: 対象 HTTP インターフェース/ノード設定およびカスタム Synthetic テストに従って構築します。 |
|
| task.steps[*].task.success_when[*].body | array | 任意のアサーション集合。キー名は実際のレスポンスに従います。実行側がサポートする比較のみを使用してください。 例: []取得/入力方法: 実際の HTTP/WebSocket レスポンスから body または特定の header を選択します。 |
|
| task.steps[*].task.success_when[*].body[*].contains | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].body[*].not_contains | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].body[*].is | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].body[*].is_not | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].body[*].match_regex | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].body[*].not_match_regex | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].header.响应头名 | array | 任意のアサーション集合。キー名は実際のレスポンスに従います。実行側がサポートする比較のみを使用してください。 例: []取得/入力方法: 実際の HTTP/WebSocket レスポンスから body または特定の header を選択します。 |
|
| task.steps[*].task.success_when[*].header.响应头名[*].contains | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].header.响应头名[*].not_contains | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].header.响应头名[*].is | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].header.响应头名[*].is_not | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].header.响应头名[*].match_regex | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].header.响应头名[*].not_match_regex | string | 単一テキスト比較。必要な操作に応じて選択します。正規表現の意味は実行側で検証され、保存成功は一致を証明しません。 例: healthy取得/入力方法: 一致させるレスポンステキスト/有効な正規表現を取得します。レスポンス内の機密値をコピーしないでください。 |
|
| task.steps[*].task.success_when[*].header | json | 任意の header 名から条件集合へのマッピング。 例: {}取得/入力方法: 実際のレスポンス header 名を取得します。 |
|
| task.steps[*].task.success_when[*].status_code | array | HTTP の任意ステータスアサーション集合。実行側のプロトコルに従って文字列を比較します。 例: [{"is": "200"}]取得/入力方法: 成功時の HTTP ステータスコードまたは対応する正規表現を選択します。 |
|
| task.steps[*].task.success_when[*].status_code[*].is | string | 単一のステータスコードアサーション操作。mobile expectedResponseCode の整数配列と混用しないでください。 例: 200取得/入力方法: 対象インターフェースの期待ステータス/ステータス正規表現を取得します。 |
|
| task.steps[*].task.success_when[*].status_code[*].is_not | string | 単一のステータスコードアサーション操作。mobile expectedResponseCode の整数配列と混用しないでください。 例: 200取得/入力方法: 対象インターフェースの期待ステータス/ステータス正規表現を取得します。 |
|
| task.steps[*].task.success_when[*].status_code[*].match_regex | string | 単一のステータスコードアサーション操作。mobile expectedResponseCode の整数配列と混用しないでください。 例: 200取得/入力方法: 対象インターフェースの期待ステータス/ステータス正規表現を取得します。 |
|
| task.steps[*].task.success_when[*].status_code[*].not_match_regex | string | 単一のステータスコードアサーション操作。mobile expectedResponseCode の整数配列と混用しないでください。 例: 200取得/入力方法: 対象インターフェースの期待ステータス/ステータス正規表現を取得します。 |
|
| task.steps[*].task.success_when[*].response_time | string | HTTP duration のしきい値であり、TCP の履歴所要時間配列ではありません。 例: 100ms取得/入力方法: 対象 HTTP の総レスポンス所要時間要件に応じて設定します。 |
|
| regions | array | Y | 必須の配列。通常タスクでは空にできません。モバイルタスクでは明示的に [] とする必要があり、代わりに task.nodeSelection を使用します。変更時はノード集合を全体置換し、ノードを削除すると元のノードに停止が配信されます。 null 許容: False 例: ["reg_example"]取得/入力方法: 利用可能なノードリストまたはデフォルトリージョンリストから実際のノード uuid を取得します。 |
| tags | array | 任意。デフォルトは []。変更時に省略するか [] を指定するとタグ関係がクリアされます。モバイルタスクではアウトバウンドタグも同時に同期し、クライアントの dfLabel/extendConfig は受け付けません。 null 許容: False 例: ["production"]取得/入力方法: タグリストから dialing/all スコープに適用できる名前を取得します。UUID ではありません。 |
|
| task | json | Y | 必須の完全なオブジェクト。maxDictLength=20000 はサーバー側の辞書加重長で計算されます。単一の HTTP タスクや文字列ではありません。変更時はステップ/タグ/ノードを全体置換します。 null 許容: False 辞書長の上限: 20000 例: {}取得/入力方法: このページのマルチステッププロトコルに従って HTTP リクエストと待機ステップを組み合わせます。 |
| task.desc | string | 任意。空文字列も可能。省略時に旧値が保持されることは保証されません。 空文字列を許容: True null 許容: False 例: 登录后检查API取得/入力方法: 業務担当者がフローの用途を説明します。 |
|
| task.frequency | string | Y | 必須でデフォルトなし。無料/体験ワークスペースでは 30m/1h/6h/12h/24h のみです。DataKit の手動 JSON の任意の秒単位頻度をそのまま適用しないでください。 null 許容: False 選択可能な値: ['1m', '5m', '15m', '30m', '1h', '6h', '12h', '24h'] 例: 5m取得/入力方法: 業務予算と実行要件に応じて 1m/5m/15m/30m/1h/6h/12h/24h を選択します。 |
| task.name | string | Y | 必須。trim 後 1~256 の Python 文字で、trim 結果を保存します。すべての Synthetic テストタイプで未削除名の一意性を共有します。変更時は完全な名前を指定する必要があります。 null 許容: False 例: 站点可用性取得/入力方法: 業務担当者がこのワークスペースで一意のタスク名を定義します。 |
| task.steps | array | Y | 必須の配列で、業務上は空でない必要があります。公開バリデーションは minLength を強制せず、空配列は保存まで進めますが有効な実行は保証されません。最初のステップを wait にすることはできません。 null 許容: False 例: []取得/入力方法: 実行順に HTTP と wait ステップを編成します。 |
パラメーター補足説明¶
マルチステップ HTTP の詳細項目はカスタム Synthetic テストを参照してください。完全なステップ構造と現在の公開バリデーションの境界については、このページのパラメーターテーブルを参照してください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/dial_example/multi_task_modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"regions":["reg_example"],"task":{"name":"多步健康检查","frequency":"5m","desc":"等待后再次读取","steps":[{"type":"http","allow_failure":false,"extracted_vars":[],"task":{"name":"首次检查","method":"GET","url":"https://example.com/health","post_mode":"default","success_when":[{"status_code":[{"is":"200"}]}],"success_when_logic":"and"}},{"type":"wait","value":5},{"type":"http","allow_failure":false,"extracted_vars":[],"task":{"name":"再次检查","method":"GET","url":"https://example.com/health","post_mode":"default","success_when":[{"status_code":[{"is":"200"}]}]}}]},"tags":[]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | レコード番号。通常の作成では、送信前に構築されるレスポンスで null になる可能性があります。 |
| content.uuid | string | dial_ タスク UUID。以降の get/modify/起動・停止で使用します。 |
| content.workspaceUUID | string | 所属ワークスペース UUID。 |
| content.type | string | 保存されたタスクカテゴリ。mobile の細分プロトコルは task.protocol を参照してください。マルチステップは multi です。 |
| content.status | integer | エンティティ状態。通常は 0、削除は 3。task.status の実行スイッチとは異なります。 |
| content.isLocked | integer または boolean | ローカル/ワークスペースのロックフラグ。リモートの実測状態を表すものではありません。 |
| content.regions | array<string> | 通常タスクの現在のノード UUID 配列。モバイルでは [] です。 |
| content.regions[] | string | ノード UUID。 |
| content.regionsInfo | array または object | 履歴ノードの表示では、UUID 配列、オブジェクト配列、または UUID キーマッピングになる場合があります。作成/変更時は通常、入力 UUID 配列です。 |
| content.regionsInfo[] | string または object | ノード UUID または保存済みノード情報。 |
| content.regionsInfo[].uuid | string | 条件付きで返されるノード UUID。 |
| content.regionsInfo[].name | string | 現在の言語でのノード表示名。 |
| content.regionsInfo[].nameEn | string | 英語/互換名。 |
| content.regionsInfo[].nameI18n | object | 言語から名前へのマッピング。 |
| content.regionsInfo[].nameI18n.语言码 | string | 単一の表示名。 |
| content.regionsInfo.节点UUID | string または object | 履歴 UUID キーマッピング内のノード情報。配列内のノード情報と同じ意味です。 |
| content.task | object | 保存済みタスクの完全な設定。リアルタイムの Synthetic テスト結果は含みません。 |
| content.remoteStatus | string | mobile では unknown 固定。ローカル読み取りのみで、プラットフォームをリアルタイムに照会しません。 |
| content.creator | string | 作成者の識別情報。 |
| content.updator | string | 更新者の識別情報。 |
| content.createAt | integer | 作成 Unix 秒。 |
| content.updateAt | integer | 更新 Unix 秒。 |
| content.deleteAt | integer | 削除 Unix 秒。未削除は -1。 |
| content.task.name | string | マルチステップタスク名。 |
| content.task.frequency | string | タスク頻度。 |
| content.task.desc | string | タスク説明。省略可能。 |
| content.task.status | string | 公開マルチステップアダプターは ok を書き込み、変更によって再度有効化される場合もあります。 |
| content.task.config_vars | array | 公開アダプターでは固定で空です。ルートレベルの変数設定は受け付けません。 |
| content.task.steps | array<object> | 保存された実行ステップ。 |
| content.task.steps[].type | string | http/wait。 |
| content.task.steps[].stepId | string | サーバー側のステップ識別子。変更時に再構築されます。 |
| content.task.steps[].allow_failure | boolean | HTTP 失敗時に続行するかどうか。 |
| content.task.steps[].value | integer | 待機秒数。 |
| content.task.steps[].extracted_vars | array<object> | 抽出変数の定義。 |
| content.task.steps[].extracted_vars[].name | string | 変数名。 |
| content.task.steps[].extracted_vars[].field | string | 抽出フィールド。 |
| content.task.steps[].extracted_vars[].secure | boolean | 安全フラグ。 |
| content.task.steps[].task | string | HTTP ステップ設定は JSON 文字列として保存され、リクエスト時のオブジェクトとは異なります。JSON デコード後に、このページの HTTP ステップフィールドに従って読み取る必要があります。 |
| content.declaration | object | 共通宣言。 |
{
"code": 200,
"content": {
"id": 100,
"uuid": "dial_example",
"workspaceUUID": "wksp_example",
"type": "multi",
"status": 0,
"isLocked": false,
"regions": [
"reg_example"
],
"regionsInfo": [
"reg_example"
],
"task": {
"name": "多步健康检查",
"frequency": "5m",
"desc": "等待后再次读取",
"steps": [
{
"type": "http",
"allow_failure": false,
"extracted_vars": [],
"task": "{\"name\": \"首次检查\", \"method\": \"GET\", \"url\": \"https://example.com/health\", \"post_mode\": \"default\", \"success_when\": [{\"status_code\": [{\"is\": \"200\"}]}], \"success_when_logic\": \"and\"}",
"stepId": "STEP-1"
},
{
"type": "wait",
"value": 5,
"stepId": "STEP-2"
},
{
"type": "http",
"allow_failure": false,
"extracted_vars": [],
"task": "{\"name\": \"再次检查\", \"method\": \"GET\", \"url\": \"https://example.com/health\", \"post_mode\": \"default\", \"success_when\": [{\"status_code\": [{\"is\": \"200\"}]}]}",
"stepId": "STEP-3"
}
],
"status": "ok",
"config_vars": []
},
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427200,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
通常のダウンストリーム dialtesting.invalidRegion は ft.DialingRegionError にマッピングされ、実際の HTTP を保持します。その他の 4xx は実際の HTTP と error_code/message を保持でき、>=500 は一律 500 になります。設定の保存は、各ステップが実際に成功したことを意味しません。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンス説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドが欠落しているか、フィールド値が宣言されたバリデーション条件に違反しています | パラメーター解析に失敗しました | パラメーターの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | Body のトップレベルが JSON オブジェクトではありません | 一部の json ファイル形式エラー | regions/task などのフィールドを含む完全な JSON オブジェクトを送信してください。 |
| 400 | ft.InvalidDialingRegion | 通常タスクの regions が空です | 無効な Synthetic テストリージョン | 利用可能なノードリストから少なくとも 1 つの実際のノード UUID を選択してください。モバイルタスクは例外で [] が必須です。 |
| 400 | ft.ParamsValidateError | タスク名、またはステップの type/HTTP メソッド/URL/post_mode/変数依存関係/待機上限がこのページの契約に適合していません | パラメーター検証失敗: {} | マルチステップパラメーターテーブルに従って完全なステップを修正してください。通常の HTTP の任意メソッド/フィールドをそのまま適用することはできません。 |
| 406 | ft.MissingSuccessWhen | 対応するプロトコルで success_when が不足しており、サポートされるスクリプトによる代替もありません | 利用可能な判定 success_when がありません |
プロトコルに従って完全な可用性判定を送信してください。 |
| 400 | ft.TaskNameRepeat | このワークスペースの未削除タスクに同名のものがあります(すべての Synthetic テストタイプを横断) | 現在のワークスペースに同名のタスク {} が既に存在します |
既存の UUID を変更するか、名前を変更してください。名前は trim 後に比較されます。 |
| 403 | ft.InvalidTimeFrequency | 無料/体験ワークスペースでサポートされていない頻度を使用しています | 時間頻度が無効です | 30m/1h/6h/12h/24h に変更するか、バージョンのサポートを確認してください。 |
| 400 | ft.TagScopeMismatch | タグを dialing スコープに使用できません | タグスコープが一致しません | all/dialing タグを使用するか、確認のうえスコープを更新してください。 |
| 406 | ft.NotFoundWorkspace | 書き込みロック時にワークスペースレコードが存在しません | 指定されたワークスペースが見つかりません | ワークスペースの状態を確認し、解放済みのワークスペースへの書き込みを停止してください。 |
| 400 | ft.DialingServerError | モバイルプラットフォーム/バインド/ノード選択/レスポンス不一致、または呼び出し失敗、あるいは通常のダウンストリームが対応する 400 を返した | Synthetic テストサービス API の呼び出しに失敗しました | content.reason/outcomeUnknown/taskUUID/localSaved に従ってローカルとリモートの状態を確認してください。不明な結果をむやみに再作成しないでください。 |
| 400 | ft.DialingRegionError | 通常のダウンストリーム 400 が dialtesting.invalidRegion と判定 | 現在のタスクで一部の Synthetic テストノードが無効です。設定を更新して再保存してください。 | 無効になったノードを交換して再保存してください。その他の HTTP は以下のエラー範囲に従って処理します。 |
| 500 | ft.InternalServerError | 捕捉されていないストレージ/型エラー、通常の Synthetic テストダウンストリームの 5xx、接続タイムアウト、または送信後の処理失敗 | 内部エラー | まずタスク UUID/名前で読み戻して配信状態を確認し、その後に再試行を判断してください。traceId を保持してください。 |
| 406 | ft.FirstStepsNotWait | 最初のステップが wait です | 無効なステップパラメーターです。最初のステップを待機にすることはできません | HTTP リクエストで開始してください。 |
| 404 | ft.NotFoundDialTask | このワークスペースで変更対象のタスクが存在しないか、削除済みです | 指定されたクラウド Synthetic テストタスクが見つかりません | リストから type=multi の実際のタスク uuid を取得してください。 |
| 406 | ft.DialingBrandNoSetError | ワークスペースに対応する通常の Synthetic テストサービスが設定されていません | {} ブランドの Synthetic テスト設定が構成されていません。 |
管理者がワークスペースの Synthetic テストサービスを確認してください。 |
| 400 | ft.DialingAKNoSetError | 配信署名認証情報が設定されていません | Synthetic テスト AK 情報が構成されていません。Launcher のアクティベーション設定を確認してください | 管理者が Synthetic テストサービスのアクティベーション情報を確認してください。 |