dji-cloud-api
  1. DeviceController
dji-cloud-api
  • WaylineJobController
    • Create a wayline task for the Dock.
      POST
    • Paginate through all jobs in this workspace.
      GET
    • Send the command to cancel the jobs.
      DELETE
    • Set the media files for this job to upload immediately.
      POST
    • updateJobStatus
      PUT
  • WaylineFileController
    • get wayline list
      GET
    • get wayline file download address
      GET
    • get wayline file download address
      GET
    • get duplicated wayline name
      GET
    • file upload result report
      POST
    • batch favorites wayline
      POST
    • batch unfavorites wayline
      DELETE
    • Delete the wayline file in the workspace according to the wayline id.
      DELETE
    • Import kmz wayline files.
      POST
  • StorageController
    • Get STS Token
      POST
  • DRC（直接遥控）控制器类。
    • 建立DRC连接。
    • 进入DRC模式。
    • 退出DRC模式。
  • 机场（Dock）控制器类。
    • 创建远程调试任务。
    • 飞向指定点位。
    • 停止飞向点位任务。
    • 从指定点位起飞。
    • 夺取飞行控制权限。
    • 夺取负载设备控制权限。
    • 发送负载设备命令。
    • 关闭舱盖
    • coverForceClose
    • coverOpen
    • debugModeOpen
  • UserController
    • Query the information of the current user.
    • Paging to query all users in a workspace.
    • Modify user information. Only mqtt account information is included, nothing else can be modified.
  • LoginController
    • login
    • refreshToken
  • DeviceController
    • 在一个工作区中获取所有在线设备的拓扑列表。
      GET
    • 将设备绑定到工作空间后，设备数据只能在 Web 上看到。
      POST
    • 根据设备 sn 获取设备信息。
      GET
    • 在一个工作区中获取绑定设备列表。
      GET
    • 移除设备的绑定状态。
      DELETE
    • 更新设备信息。
      PUT
    • 提供离线固件升级任务。
      POST
    • 设置无人机的属性参数。
      PUT
    • 获取当前工作空间下设备类型数量。
      GET
    • 获取所有工作空间下设备类型数量。
      GET
    • 查询每个 domain 下设备总数与在线数
      GET
  • TopologyController
    • obtain device topology list
  • DeviceHmsController
    • Page to query the hms information of the device.
    • Update unread hms messages to read status.
    • Get hms messages for a single device.
  • WorkspaceController
    • Gets information about the workspace that the current user is in.
  • DeviceLogsController
    • Obtain the device upload log list by paging according to the query parameters.
    • Get a list of log files that can be uploaded in real time.
    • Initiate a log upload request to the gateway.
    • Cancel logs file upload.
    • Delete upload history.
    • Query the download address of the file according to the wayline file id,
  • LiveStreamController
    • 获取当前直播流容量信息。
    • 获取当前直播流容量信息。
    • 查询全部能进行直播的设备
    • 根据设备sn查询设备直播信息
    • 根据设备sn查询设备直播信息
    • Live streaming according to the parameters passed in from the web side.
    • Stop live streaming according to the parameters passed in from the web side.
    • Set the quality of the live streaming according to the parameters passed in from the web side.
    • liveLensChange
  • DeviceFirmwareController
    • Get the latest firmware version information for this device model.
    • Query firmware information based on parameters.
    • Import firmware file for device upgrades.
    • Change the firmware availability status.
  • FileController
    • Get information about all the media files in this workspace based on the workspace id.
    • Query the download address of the file according to the media file id,
  • MediaController
    • media fast upload
    • app reports file upload result
    • checks whether the file fingerprint exists
    • callback after the file group upload complete
  • DeviceDataController
    • getDeviceFlightAreaStatus
  • FlightAreaController
    • getFlightAreas
    • createFlightArea
    • deleteFlightArea
    • updateFlightArea
    • syncFlightArea
  • WorkspaceElementController
    • get map elements
    • create map element
    • update map element
    • delete map element
    • Delete all the element information in this group based on the group id.
  • 航线生成控制器
    • 生成航线
    • KMZ文件转JSON
    • 云端KMZ文件转JSON
  • WeatherController
    • 根据区域编码获取天气信息
    • 通过经纬度查询天气
  1. DeviceController

更新设备信息。

PUT
/${url.manage.prefix}${url.manage.version}/devices/{workspace_id}/devices/{device_sn}

请求参数

Path 参数
workspace_id
string 
必需
device_sn
string 
必需
Header 参数
x-auth-token
string 
可选
默认值:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ3b3Jrc3BhY2VfaWQiOiJlM2RlYTBmNS0zN2YyLTRkNzktYWU1OC00OTBhZjMyMjgwNjkiLCJzdWIiOiJDbG91ZEFwaVNhbXBsZSIsInVzZXJfdHlwZSI6IjEiLCJuYmYiOjE3NDkwODYzMDEsImxvZyI6IkxvZ2dlcltjb20uZGppLnNhbXBsZS5jb21tb24ubW9kZWwuQ3VzdG9tQ2xhaW1dIiwiaXNzIjoiREpJIiwiaWQiOiJhMTU1OWU3Yy04ZGQ4LTQ3ODAtYjk1Mi0xMDBjYzQ3OTdkYTIiLCJleHAiOjE4MzU0ODYzMDEsImlhdCI6MTc0OTA4NjMwMSwidXNlcm5hbWUiOiJhZG1pblBDIn0.W5x4fh7PWALqknARx8aoGQhK8ci5t6U7mITN1Gbn4H0
Body 参数application/json
deviceSn
string 
可选
deviceName
string 
可选
workspaceId
string 
可选
controlSource
enum<string> 
可选
枚举值:
ABUNKNOWN
deviceDesc
string 
可选
childDeviceSn
string 
可选
domain
enum<string> 
可选
枚举值:
DRONEPAYLOADREMOTER_CONTROLDOCK
type
enum<string> 
可选
枚举值:
M350M300M30_OR_M3T_CAMERAM3EZ30XT2FPVXTSH20H20TP1M30_CAMERAM30T_CAMERAH20NDOCK_CAMERAL1M3E_CAMERAM3M_CAMERARCRC_PLUSRC_PRODOCKDOCK2M3DM3D_CAMERAM3TD_CAMERA
subType
enum<string> 
可选
枚举值:
ZEROONETWO_65535
payloadsList
array[object (DevicePayloadDTO) {6}] 
可选
payloadSn
string 
可选
payloadName
string 
可选
index
integer 
可选
payloadDesc
string 
可选
controlSource
enum<string> 
可选
枚举值:
ABUNKNOWN
payloadIndex
object (PayloadIndex) 
可选
iconUrl
object (DeviceIconUrl) 
可选
normal_icon_url
string 
必需
icon displayed in normal state
示例值:
resource://pilot/drawable/tsa_car_normal
selected_icon_url
string 
必需
icon displayed in selected state
示例值:
resource://pilot/drawable/tsa_car_select
status
boolean 
可选
boundStatus
boolean 
可选
loginTime
string 
可选
boundTime
string 
可选
nickname
string 
可选
userId
string 
可选
firmwareVersion
string 
可选
workspaceName
string 
可选
children
object (DeviceDTO) 
可选
deviceSn
string 
可选
deviceName
string 
可选
workspaceId
string 
可选
controlSource
enum<string> 
可选
枚举值:
ABUNKNOWN
deviceDesc
string 
可选
childDeviceSn
string 
可选
domain
enum<string> 
可选
枚举值:
DRONEPAYLOADREMOTER_CONTROLDOCK
type
enum<string> 
可选
枚举值:
M350M300M30_OR_M3T_CAMERAM3EZ30XT2FPVXTSH20H20TP1M30_CAMERAM30T_CAMERAH20NDOCK_CAMERAL1M3E_CAMERAM3M_CAMERARCRC_PLUSRC_PRODOCKDOCK2M3DM3D_CAMERAM3TD_CAMERA
subType
enum<string> 
可选
枚举值:
ZEROONETWO_65535
payloadsList
array[object (DevicePayloadDTO) {6}] 
可选
iconUrl
object (DeviceIconUrl) 
可选
status
boolean 
可选
boundStatus
boolean 
可选
loginTime
string 
可选
boundTime
string 
可选
nickname
string 
可选
userId
string 
可选
firmwareVersion
string 
可选
workspaceName
string 
可选
firmwareStatus
enum<string> 
可选
枚举值:
NOT_UPGRADENORMAL_UPGRADECONSISTENT_UPGRADEUPGRADINGUNKNOWN
firmwareProgress
integer 
可选
parentSn
string 
可选
thingVersion
string 
可选
firmwareStatus
enum<string> 
可选
枚举值:
NOT_UPGRADENORMAL_UPGRADECONSISTENT_UPGRADEUPGRADINGUNKNOWN
firmwareProgress
integer 
可选
parentSn
string 
可选
thingVersion
string 
可选
示例
{
    "deviceSn": "string",
    "deviceName": "string",
    "workspaceId": "string",
    "controlSource": "A",
    "deviceDesc": "string",
    "childDeviceSn": "string",
    "domain": "DRONE",
    "type": "M350",
    "subType": "ZERO",
    "payloadsList": [
        {
            "payloadSn": "string",
            "payloadName": "string",
            "index": 0,
            "payloadDesc": "string",
            "controlSource": "A",
            "payloadIndex": {
                "type": "M350",
                "subType": "ZERO",
                "position": "FRONT_LEFT"
            }
        }
    ],
    "iconUrl": {
        "normal_icon_url": "resource://pilot/drawable/tsa_car_normal",
        "selected_icon_url": "resource://pilot/drawable/tsa_car_select"
    },
    "status": true,
    "boundStatus": true,
    "loginTime": "string",
    "boundTime": "string",
    "nickname": "string",
    "userId": "string",
    "firmwareVersion": "string",
    "workspaceName": "string",
    "children": {},
    "firmwareStatus": "NOT_UPGRADE",
    "firmwareProgress": 0,
    "parentSn": "string",
    "thingVersion": "string"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request PUT '/$$/devices//devices/' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ3b3Jrc3BhY2VfaWQiOiJlM2RlYTBmNS0zN2YyLTRkNzktYWU1OC00OTBhZjMyMjgwNjkiLCJzdWIiOiJDbG91ZEFwaVNhbXBsZSIsInVzZXJfdHlwZSI6IjEiLCJuYmYiOjE3NDkwODYzMDEsImxvZyI6IkxvZ2dlcltjb20uZGppLnNhbXBsZS5jb21tb24ubW9kZWwuQ3VzdG9tQ2xhaW1dIiwiaXNzIjoiREpJIiwiaWQiOiJhMTU1OWU3Yy04ZGQ4LTQ3ODAtYjk1Mi0xMDBjYzQ3OTdkYTIiLCJleHAiOjE4MzU0ODYzMDEsImlhdCI6MTc0OTA4NjMwMSwidXNlcm5hbWUiOiJhZG1pblBDIn0.W5x4fh7PWALqknARx8aoGQhK8ci5t6U7mITN1Gbn4H0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "deviceSn": "string",
    "deviceName": "string",
    "workspaceId": "string",
    "controlSource": "A",
    "deviceDesc": "string",
    "childDeviceSn": "string",
    "domain": "DRONE",
    "type": "M350",
    "subType": "ZERO",
    "payloadsList": [
        {
            "payloadSn": "string",
            "payloadName": "string",
            "index": 0,
            "payloadDesc": "string",
            "controlSource": "A",
            "payloadIndex": {
                "type": "M350",
                "subType": "ZERO",
                "position": "FRONT_LEFT"
            }
        }
    ],
    "iconUrl": {
        "normal_icon_url": "resource://pilot/drawable/tsa_car_normal",
        "selected_icon_url": "resource://pilot/drawable/tsa_car_select"
    },
    "status": true,
    "boundStatus": true,
    "loginTime": "string",
    "boundTime": "string",
    "nickname": "string",
    "userId": "string",
    "firmwareVersion": "string",
    "workspaceName": "string",
    "children": {},
    "firmwareStatus": "NOT_UPGRADE",
    "firmwareProgress": 0,
    "parentSn": "string",
    "thingVersion": "string"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
可选
0 means success, non-zero means error.
示例值:
0
message
string 
可选
The response message.
示例值:
success
data
object (Object) 
可选
The response data.
示例
{
  "code": 0,
  "message": "",
  "data": {}
}
修改于 2025-06-27 03:15:24
上一页
移除设备的绑定状态。
下一页
提供离线固件升级任务。
Built with