Query Persistent Processing Status_API_Object Storage-Documentation

This API is used to query the status of persistent processing tasks, such as audio/video transcoding and decompression, on the CDNetworks Object Storage platform.

Note:
For more details on audio and video transcoding services, please refer to Video Transcoding and Audio Transcoding.

Request Description

GET /status/get/prefop?persistentId=<persistentId>
HOST: <MgrDomain>

Parameter Description

Parameter	Required	Description
Host	Yes	Management domain name, which can be found on the Bucket Overview page in the console.
persistentId	Yes	The `persistentId` returned by the upload pre-processing or persistent processing trigger API.

Response Description

If the request is successful, a JSON object in the following format will be returned:

{
	"id": "<id string>",
	"code": "<code int>",
	"desc": "<desc string>",
	"separate": "<separate int>",
	"inputkey": "<inputkey string>",
	"inputbucket": "<inputbucket string>",
	"inputfsize": "<inputfsize int>",
	"items": [{
		"cmd": "<cmd string>",
		"code": "<code string>",
		"costTime": "<costTime int>",
		"desc": "<desc string>",
		"error": "<error string>",
		"fsize": "<fsize int>",
		"hash": "<hash string>",
		"key": "<key string>",
		"url": "<url string>",
		"duration": "<duration double>",
		"bit_rate": "<bit_rate string>",
		"resolution": "<resolution string>",
		"detail": [{
			"fsize": "<fsize int>",
			"tssize": "<tssize int>",
			"hash": "<hash string>",
			"key": "<key string>",
			"url": "<url string>",
			"duration": "<duration double>",
			"bit_rate": "<bit_rate string>",
			"resolution": "<resolution string>"
		}]
	}]
}

Field Descriptions

Top-level Fields

Field Name	Type	Description
id	string	The `persistentId` returned by the upload pre-processing or persistent processing trigger API.
code	int	Processing status code: 0 - Pending, 1 - Processing, 3 - Completed, 4 - Notifying, 5 - Notification Failed, 6 - Notification Succeeded
desc	string	Detailed description of the status code.
separate	int	Notification option. 0 for one-time notification, 1 for separate notifications.
inputkey	string	Original file name.
inputbucket	string	Original file storage bucket.
inputfsize	int	Original file size.
items	array	Status information for each processing operation (when multiple operations are requested, the `items` array contains multiple entries).

Fields within items

Field Name	Type	Description
cmd	string	Operation command (ops).
code	string	Processing result status code: 0-Pending 1-Processing 2-Failed 3-Success 4-Notification in Progress 5-Notification Failed 6-Notification Succeeded 18-Failed Notification in Progress 19-Failed Notification Failed 20-Failed Notification Succeeded
costTime	int	Time taken for transcoding (default is 0 except for specific scenarios).
desc	string	Detailed description of the status code.
error	string	If processing fails, this field contains the failure reason.
fsize	int	Size of the processed file.
hash	string	Hash value of the processed result.
key	string	`key` of the processed result.
url	string	Resource access path.
duration	double	Duration of the transcoded output video.
bit_rate	string	Bitrate of the transcoded output video.
resolution	string	Resolution of the transcoded output video.
detail	array	Detailed information for each data file when multiple output files are generated (e.g., multiple ts segments in m3u8).

Fields within detail

Field Name	Type	Description
fsize	int	Size of the processed file; for m3u8 outputs, this is the size of the m3u8 file.
tssize	int	For m3u8 outputs, total size of ts files; for non-m3u8 outputs, the value is 0.
hash	string	Hash value of the processed result.
key	string	`key` of the processed result.
url	string	URL to access the resource.
duration	double	Duration of the transcoded video.
bit_rate	string	Bitrate of the transcoded video.
resolution	string	Resolution of the transcoded video.

If the request fails, the following JSON format is returned:

{
  "code": "<httpCode int>",
  "message": "<errMsg string>"
}

Field Name	Required	Description
code	Yes	HTTP response code. Refer to HTTP Response Status Codes.
message	Yes	Error message.

Example

curl -v "http://mgrDomain/status/get/prefop?persistentId=e534f75d41534f468a7efe9a51dc90ad"

Media Delivery

Cloud Security

Web Performance

Enterprise Application

Storage

Edge Computing

Console Guide

API Docs

Query Persistent Processing Status

Request Description

Parameter Description

Response Description

Field Descriptions

Example

Directory