dji-cloud-api
  1. WaylineJobController
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连接。
      POST
    • 进入DRC模式。
      POST
    • 退出DRC模式。
      POST
  • 机场（Dock）控制器类。
    • 创建远程调试任务。
      POST
    • 飞向指定点位。
      POST
    • 停止飞向点位任务。
      DELETE
    • 从指定点位起飞。
      POST
    • 夺取飞行控制权限。
      POST
    • 夺取负载设备控制权限。
      POST
    • 发送负载设备命令。
      POST
    • 关闭舱盖
      PUT
    • coverForceClose
      PUT
    • coverOpen
      PUT
    • debugModeOpen
      PUT
  • 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
    • 在一个工作区中获取所有在线设备的拓扑列表。
    • 将设备绑定到工作空间后，设备数据只能在 Web 上看到。
    • 根据设备 sn 获取设备信息。
    • 在一个工作区中获取绑定设备列表。
    • 移除设备的绑定状态。
    • 更新设备信息。
    • 提供离线固件升级任务。
    • 设置无人机的属性参数。
    • 获取当前工作空间下设备类型数量。
    • 获取所有工作空间下设备类型数量。
    • 查询每个 domain 下设备总数与在线数
  • 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. WaylineJobController

Create a wayline task for the Dock.

POST
/${url.wayline.prefix}${url.wayline.version}/workspaces/{workspace_id}/flight-tasks

请求参数

Path 参数
workspaceId
string 
必需
Header 参数
x-auth-token
string 
可选
默认值:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ3b3Jrc3BhY2VfaWQiOiJlM2RlYTBmNS0zN2YyLTRkNzktYWU1OC00OTBhZjMyMjgwNjkiLCJzdWIiOiJDbG91ZEFwaVNhbXBsZSIsInVzZXJfdHlwZSI6IjEiLCJuYmYiOjE3NDkwODYzMDEsImxvZyI6IkxvZ2dlcltjb20uZGppLnNhbXBsZS5jb21tb24ubW9kZWwuQ3VzdG9tQ2xhaW1dIiwiaXNzIjoiREpJIiwiaWQiOiJhMTU1OWU3Yy04ZGQ4LTQ3ODAtYjk1Mi0xMDBjYzQ3OTdkYTIiLCJleHAiOjE4MzU0ODYzMDEsImlhdCI6MTc0OTA4NjMwMSwidXNlcm5hbWUiOiJhZG1pblBDIn0.W5x4fh7PWALqknARx8aoGQhK8ci5t6U7mITN1Gbn4H0
Body 参数application/json
name
string 
必需
fileId
string 
必需
dockSn
string 
必需
waylineType
enum<string> 
必需
枚举值:
WAYPOINTMAPPING_2DMAPPING_3DMAPPING_STRIP
taskType
enum<string> 
必需
枚举值:
IMMEDIATETIMEDCONDITIONAL
rthAltitude
integer 
必需
>= 20<= 500
outOfControlAction
enum<string> 
必需
枚举值:
RETURN_TO_HOMEHOVERINGLANDING
minBatteryCapacity
integer 
可选
>= 50<= 90
minStorageCapacity
integer 
可选
taskDays
array[integer]
可选
taskPeriods
array [array] 
可选
integer 
可选
示例
{
    "name": "string",
    "fileId": "string",
    "dockSn": "string",
    "waylineType": "WAYPOINT",
    "taskType": "IMMEDIATE",
    "rthAltitude": 20,
    "outOfControlAction": "RETURN_TO_HOME",
    "minBatteryCapacity": 50,
    "minStorageCapacity": 0,
    "taskDays": [
        0
    ],
    "taskPeriods": [
        [
            0
        ]
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/$$/workspaces//flight-tasks' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ3b3Jrc3BhY2VfaWQiOiJlM2RlYTBmNS0zN2YyLTRkNzktYWU1OC00OTBhZjMyMjgwNjkiLCJzdWIiOiJDbG91ZEFwaVNhbXBsZSIsInVzZXJfdHlwZSI6IjEiLCJuYmYiOjE3NDkwODYzMDEsImxvZyI6IkxvZ2dlcltjb20uZGppLnNhbXBsZS5jb21tb24ubW9kZWwuQ3VzdG9tQ2xhaW1dIiwiaXNzIjoiREpJIiwiaWQiOiJhMTU1OWU3Yy04ZGQ4LTQ3ODAtYjk1Mi0xMDBjYzQ3OTdkYTIiLCJleHAiOjE4MzU0ODYzMDEsImlhdCI6MTc0OTA4NjMwMSwidXNlcm5hbWUiOiJhZG1pblBDIn0.W5x4fh7PWALqknARx8aoGQhK8ci5t6U7mITN1Gbn4H0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "fileId": "string",
    "dockSn": "string",
    "waylineType": "WAYPOINT",
    "taskType": "IMMEDIATE",
    "rthAltitude": 20,
    "outOfControlAction": "RETURN_TO_HOME",
    "minBatteryCapacity": 50,
    "minStorageCapacity": 0,
    "taskDays": [
        0
    ],
    "taskPeriods": [
        [
            0
        ]
    ]
}'

返回响应

🟢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-05 01:52:34
下一页
Paginate through all jobs in this workspace.
Built with