obtain device topology list

GET

/manage/api/v1/workspaces/{workspace_id}/devices/topologies

Get the topology list of all devices in the current user workspace for pilot display.
obtain device topology list
Get the topology list of all devices in the current user workspace for pilot display.In the first connection, DJI Pilot 2 will call this interface to obtain the list topology of all devices.Also, when Pilot receives a websocket command to notify the device of online, offline, and update, it will also call this interface to request the device topology list to be updated.

请求参数

Path 参数

workspaceId

string

必需

Query 参数

workspace_id

可选

workspace id

Header 参数

x-auth-token

string

可选

默认值:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ3b3Jrc3BhY2VfaWQiOiJlM2RlYTBmNS0zN2YyLTRkNzktYWU1OC00OTBhZjMyMjgwNjkiLCJzdWIiOiJDbG91ZEFwaVNhbXBsZSIsInVzZXJfdHlwZSI6IjEiLCJuYmYiOjE3NDkwODYzMDEsImxvZyI6IkxvZ2dlcltjb20uZGppLnNhbXBsZS5jb21tb24ubW9kZWwuQ3VzdG9tQ2xhaW1dIiwiaXNzIjoiREpJIiwiaWQiOiJhMTU1OWU3Yy04ZGQ4LTQ3ODAtYjk1Mi0xMDBjYzQ3OTdkYTIiLCJleHAiOjE4MzU0ODYzMDEsImlhdCI6MTc0OTA4NjMwMSwidXNlcm5hbWUiOiJhZG1pblBDIn0.W5x4fh7PWALqknARx8aoGQhK8ci5t6U7mITN1Gbn4H0

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/manage/api/v1/workspaces//devices/topologies' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ3b3Jrc3BhY2VfaWQiOiJlM2RlYTBmNS0zN2YyLTRkNzktYWU1OC00OTBhZjMyMjgwNjkiLCJzdWIiOiJDbG91ZEFwaVNhbXBsZSIsInVzZXJfdHlwZSI6IjEiLCJuYmYiOjE3NDkwODYzMDEsImxvZyI6IkxvZ2dlcltjb20uZGppLnNhbXBsZS5jb21tb24ubW9kZWwuQ3VzdG9tQ2xhaW1dIiwiaXNzIjoiREpJIiwiaWQiOiJhMTU1OWU3Yy04ZGQ4LTQ3ODAtYjk1Mi0xMDBjYzQ3OTdkYTIiLCJleHAiOjE4MzU0ODYzMDEsImlhdCI6MTc0OTA4NjMwMSwidXNlcm5hbWUiOiJhZG1pblBDIn0.W5x4fh7PWALqknARx8aoGQhK8ci5t6U7mITN1Gbn4H0'

返回响应

🟢200成功

application/json

Body

code

integer

可选

0 means success, non-zero means error.

示例值:

message

string

可选

The response message.

示例值:

success

data

object (TopologyResponse)

可选

The response data.

list

array[object (TopologyList) {2}]

必需

示例

{
  "code": 0,
  "message": "",
  "data": {
    "list": [
      {
        "hosts": [
          {
            "device_callsign": "",
            "device_model": {
              "device_model_key": "",
              "sub_type": "",
              "domain": "",
              "type": ""
            },
            "online_status": false,
            "user_id": "",
            "user_callsign": "",
            "icon_urls": {
              "normal_icon_url": "",
              "selected_icon_url": ""
            },
            "sn": ""
          }
        ],
        "parents": [
          {
            "device_callsign": "",
            "device_model": {
              "device_model_key": "",
              "sub_type": "",
              "domain": "",
              "type": ""
            },
            "online_status": false,
            "user_id": "",
            "user_callsign": "",
            "icon_urls": {
              "normal_icon_url": "",
              "selected_icon_url": ""
            },
            "sn": ""
          }
        ]
      }
    ]
  }
}

修改于 2025-06-05 01:52:34

查询每个 domain 下设备总数与在线数

Page to query the hms information of the device.