API Center

ClearAdTaskQuery

Update time: 2023-10-09 15:58:50

Applicable Products

Cloud VoD

API Description

Query AI clear AD task status and results

Call frequency

Single user trigger frequency: 300/5min

We recommend you to use API Explorer

The API Explorer provides the ability of visual interface online call API, code examples generation, and API documents quickly search .Try it

Request parameter(s)

Body Params

NameDescription
*taskIdString
AI clear AD task ID

Response parameter(s)

Body Params

NameDescription
codeInteger
Status code
messageString
Operational information
dataObject
Return data
taskIdString
AI clear AD task ID
statusInteger
Status: 0(not started) 1(in progress) 2(Successful) 3(failure)
outputString
New video ID

Error code

Error code(code)Description(message)HTTP statusSemantic
1000Parameter error200Parameter error
1000The task does not exist or has no permission200The task does not exist or has no permission

Example

JSON
JSON
Request example
Copy Copy success
#!/bin/bash
username='example_username'
apiKey='example_apiKey'
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://api.cdnetworks.com/vod/ai/clearAdTaskQuery" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "x-cnc-auth-method: BASIC" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
    "taskId": "idxxxxxx"
}'
Response example
Copy Copy success
{
	"code": 200,
	"data": {
		"output": "ab02dc9dca2a11eaab73c5d6f877d847",
		"status": 2,
		"taskId": "4ced37bc-ca2a-11ea-8653-ac61753fd979"
	},
	"message": "操作成功"
}
Is the content of this document helpful to you?
Yes
I have suggestion
Submitted successfully! Thank you very much for your feedback, we will continue to strive to do better!