Query Bay Network Configuration

POST

/openapi/v2.0/manage/api/v1/organizations/{uuid}/manage-devices/cmds/get_dock_network_conf

Query specified bay device's current network configuration (NIC mode, IP, DNS, proxy, etc.). Dispatches query command via cmds channel; device replies with current configuration. This API shares the same physical channel with the "Dispatch Custom Command to Organization Device (Generic cmds Channel) [Query-Type Developed as API, Configuration-Type Retained]" API (Generic cmds Channel); {method} path segment is fixed to get_dock_network_conf.

Request

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "device_sn": "1581F5FKD232800D378V",
    "device_cmd_data": {}
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/openapi/v2.0/manage/api/v1/organizations//manage-devices/cmds/get_dock_network_conf' \
--header 'x-user-token;' \
--header 'x-user-token;' \
--header 'X-Project-Uuid;' \
--header 'X-Request-Id;' \
--header 'X-Request-Id;' \
--header 'Content-Type: application/json' \
--data '{
    "device_sn": "1581F5FKD232800D378V",
    "device_cmd_data": {}
}'

Responses

🟢200

application/json

Success Response

Bodyapplication/json

Example

{
    "code": 0,
    "message": "Ok",
    "data": {
        "bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "timestamp": 1717830000000,
        "output": {}
    }
}

🟠400

🔴500

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

Query Device Network Speed Test Task Result

Detect Bay Network Connection