Querying an Editing Task
Function
This API is used to query an editing task.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
vod:asset:listEditTask
List
-
-
-
-
URI
GET /v1/{project_id}/asset/editing/tasks
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
task_id |
No |
String |
Editing task ID. |
|
offset |
No |
Integer |
Query offset. The default value is 0. |
|
limit |
No |
Integer |
The number of records on one page. The default value is 10 and the maximum value is 100. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
|
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
|
X-Sdk-Date |
No |
String |
Time when a request is sent. This parameter is mandatory for AK/SK authentication. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Long |
Total number of tasks. |
|
tasks |
Array of EditingTaskInfo objects |
Task list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
task_id |
String |
Editing task ID. |
|
asset_id |
String |
Output media asset ID. |
|
status |
String |
Task status. |
|
progress |
Integer |
Progress. The value ranges from 0 to 100. |
|
create_time |
String |
Task creation time. The value is a UTC time in RFC3339 format, for example, 2020-09-01T18:50:20Z. |
|
end_time |
String |
Task end time. The value is a UTC time in RFC3339 format, for example, 2020-09-01T18:50:20Z. This parameter is available only when the task ends. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
Example Requests
None
Example Responses
Status code: 200
Returned when the request succeeded.
{
"total" : 56,
"tasks" : [ {
"task_id" : "123",
"asset_id" : "tvs78289764yfbgy2w",
"status" : "SUCCEED",
"progress" : 100,
"create_time" : "2025-09-01T18:50:20Z",
"end_time" : "2025-09-01T19:50:20Z"
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Returned when the request succeeded. |
|
400 |
Returned when the request failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot