Destroy a cloud transcoding task

Updated

Destroys a Cloud Transcoding task.

deletehttps://api.sd-rtn.com/v1/projects/{appId}/rtsc/cloud-transcoder/tasks/{taskId}

When you no longer need to use cloud transcoding, initiate a Delete request to destroy it.

Path Parameters

appId#*string

The App ID of your project from Agora Console.

taskId#*string

The transcoding task UUID used to identify the cloud transcoder for this request.

Query Parameters

builderToken#*string

The tokenName you obtained in the response body of the Acquire method. See Acquire a builder token.

Header Parameters

Content-Type#*string

The request content type. Use application/json.

Allowedapplication/json
X-Request-ID#?string

UUID (Universally Unique Identifier), used to identify this request.

If the request fails, print out the value in the log to troubleshoot the problem. If the response status code of the request is not 2XX, then the response header may not contain this field.

Response

  • If the returned status code is 200, the request was successful. The response body contains the result of the request.

  • If the returned status code is not 200, the request failed.

Response Body

application/json

application/json

Response schema

200application/json

The request succeeded and returned task information.

taskId#optionalstring

A UUID used to identify the cloud transcoder for this request operation.

createTs#optionalnumber

Unix timestamp (seconds) when the transcoding task was created.

status#optionalstring

The running status of the transcoding task:

  • "IDLE": Task not started.
  • "PREPARED": The task has received a start request.
  • "STARTING": The task is starting.
  • "CREATED": Task initialization completed.
  • "STARTED": The task has started.
  • "IN_PROGRESS": Task in progress.
  • "STOPPING": The task is stopping.
  • "STOPPED": The task has stopped.
  • "EXIT": The task exited normally.
  • "FAILURE_STOP": The task exited abnormally.
sequenceId#optionalstring

The sequence ID.

services#optionalobject
eventHandlers#optionalobject
execution#optionalobject
properties#optionalobject
variables#optionalobject
workflows#optionalobject
defaultapplication/json

The request failed.

message#optionalstring

Describes why the request failed.

Response Headers

X-Request-ID#?string

The unique request ID. If the request fails, use this value in the log to troubleshoot the problem.

Status200

Authorization

This endpoint requires authentication.

basicAuth

Request examples

curl --request delete \      --url 'https://api.sd-rtn.com/v1/projects/:appId/rtsc/cloud-transcoder/tasks/:taskId?builderToken=' \      --header 'Authorization: Basic <credentials>' \      --header 'Content-Type: <string>'

Response example

{  "createTs": 1661324613,  "eventHandlers": {},  "execution": {    "workflows": {}  },  "properties": {},  "sequenceId": "0",  "services": {    "cloudTranscoder": {      "config": {},      "createTs": 1661324614,      "details": {},      "message": "OnSlaveServiceStopped",      "serviceType": "cloudTranscoderV2",      "status": "serviceCompleted"    }  },  "status": "STOPPED",  "taskId": "609f28f2644f1ae1ceb041b7047e3***",  "variables": {},  "workflows": {}}
{  "message": "Describes why the request failed."}