[Mobile Synthetic Testing] Clone Task¶
POST /api/v1/dialing_task/{task_uuid}/clone
Overview¶
Create an independent new task from an existing mobile synthetic test task.
Prerequisites and Usage Steps¶
Only existing mobile sources in the current workspace are supported. The clone copies the source's writable protocol/address/frequency/node selection snapshot, removes internal platform bindings/reporting credentials/runtime status, and recreates a remote task with a new name and new task UUID. It is not a snapshot backup and does not modify the source task.
A new task is enabled by default on success, which may increase scheduled executions and charges; you cannot copy the source's stop status to guarantee the clone is stopped. If tags is omitted, the source's current tags are inherited; [] explicitly means no tags. The mobile creation contract, node selection/terms/quota frequency, and name validation are run again: historical configurations such as legacy non-HTTPS HTTP cannot bypass them. If a failure occurs, the task may already have been saved locally or the remote result may be unknown. Read back by content.taskUUID/localSaved/outcomeUnknown first to avoid duplicate cloning.
Route Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
| task_uuid | string | Y | Clone source task. Standard tasks are rejected; this is not a template or remote ID. Example: dial_exampleHow to obtain or enter: Obtain the UUID of a type=mobile task in the current workspace from the task list. |
Request Headers¶
| Parameter | Type | Required | Description |
|---|---|---|---|
| DF-API-KEY | string | Y | OpenAPI authentication credential for the workspace. Example: <DF-API-KEY>How to obtain or enter: Obtain an OpenAPI key with the required permission for this operation from API Key Management in the target workspace. |
Body Request Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
| tags[*] | string | Name deduplication; this is not tag_ UUID; an error is reported if it does not match the synthetic testing scope. Example: productionHow to obtain or enter: Use a single business tag name. |
|
| name | string | Y | Required. After trimming, 1..256 characters. No copy suffix is added automatically. Example: 移动HTTPS检查副本How to obtain or enter: Specify an unused name in the current workspace for the new task. |
| tags | array | Optional. If omitted entirely, inherits the source's current tags; explicit [] means no tags; this is not retaining a same-name task from the source. Example: ["production"]How to obtain or enter: Specify tag names applicable to the dialing scope as needed. |
Request Example¶
curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/dial_example/clone' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"移动HTTPS检查副本"}'
Response¶
HTTP 200, application/json. The example below shows the main fields that can be read directly.
| Field | Type | Description |
|---|---|---|
| content.id | integer or null | Record number. In normal create responses constructed before submission, this may be null. |
| content.uuid | string | dial_ task UUID; used by subsequent get/modify/start or stop operations. |
| content.workspaceUUID | string | UUID of the workspace to which the task belongs. |
| content.type | string | Saved task category; for mobile subtypes, see task.protocol; multistep tasks use multi. |
| content.status | integer | Entity status, usually 0, deleted 3; distinct from the task.status runtime switch. |
| content.isLocked | integer or boolean | Local/workspace lock flag; does not represent the remote measured status. |
| content.regions | array<string> | Array of current node UUIDs for standard tasks; [] for mobile. |
| content.regions[] | string | Node UUID. |
| content.regionsInfo | array or object | Historical node display may be a UUID array, an object array, or a UUID-keyed map; on create/modify it is usually the input UUID array. |
| content.regionsInfo[] | string or object | Node UUID or saved node profile. |
| content.regionsInfo[].uuid | string | Node UUID returned conditionally. |
| content.regionsInfo[].name | string | Display name of the node in the current language. |
| content.regionsInfo[].nameEn | string | English/compatibility name. |
| content.regionsInfo[].nameI18n | object | Map from language to name. |
| content.regionsInfo[].nameI18n.语言码 | string | A single display name. |
| content.regionsInfo.节点UUID | string or object | Node profile in the historical UUID-keyed map, with the same semantics as array node profiles. |
| content.task | object | Complete configuration of the saved task; does not include real-time synthetic test results. |
| content.task.status | string | ok enabled/stop stopped; the local configuration value does not guarantee full remote synchronization. |
| content.task.external_id | string | Some standard write responses may include a server-side task identifier; list/get removes this internal key, and it is not a writable field. |
| content.task.owner_external_id | string | Some standard write responses may include a server-side workspace identifier; list/get removes it, and it must not be submitted. |
| content.task.post_url | string | Some legacy standard write responses may include a server-side reporting URL; list/get removes it. Handle sensitive responses securely and never write it back or expose it. |
| content.task.其他历史字段 | JSON | Compatibility saved fields are interpreted by type and are not part of the writable whitelist for this public endpoint. |
| content.remoteStatus | string | mobile is fixed to unknown; local read only, no real-time platform query. |
| content.creator | string | Creator identity. |
| content.updator | string | Updater identity. |
| content.createAt | integer | Creation Unix seconds. |
| content.updateAt | integer | Update Unix seconds. |
| content.deleteAt | integer | Deletion Unix seconds; -1 if not deleted. |
| content.task.name | string | Required. After trimming, 1..256 Python characters; the trimmed result is saved. All synthetic test types share non-deleted name uniqueness. Modifications must provide the complete name. |
| content.task.frequency | string | Required, no default; Free/Trial workspaces support only 30m/1h/6h/12h/24h. Do not apply arbitrary second-level frequencies from hand-written DataKit JSON. |
| content.task.schedule_type | string | Optional; if omitted, the executor's regular frequency applies. mobile supports only frequency and does not support crontab. |
| content.task.crontab | string | Required non-empty and must pass Cron parsing when schedule_type=crontab; frequency is still a required public declaration; mobile does not accept this field. Time zone/execution cadence must be verified against the actual node environment and cannot be treated as a Unix timestamp. |
| content.task.url | string | Fill in according to the protocol for HTTP/WebSocket; optional at the public layer but required for task execution. Not used for mobile; for mobile, fill in address. Browser has additional entry restrictions. |
| content.task.method | string | Required for HTTP operations; if missing, MissingMethod is reported. Omit for other protocols; not every method is guaranteed to be supported by the executor. |
| content.task.success_when_logic | string | Optional and/or; the executor usually defaults to and; NetPath must explicitly provide it; this does not control the alert notification policy. |
| content.task.success_when | array | HTTP without a non-empty post_script, TCP/ICMP/WebSocket/SSL require this key; DNS must have 1..20 valid leaves; NetPath must be a single outer object. Structures for different protocols cannot be mixed. Saving does not require real-time execution success. |
| content.task.success_when[] | json | A single condition object; outer condition logic is controlled by success_when_logic. The semantics of inner conditions are validated by the corresponding executor. |
| content.task.enable_traceroute | boolean | Optional; if omitted, Studio does not add a unified default; NetPath uses its own path protocol and does not mix in this field. |
| content.task.packet_count | integer | ICMP optional, number of packets sent per round; actual node constraints are confirmed by the executor; not used for mobile pingCount. |
| content.task.host | string | Required for the corresponding protocol operation. NetPath must be non-empty after trimming; no HTTP URL scheme is needed. For mobile TCP, fill in address=host:port instead. |
| content.task.port | string | Required for TCP/SSL operations; NetPath TCP/UDP 1..65535 and numeric only (leading zeros may be retained); ICMP ignores it. DNS has a separate protocol port; default 53, or 853 for encrypted protocols as determined by the executor. |
| content.task.server_name | string | SSL/DNS optional; when using server_ip to pin the connection IP, retain the original service identity; do not directly fill in an IP in place of the SNI. |
| content.task.timeout | string | TCP is an integer-second string from 1s..60s; DNS defaults to 10s, executor range (0,60s], and variable templates may be used; ICMP/SSL are supported according to the executor, and Studio does not add unified defaults. NetPath uses advance_options.timeout. |
| content.task.ignore_server_certificate_error | boolean | SSL optional; if omitted, the executor's secure default applies; the DNS certificate ignore switch is placed in certificate. |
| content.task.message | string | Required for WebSocket operations; UTF-8 must not exceed 128 KiB; not used for mobile TCP tcpData. |
| content.task.post_mode | string | Optional; the method selected by the executor. Whether Studio HTTP requires success_when is actually determined by a non-empty post_script, not solely by this field. |
| content.task.post_script | string | Optional; an empty string means no script is provided. For HTTP, when non-empty, success_when may be omitted; DNS/NetPath/mobile do not bypass their specific whitelists and validation because of a script. |
| content.task.advance_options | json | Optional object; NetPath requires it and strictly allows only the six fields on this page. HTTP requests, certificates/proxies, etc. must be supported by the executor in practice; protocol validation is not equivalent to online testing. |
| content.task.advance_options_headless | json | Kept in the public declaration but cannot replace the required browser_config. Currently, adding/modifying a browser through the public API cannot pass the complete configuration; do not treat this object as a browser script entry. |
| content.task.advance_options.request_options | json | Applicable to HTTP/WebSocket, optional; request options for HTTP/WebSocket. |
| content.task.advance_options.request_options.follow_redirect | boolean | Applicable to HTTP/WebSocket, optional; whether to follow redirects; if omitted, the executor default applies. |
| content.task.advance_options.request_options.headers | json | Applicable to HTTP/WebSocket, optional; map of header names to string values; do not write real credentials into examples. |
| content.task.advance_options.request_options.headers.请求头名 | string | Applicable to HTTP/WebSocket, optional; dynamic header value; the name should be the header required by the actual API. |
| content.task.advance_options.request_options.cookies | string | Applicable to HTTP/WebSocket, optional; Cookie text; may be omitted. |
| content.task.advance_options.request_options.auth | json | Applicable to HTTP/WebSocket, optional; HTTP Basic username/password configuration; may be omitted. |
| content.task.advance_options.request_options.auth.username | string | Applicable to HTTP/WebSocket, optional; Basic username, provided by the target API administrator. |
| content.task.advance_options.request_options.auth.password | string | Applicable to HTTP/WebSocket, optional; Basic password; inject from a secure credential source. |
| content.task.advance_options.request_body | json | Applicable to HTTP/WebSocket, optional; request Body format and content. |
| content.task.advance_options.request_body.body_type | string | Applicable to HTTP/WebSocket, optional; request Content-Type, such as application/json/text/plain/text/xml/multipart/form-data. |
| content.task.advance_options.request_body.body | string | Applicable to HTTP/WebSocket, optional; request body string; modifications must retain necessary business content. |
| content.task.advance_options.request_body.form | json | Applicable to HTTP/WebSocket, optional; map of multipart form fields to strings; may be omitted. |
| content.task.advance_options.request_body.form.字段名 | string | Applicable to HTTP/WebSocket, optional; a single form value. |
| content.task.advance_options.request_timeout | string | Applicable to HTTP/WebSocket, optional; HTTP total timeout duration; executor default 60s; Studio does not replace actual executor validation. |
| content.task.advance_options.protocol | string | Applicable to HTTP/WebSocket, optional; HTTP protocol auto/http/1.1/http/2/http/2-only/http/3, support depends on node version; do not configure a proxy at the same time as HTTP3. |
| content.task.advance_options.certificate | json | Applicable to HTTP/WebSocket, optional; request TLS certificate configuration. |
| content.task.advance_options.certificate.ignore_server_certificate_error | boolean | Applicable to HTTP/WebSocket, optional; whether to ignore certificate validation errors. |
| content.task.advance_options.certificate.certificate | string | Applicable to HTTP/WebSocket, optional; PEM client certificate, provided by the target service. |
| content.task.advance_options.certificate.private_key | string | Applicable to HTTP/WebSocket, optional; PEM private key corresponding to the certificate; use a secure source. |
| content.task.advance_options.certificate.ca | string | Applicable to HTTP/WebSocket, optional; CA content; some HTTP executors retain but do not use it; for DNS, certificate.ca is interpreted according to the DNS protocol. |
| content.task.advance_options.proxy | json | Applicable to HTTP/WebSocket, optional; HTTP proxy object; do not assume nodes can access arbitrary proxies. |
| content.task.advance_options.proxy.url | string | Applicable to HTTP/WebSocket, optional; proxy URL. |
| content.task.advance_options.proxy.headers | json | Applicable to HTTP/WebSocket, optional; proxy-specific string header map. |
| content.task.advance_options.proxy.headers.请求头名 | string | Applicable to HTTP/WebSocket, optional; a single proxy request header value. |
| content.task.advance_options.secret | json | Applicable to HTTP/WebSocket, optional; legacy HTTP request data retention option; subject to executor support. |
| content.task.advance_options.secret.not_save | boolean | Applicable to HTTP/WebSocket, optional; whether request content is not saved; this cannot replace masking of returned documents/logs. |
| content.task.success_when[].body | array | Optional assertion collection; key names depend on the actual response; use only comparisons supported by the executor. |
| content.task.success_when[].body[].contains | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].body[].not_contains | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].body[].is | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].body[].is_not | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].body[].match_regex | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].body[].not_match_regex | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].header.响应头名 | array | Optional assertion collection; key names depend on the actual response; use only comparisons supported by the executor. |
| content.task.success_when[].header.响应头名[].contains | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].header.响应头名[].not_contains | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].header.响应头名[].is | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].header.响应头名[].is_not | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].header.响应头名[].match_regex | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].header.响应头名[].not_match_regex | string | Single text comparison; choose according to the required operation; regex semantics are validated by the executor, and a successful save does not prove a match. |
| content.task.success_when[].header | json | Optional map of header names to condition collections. |
| content.task.success_when[].status_code | array | HTTP optional status assertion collection; compare strings according to the executor protocol. |
| content.task.success_when[].status_code[].is | string | Single status code assertion operation; do not mix with mobile expectedResponseCode integer arrays. |
| content.task.success_when[].status_code[].is_not | string | Single status code assertion operation; do not mix with mobile expectedResponseCode integer arrays. |
| content.task.success_when[].status_code[].match_regex | string | Single status code assertion operation; do not mix with mobile expectedResponseCode integer arrays. |
| content.task.success_when[].status_code[].not_match_regex | string | Single status code assertion operation; do not mix with mobile expectedResponseCode integer arrays. |
| content.task.success_when[].response_time | string or array | HTTP/WebSocket/DNS use a duration threshold string; historical TCP/ICMP may be a condition array; the response time unit is defined by the corresponding leaf field and cannot be uniformly interpreted as a bare millisecond number. |
| content.task.success_when[].response_time[].is_contain_dns | boolean | Used only for the array shape; whether TCP/ICMP includes DNS time in the comparison. |
| content.task.success_when[].response_time[].target | string | Used only for the array shape; duration comparison value. |
| content.task.success_when[].connection | array | TCP optional, but when present must be a non-empty array, and only eq established/refused/timeout are allowed. |
| content.task.success_when[].connection[].op | string | Required; only eq; is/ne are not accepted. |
| content.task.success_when[].connection[].target | string | Required; established/refused/timeout connection result. |
| content.task.domain | string | Required for the operation; the domain name to query; verified variable templates may be used. |
| content.task.dns_server | string | Required for non-DoH; server domain/IP without port; DoH may be derived from the URL. |
| content.task.server_ip | string | Optional fixed connection IP; retains the logical server identity; if omitted, the executor resolves it. |
| content.task.record_types | array | Optional A/AAAA/CNAME/MX/NS/TXT; may be inferred from assertions; executor default A. |
| content.task.record_types[] | string | Single record type or valid variable template. |
| content.task.protocol | string | DNS: auto/udp/tcp/dot/doh/doq (omit for auto); NetPath: tcp/udp/icmp (required); mobile: http/dns/tcp/ping (required). |
| content.task.certificate | json | DNS optional TLS certificate object; not placed in advance_options for HTTP. |
| content.task.doh | json | DNS DoH protocol configuration. |
| content.task.doh.url | string | DoH required URL. |
| content.task.doh.method | string | Optional GET/POST; if omitted, the executor handles it. |
| content.task.doh.http_protocol | string | Optional auto/http/1.1/http/2-only/http/3. |
| content.task.doh.headers | json | Optional HTTP request header string map. |
| content.task.doh.headers.请求头名 | string | A single string request header. |
| content.task.dns_options | json | Optional DNS query flags/EDNS parameters. |
| content.task.dns_options.recursion_desired | boolean | Optional RD recursive query flag; if omitted, the executor default applies. |
| content.task.dns_options.dnssec_ok | boolean | Optional DO DNSSEC flag. |
| content.task.dns_options.checking_disabled | boolean | Optional CD checking disabled flag. |
| content.task.dns_options.udp_payload_size | integer | Optional EDNS UDP payload size in bytes; semantic range is validated by the executor. |
| content.task.certificate.ca | string | DNS optional; PEM CA. |
| content.task.certificate.certificate | string | DNS optional; PEM client certificate. |
| content.task.certificate.private_key | string | DNS optional; PEM private key; inject securely. |
| content.task.certificate.ignore_server_certificate_error | boolean | DNS optional; whether to ignore certificate validation. |
| content.task.success_when[].authenticated_data | boolean | DNS optional leaf; together with other leaves, must not exceed 20. |
| content.task.success_when[].at_least_one_record | json | Optional, but when present must be a non-empty object, grouped by record type. |
| content.task.success_when[].at_least_one_record.of_type_a | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].at_least_one_record.of_type_a[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_a[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_a[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_a[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_a[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_aaaa | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].at_least_one_record.of_type_aaaa[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_aaaa[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_aaaa[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_aaaa[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_aaaa[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_cname | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].at_least_one_record.of_type_cname[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_cname[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_cname[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_cname[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_cname[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_mx | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].at_least_one_record.of_type_mx[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_mx[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_mx[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_mx[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_mx[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_ns | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].at_least_one_record.of_type_ns[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_ns[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_ns[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_ns[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_ns[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_txt | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].at_least_one_record.of_type_txt[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_txt[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_txt[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_txt[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].at_least_one_record.of_type_txt[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record | json | Optional, but when present must be a non-empty object, grouped by record type. |
| content.task.success_when[].every_record.of_type_a | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].every_record.of_type_a[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_a[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_a[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_a[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_a[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_aaaa | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].every_record.of_type_aaaa[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_aaaa[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_aaaa[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_aaaa[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_aaaa[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_cname | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].every_record.of_type_cname[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_cname[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_cname[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_cname[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_cname[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_mx | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].every_record.of_type_mx[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_mx[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_mx[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_mx[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_mx[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_ns | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].every_record.of_type_ns[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_ns[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_ns[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_ns[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_ns[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_txt | array | When present, must be a non-empty condition array; each item can contain only one comparison key. |
| content.task.success_when[].every_record.of_type_txt[].exists | boolean | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_txt[].is | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_txt[].contains | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_txt[].match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.success_when[].every_record.of_type_txt[].not_match_regex | string | A single DNS condition; exists can only be true; other operations must use non-empty strings. All DNS conditions total 1..20, and an item cannot contain multiple operations at the same time. |
| content.task.advance_options.timeout | string | NetPath only; required, integer seconds from 1s..30s. |
| content.task.advance_options.max_ttl | integer | NetPath only; required TTL upper limit, TCP/ICMP 1..60, UDP 1..255. |
| content.task.advance_options.e2e_queries | integer | NetPath only; required end-to-end probe count 1..100. |
| content.task.advance_options.traceroute_queries | integer | NetPath only; required path probe count 1..10. |
| content.task.advance_options.source_name | string | NetPath only; optional source display name, ≤128 characters after trimming; if empty, it is deleted. |
| content.task.advance_options.target_name | string | NetPath only; optional target display name, ≤128 characters after trimming; if empty, it is deleted. |
| content.task.success_when[].e2e_rtt_avg | array | Non-empty condition array; select at least one metric; unknown metrics cannot be added. |
| content.task.success_when[].e2e_rtt_avg[].op | string | For status, only eq; for numeric/duration values, lt/gt/leq/geq/eq are allowed. |
| content.task.success_when[].e2e_rtt_avg[].target | string | Non-negative millisecond string, e.g. 0.5ms; seconds or bare numbers are not allowed. |
| content.task.success_when[].e2e_rtt_min | array | Non-empty condition array; select at least one metric; unknown metrics cannot be added. |
| content.task.success_when[].e2e_rtt_min[].op | string | For status, only eq; for numeric/duration values, lt/gt/leq/geq/eq are allowed. |
| content.task.success_when[].e2e_rtt_min[].target | string | Non-negative millisecond string, e.g. 0.5ms; seconds or bare numbers are not allowed. |
| content.task.success_when[].e2e_rtt_max | array | Non-empty condition array; select at least one metric; unknown metrics cannot be added. |
| content.task.success_when[].e2e_rtt_max[].op | string | For status, only eq; for numeric/duration values, lt/gt/leq/geq/eq are allowed. |
| content.task.success_when[].e2e_rtt_max[].target | string | Non-negative millisecond string, e.g. 0.5ms; seconds or bare numbers are not allowed. |
| content.task.success_when[].e2e_rtt_variation_avg | array | Non-empty condition array; select at least one metric; unknown metrics cannot be added. |
| content.task.success_when[].e2e_rtt_variation_avg[].op | string | For status, only eq; for numeric/duration values, lt/gt/leq/geq/eq are allowed. |
| content.task.success_when[].e2e_rtt_variation_avg[].target | string | Non-negative millisecond string, e.g. 0.5ms; seconds or bare numbers are not allowed. |
| content.task.success_when[].e2e_rtt_variation_max | array | Non-empty condition array; select at least one metric; unknown metrics cannot be added. |
| content.task.success_when[].e2e_rtt_variation_max[].op | string | For status, only eq; for numeric/duration values, lt/gt/leq/geq/eq are allowed. |
| content.task.success_when[].e2e_rtt_variation_max[].target | string | Non-negative millisecond string, e.g. 0.5ms; seconds or bare numbers are not allowed. |
| content.task.success_when[].e2e_probe_loss_percent | array | Non-empty condition array; select at least one metric; unknown metrics cannot be added. |
| content.task.success_when[].e2e_probe_loss_percent[].op | string | For status, only eq; for numeric/duration values, lt/gt/leq/geq/eq are allowed. |
| content.task.success_when[].e2e_probe_loss_percent[].target | number | Packet loss percentage 0..100, JSON number. |
| content.task.success_when[].hop_count | array | Non-empty condition array; select at least one metric; unknown metrics cannot be added. |
| content.task.success_when[].hop_count[].op | string | For status, only eq; for numeric/duration values, lt/gt/leq/geq/eq are allowed. |
| content.task.success_when[].hop_count[].target | integer | Non-negative JSON integer number of hops. |
| content.task.success_when[].e2e_status | array | Non-empty condition array; select at least one metric; unknown metrics cannot be added. |
| content.task.success_when[].e2e_status[].op | string | For status, only eq; for numeric/duration values, lt/gt/leq/geq/eq are allowed. |
| content.task.success_when[].e2e_status[].target | string | Status reached/partial/failed; e2e_status additionally allows unknown. |
| content.task.success_when[].traceroute_status | array | Non-empty condition array; select at least one metric; unknown metrics cannot be added. |
| content.task.success_when[].traceroute_status[].op | string | For status, only eq; for numeric/duration values, lt/gt/leq/geq/eq are allowed. |
| content.task.success_when[].traceroute_status[].target | string | Status reached/partial/failed; e2e_status additionally allows unknown. |
| content.task.config_vars | array | Optional, defaults to []; NetPath allows only []; mobile does not support it; modification rebinds the input set. IDs referenced by DNS must all belong to valid variables in the current workspace, with no silent filtering. |
| content.task.config_vars[].id | string | DNS validates types by these fields; global variable UUID; required when type=global. |
| content.task.config_vars[].type | string | DNS validates types by these fields; global or a current task local type; browser secret/password/secure ciphertext types have separate retention rules. |
| content.task.config_vars[].name | string | DNS validates types by these fields; template reference variable name. |
| content.task.config_vars[].value | string | DNS validates types by these fields; local variable value; inject from a secure source; omit when not applicable. |
| content.task.config_vars[].example | string | DNS validates types by these fields; preview/example value, not a replacement for the actual target source. |
| content.task.config_vars[].secure | boolean | DNS validates types by these fields; whether it is a secure variable; boolean type. |
| content.task.address | string | Required for mobile; after trimming, non-empty and ≤2048 characters; variables are not allowed. For HTTP, user credentials and whitespace/control characters are prohibited; valid ports/paths/Query are allowed; TCP must have a valid port; ping cannot include a port. |
| content.task.nodeSelection | json | Required for mobile; must have exactly three keys: mode/ids/sampleCount; saves a snapshot and does not dynamically follow the template. nodes validates only the ID structure and retains the original IDs/order, without guaranteeing real-time existence or mapping; groups queries the current group and members and verifies the node set. |
| content.task.nodeSelection.mode | string | Required for mobile; nodes specifies nodes, groups specifies node groups. |
| content.task.nodeSelection.ids | array | Required for mobile; non-empty, unique string array; use the corresponding resource id, not a region UUID. |
| content.task.nodeSelection.ids[] | string | Required for mobile; a single current node or group id; nodes allows only letters, digits, underscores, and hyphens. |
| content.task.nodeSelection.sampleCount | integer | Required for mobile; independent sampling count per node, 1..5, not limited by the number of selected nodes/group members. |
| content.task.protocolOptions | json | Optional, defaults to {}, fully replaced. If HTTP has historical detection fields, modifications must explicitly provide the object; only omitting a detection field from the object clears it; an empty string/null/empty array is not a clear instruction. HTTP defaults to httpMethod=GET, ping defaults to pingType=1; other numeric values are not given defaults by Studio. |
| content.task.protocolOptions.httpMethod | string | http only; optional; if omitted, the platform default applies; GET/POST. |
| content.task.protocolOptions.body | string | http only; optional; if omitted, the platform default applies; request body string. |
| content.task.protocolOptions.httpHost | json | http only; optional; if omitted, the platform default applies; string map; configure according to the target Host. |
| content.task.protocolOptions.httpHost.键名 | string | Dynamic string member; variable templates are not allowed (except expectedResponseBody). |
| content.task.protocolOptions.httpParams | json | http only; optional; if omitted, the platform default applies; Query parameter string map. |
| content.task.protocolOptions.httpParams.键名 | string | Dynamic string member; variable templates are not allowed (except expectedResponseBody). |
| content.task.protocolOptions.httpHeader | json | http only; optional; if omitted, the platform default applies; request header string map. |
| content.task.protocolOptions.httpHeader.键名 | string | Dynamic string member; variable templates are not allowed (except expectedResponseBody). |
| content.task.protocolOptions.expectedResponseBody | string | http only; optional; if omitted, the platform default applies; non-empty raw text containment matching; no trimming and template markers inside are not interpreted. |
| content.task.protocolOptions.expectedResponseCode | array | http only; optional; if omitted, the platform default applies; non-empty JSON integer array, an allowed code set; do not mix with text regex; the actual combination of multiple detection fields is determined by the execution platform contract. |
| content.task.protocolOptions.expectedResponseCode[] | integer | http only; optional; if omitted, the platform default applies; a single JSON integer code; strings/booleans are not allowed. |
| content.task.protocolOptions.dnsHost | string | dns only; optional; if omitted, the platform default applies; DNS server/host string. |
| content.task.protocolOptions.dnsIpVerify | string | dns only; optional; if omitted, the platform default applies; expected DNS resolved IP string. |
| content.task.protocolOptions.tcpHost | string | tcp only; optional; if omitted, the platform default applies; TCP target Host configuration. |
| content.task.protocolOptions.tcpTimeoutMs | integer | tcp only; optional; if omitted, the platform default applies; timeout 1..10000 milliseconds. |
| content.task.protocolOptions.tcpData | string | tcp only; optional; if omitted, the platform default applies; data text to send. |
| content.task.protocolOptions.tcpVerify | string | tcp only; optional; if omitted, the platform default applies; expected response text. |
| content.task.protocolOptions.pingType | integer | ping only; optional; if omitted, the platform default applies; 1/2, omitted is 1. |
| content.task.protocolOptions.pingCount | integer | ping only; optional; if omitted, the platform default applies; packet count 1..10. |
| content.task.protocolOptions.pingTimeoutMs | integer | ping only; optional; if omitted, the platform default applies; timeout 1..10000 milliseconds. |
| content.task.protocolOptions.taskTimeoutMs | integer | http/dns/tcp/ping only; optional; if omitted, the platform default applies; task timeout 1..10000 milliseconds. |
| content.task.protocolOptions.flowLimit | integer | http/dns/tcp/ping only; optional; if omitted, the platform default applies; platform traffic limit integer 1..10; Studio defines no additional unit conversion. |
| content.tagInfo | array<object> | Effective tag summary; [] when empty; standard modifications may omit it, mobile modifications return it. When reading, id is a database number; when writing a generated summary, id may be a tag UUID string. |
| content.tagInfo[].id | integer or string | When reading, a database number; when writing, a tag UUID. |
| content.tagInfo[].uuid | string | Tag UUID for reads; may be omitted in the write branch. |
| content.tagInfo[].name | string | Tag name. |
| content.tagInfo[].description | string | Tag description for reads. |
| content.tagInfo[].colour | string | Tag color for reads. |
| content.tagInfo[].scope | array<string> | The write summary may include a normalized scope. |
| content.tagInfo[].scope[] | string | A single scope. |
| content.declaration | object | Public declaration. |
{
"code": 200,
"content": {
"id": 101,
"uuid": "dial_clone_example",
"workspaceUUID": "wksp_example",
"type": "mobile",
"status": 0,
"isLocked": false,
"regions": [],
"regionsInfo": [],
"task": {
"name": "移动HTTPS检查副本",
"frequency": "5m",
"protocol": "http",
"address": "https://example.com/health",
"nodeSelection": {
"mode": "nodes",
"ids": [
"NODE-ID"
],
"sampleCount": 1
},
"protocolOptions": {
"httpMethod": "GET",
"taskTimeoutMs": 10000,
"expectedResponseCode": [
200
]
},
"status": "ok"
},
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427200,
"deleteAt": -1,
"tagInfo": [],
"remoteStatus": "unknown",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
Error Responses¶
For authentication, rate limiting, and common request errors, see Common Error Definitions.
Mobile remote/local failures may include taskUUID/localSaved/localStatus/remoteStatus/outcomeUnknown; first check whether the clone has already been saved or created remotely; do not treat a failure response as completely unexecuted.
| HTTP Status | errorCode | Trigger Condition | Message or Response Description | Handling |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | Request field is missing, or the field value violates the declared validation conditions | Parameter parsing failed | Check the parameter location, field name, type, and value. |
| 400 | ft.RequestJsonFormatError | Invalid request JSON syntax | Request JSON format error | Fix the JSON according to content.reason, line, column. |
| 400 | ft.JsonFormatError | Body is not an object | Some JSON file format errors | Submit a JSON object containing name and optional tags. |
| 400 | ft.ParamsValidateError | Identifier, node selection structure/range, name, template count, or protocol parameters do not meet the current contract | Parameter validation failed: {} | Fix according to message and optional content.reason/field; first retrieve the target again from the current workspace list. |
| 400 | ft.InvalidAction | Mobile synthetic testing is currently disabled, or an operation/transaction state is not allowed | Invalid operation | The administrator should confirm mobile synthetic testing capability; reading/deleting templates is not automatically prohibited when the switch is off. |
| 400 | ft.DialingServerError | Mobile service call failed, or resource return shape/binding information does not match | Synthetic testing service API call failed | Check reason, outcomeUnknown, and traceId; do not mask upstream failures with missing static mappings. |
| 409 | ft.MobileDialingOperationBusy | Timed out waiting for the workspace mutex; this operation was not executed | Other operations are in progress in the current workspace; this operation was not executed. Try again later. | When operationExecuted=false/retryable=true, retry with backoff; do not overwrite concurrently. |
| 401 | ft.WKSPNotExistOrReleased | After waiting, the workspace no longer exists/has been released | Workspace does not exist or has been released | Stop retrying; verify the valid workspace. |
| 403 | ft.WorkspaceIsLocked | After waiting, the workspace is locked | The workspace is locked and cannot be operated | Confirm unlock and operable status. |
| 404 | ft.NotFoundDialTask | Source task does not belong to the non-deleted set of the current workspace | Specified cloud synthetic testing task not found | Retrieve the mobile source again from the list. |
| 400 | ft.TaskNameRepeat | New name conflicts with an existing non-deleted synthetic testing task in the current workspace | A task with the same name already exists in the current workspace {} |
Use a unique name; do not repeatedly submit the same request with an unknown result. |
| 403 | ft.MobileDialTermsNotAccepted | Workspace has not accepted mobile synthetic testing terms | The workspace Owner or administrator must first confirm the mobile synthetic testing terms of use. | Have the logged-in Owner/administrator read and confirm. |
| 403 | ft.InvalidTimeFrequency | Source frequency is not supported by the current Free/Trial version | Invalid time frequency | First adjust to an allowed frequency or confirm the version. |
| 400 | ft.TagScopeMismatch | Specified/inherited tag is not applicable to synthetic testing | Tag scope mismatch | Use a valid dialing/all tag. |
| 500 | ft.InternalServerError | Exception in storage read, historical configuration, or local static mapping formatting | Internal error | Narrow down to a specific task/template or filter; if it persists, retain traceId to check the read stage. |