無効化/有効化¶
POST /api/v1/dialing_task/set_disable
概要¶
Synthetic テストを一括で有効化または停止します。
呼び出し前の確認と使用手順¶
まず一覧/get で設定と現在の状態を確認してから、一括設定します。通常タスクは現在の完全な設定を使用して再送信し、項目ごとに送信します。DNS を有効化する場合は DNS 構造/変数を再度検証します。モバイル有効化前にはバッチ全体で HTTP が HTTPS であることを事前チェックし、規約を確認します。実際に項目ごとに有効化する前にも再度確認します。mobile の有効化では先に現在の設定を同期してからスイッチを送信します。無効化ではモバイルサービスの現在の有効化や規約の再同意を要求しませんが、有効なプラットフォームバインディングは依然として必要であり、リモート呼び出しを伴わないローカルスイッチではありません。
デフォルトでは、本ワークスペース内の削除されていない一致対象のみを処理します。空配列またはすべて一致しない場合も true で成功し、項目ごとのヒット一覧は返しません。タスク間/リモートとローカルはアトミックなバッチではありません。前の項目が送信済みで後続が失敗しても全体はロールバックされません。エラー発生後は、まず各 task.status と一覧上の存在を読み戻します。mobile の 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 を取得します。 |
|
| isDisable | boolean | Y | 必須のブール値。task.status=stop/ok を更新します。エンティティや元の Synthetic テスト履歴は削除しません。 null の許可: False 例: true取得または入力方法: true で停止、false で有効化。 |
| taskUUIDs | array | Y | 必須の配列。空でないことを推奨します。dial_ タスクのみを選択し、ノード/テンプレート/リモート id を混在させないでください。一致しない UUID または削除済み UUID は項目ごとにエラーを報告しません。 null の許可: False 例: ["dial_example"]取得または入力方法: Synthetic テスト一覧 から本ワークスペースの削除されていないタスク uuid を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"taskUUIDs":["dial_example"],"isDisable":true}'
レスポンス¶
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 です。mobile の失敗時には 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 を提供したうえで段階的に処理してください。 |
| 400 | ft.ParamsValidateError | モバイル HTTP の有効化時に HTTPS でない、DNS/TCP 設定の有効化が無効、または旧 NetPath/browser が有効化/停止の送信前にコントラクトに適合しない | パラメータ検証失敗: {} | 実際のタイプに応じて修正してください。DNS 停止/削除は DNS コントラクトをスキップし、TCP 停止/削除は success_when のみをチェックし、すべての接続条件を再検証しません。 |
| 403 | ft.MobileDialTermsNotAccepted | モバイル有効化前にワークスペースが規約を確認していない | 先にワークスペースの Owner または管理者がモバイル Synthetic テスト利用規約を確認してください。 | ログイン状態のワークスペース Owner/管理者が読んで確認してください。 |
| 400 | ft.InvalidAction | モバイル有効化時に機能が有効になっていない、または現在の操作状態では許可されていない | 無効な操作 | reason を確認し、管理者が可用性を確認してください。クローズ状態でも停止/削除を試行できます。 |
| 404 | ft.ObjectNotExists | DNS 有効化時に参照変数が本ワークスペースの有効な集合に属していない | 指定されたオブジェクトが存在しません | 先に変数参照を修正してください。 |
| 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 書き込みはホワイトリスト制限を受けるため、サポート窓口/管理者経由で修復してから再試行してください。 |