Cancels a Cloud Slicer job. Jobs that have already completed cannot be canceled.

Key information:

You will be billed for slicing and encoding processing that were performed prior to the cancellation.
You should manually delete partially sliced assets.

Request

Request syntax:

/jobs/cancel

Request parameters:

Pass the following parameters through the msg parameter:

Name	Data Type	Description
id	String	Identifies a Cloud Slicer job by its system-defined ID.

Authentication

Pass a digital signature based off of msg.

Response

The response for a successful request contains the following parameter.

Name	Data Type	Description
job	Dictionary	Describes the Cloud Slicer job that was cancelled.

Sample Request/Response

A sample request/response is provided below.

The Call function, which is imported from API Auth for V2 APIs (see below), prepares the message body and digital signature.

from uplynk_api2_auth import Call

print(Call('/api2/cloudslicer/jobs/cancel', id='d3345dbe5e064d09a20b762f7618839e'))

{
    "job": {
        "state": "cancelled",
        "last_error": "",
        "args": {"export_mp4": True},
        "attempts": 0,
        "source": {},
        "finished": 0,
        "asset": "a29a0bf647454d70bbb9b13d6896a108",
        "last_start": 0,
        "owner": "a735c56ea4014685bc74c0a375236cc5",
        "progress": "",
        "id": "d0d05debde654249ae25b1c7f45a19fe"
    },
    "error": 0
}