Start Device Network Speed Detection Task

POST

/openapi/v2.0/manage/api/v1/organizations/{uuid}/network-speed-test/task

Start a network speed detection task for specified dock device; detects device-to-speed-test-node uplink/downlink bandwidth and latency. After successful task dispatch, returns batch ID; actual speed test data can be obtained via "Query Network Speed Test Result" API ("Query Device Network Speed Test Task Result" API) using this. Note: this API's command type is fixed by route to dock_speed_task; client does not need and should not pass device_cmd_method in request body; client may optionally pass in device_cmd_data to specify speed test nodes, and other parameters; uses default configuration if omitted.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Start Speed Test with Default ConfigurationSpecify Custom Speed Test Node

{
    "device_sn": "2TUDK87654321"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Start Speed Test with Default ConfigurationSpecify Custom Speed Test Node

curl --location '/openapi/v2.0/manage/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/network-speed-test/task' \
--header 'x-user-token;' \
--header 'x-user-token;' \
--header 'X-Request-Id;' \
--header 'X-Request-Id;' \
--header 'X-Project-Uuid;' \
--header 'Content-Type: application/json' \
--data '{
    "device_sn": "2TUDK87654321"
}'

Responses

🟢200

application/json

Success Response

Bodyapplication/json

Example

{
    "code": 0,
    "message": "OK",
    "data": {
        "bid": "c47a4d22-8f01-4b3c-91d7-f1e0823a5c11",
        "tid": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
        "timestamp": 1717574400000,
        "output": {}
    }
}

🟠400

🔴500

Modified at 2026-06-15 13:36:31

Query Device Current NTP Server Configuration

Query Device Network Speed Test Task Result