Update Relay Task Running Status (Pause / Resume / Cancel)

PUT

/openapi/v2.0/task/api/v1/workspaces/{workspace_id}/flight-tasks/relay-missions/{relay_mission_id}/status

Control relay task running transitions: Pause / Resume / Cancel. Three actions correspond to different precondition state requirements and side effects:

paused (Pause): Only pausable when task is in running state. Sends command to make primary/backup aircraft in flight (and not in returning/landing) stop point-to-fly; flight task overall status changes to paused.

running (Resume): Only resumable when task is in paused state. Can simultaneously carry new mission_position and observe_target_position (modify task point / observation target).

cancel (Cancel): Only cancellable when task is in running or paused state. Can specify return_home_drone_sn to make an aircraft immediately return to its own dock. This API's status field is string rather than integer; only accepts three action values (paused / running / cancel); different from flight task overall state machine's complete enum — this is "action intent" rather than "state value".

Request

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "status": "running",
    "mission_position": {
        "latitude": 22.5431,
        "longitude": 113.9342,
        "height": 100
    },
    "observe_target_position": {
        "latitude": 22.543,
        "longitude": 113.9341,
        "height": 0
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/openapi/v2.0/task/api/v1/workspaces//flight-tasks/relay-missions//status' \
--header 'x-user-token;' \
--header 'x-user-token;' \
--header 'X-Request-Id: 5dff27bd-693c-4ace-979d-e26e920d497a' \
--header 'X-Request-Id;' \
--header 'X-Project-Uuid;' \
--header 'Content-Type: application/json' \
--data '{
    "status": "running",
    "mission_position": {
        "latitude": 22.5431,
        "longitude": 113.9342,
        "height": 100
    },
    "observe_target_position": {
        "latitude": 22.543,
        "longitude": 113.9341,
        "height": 0
    }
}'

Responses

🟢200

application/json

Operation Successful

Bodyapplication/json

Example

{
    "code": 0,
    "message": "success",
    "data": null
}

🟠400

🔴500

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

Trigger Relay Aircraft Active Takeoff

Actively Switch Relay Task Executing Aircraft