マルチステップ API テストを作成¶
POST /api/v1/dialing_task/multi_task_add
概要¶
HTTP リクエストと待機ステップで構成されるマルチステップ API テストを作成します。
呼び出し前の準備と使用手順¶
実際に利用可能なデフォルト/セルフホストノードに基づいて regions を選択し、HTTP と待機を含む完全なフローを作成します。作成時は type=multi、task.status=ok、ルートの config_vars=[] が強制され、成功後はすぐに周期実行および課金される可能性があります。本ページでは type/status/config_vars を送信しません。最初のステップは HTTP である必要があります。
HTTP ステップのリクエストボディはオブジェクトですが、サーバー側で保存前に JSON 文字列へ変換されます。レスポンス内の steps[].task はオブジェクトではありません。GET/POST/PUT/HEAD のみをサポートし、URL は公開正規表現を満たす必要があります。スクリプト/条件は post_mode と競合してはいけません。extracted_vars は構造と依存関係のみを検査し、現在は check_extracted_vars によるオンライン抽出チェックを実行していないため、field が実在することや後続の変数参照が成功することは保証されません。wait は業務上 1~180 秒を明示すべきです。空のステップや待機値の欠落は事前に拒否されない場合がありますが、サポートされる実行設定として扱いません。
ノード/配信/データベースへのコミットはアトミックトランザクションではなく、失敗時にはすでにリモート実行設定が存在する可能性があります。まず uuid/名前で読み戻し、重複して作成しないでください。変更時に tags を省略するとタグがクリアされ、regions は全体置換されます。無料/体験プランの頻度制限は通常のタスクと同じです。HTTP の詳細項目を理解するには、カスタム Synthetic テストを参照してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 つも指定する必要があります。任意の配列では各項目を完全なオブジェクトとして送信します。安全な変数かどうか。実行プラットフォームが処理します。本インターフェースが任意の値をその場で検証/暗号化することを意味しません。 例: 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 | 単一のステータスコードアサーション操作。モバイルの expectedResponseCode 整数配列と混用しないでください。 例: 200取得方法または入力方法: 対象インターフェースで期待されるステータス/ステータス正規表現を取得します。 |
|
| task.steps[*].task.success_when[*].status_code[*].is_not | string | 単一のステータスコードアサーション操作。モバイルの expectedResponseCode 整数配列と混用しないでください。 例: 200取得方法または入力方法: 対象インターフェースで期待されるステータス/ステータス正規表現を取得します。 |
|
| task.steps[*].task.success_when[*].status_code[*].match_regex | string | 単一のステータスコードアサーション操作。モバイルの expectedResponseCode 整数配列と混用しないでください。 例: 200取得方法または入力方法: 対象インターフェースで期待されるステータス/ステータス正規表現を取得します。 |
|
| task.steps[*].task.success_when[*].status_code[*].not_match_regex | string | 単一のステータスコードアサーション操作。モバイルの 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/multi_task_add' \
-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.tagInfo | array<object> | 有効なタグ概要。空は []。通常の変更では省略される場合があり、mobile の変更では返されます。読み取り時の id はデータベース数値で、書き込み時に生成される概要 id はタグ UUID 文字列の場合があります。 |
| content.tagInfo[].id | integer または string | 読み取り時はデータベース番号、書き込み時はタグ UUID。 |
| content.tagInfo[].uuid | string | 読み取ったタグ UUID。書き込み分岐では省略可能。 |
| content.tagInfo[].name | string | タグ名。 |
| content.tagInfo[].description | string | 読み取ったタグ説明。 |
| content.tagInfo[].colour | string | 読み取ったタグ色。 |
| content.tagInfo[].scope | array<string> | 書き込み概要には正規化されたスコープが付く場合があります。 |
| content.tagInfo[].scope[] | string | 単一スコープ。 |
| content.declaration | object | 共通宣言。 |
{
"code": 200,
"content": {
"id": null,
"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,
"tagInfo": [],
"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 テストサービスインターフェースの呼び出しに失敗しました | 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 リクエストで開始してください。 |
| 406 | ft.InvalidDialingTask | 通常の新規追加失敗後の停止補償が dialtesting.invalidTask を返す | 無効な task パラメータです | まずマルチステップタスクとリモート配信状態を確認し、重複作成を避けてください。 |
| 406 | ft.DialingBrandNoSetError | ワークスペースに対応する通常の Synthetic テストサービスが未設定 | {} ブランドの Synthetic テスト設定が未構成です。 |
管理者がワークスペースの Synthetic テストサービスを確認してください。 |
| 400 | ft.DialingAKNoSetError | 配信署名認証情報が未設定 | Synthetic テストの AK 情報が未設定です。Launcher のアクティベーション設定を確認してください | 管理者が Synthetic テストサービスのアクティベーション情報を確認してください。 |