Query online editing projects using SearchEditingProject - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Searches for online editing projects (video editing lists).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:SearchEditingProject

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EndTime	string	No	The end of the time range to query based on CreationTime. Specify the time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-01-11T13:00:00Z
StartTime	string	No	The start of the time range to query based on CreationTime. Specify the time in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-01-11T12:00:00Z
Status	string	No	The status of the online editing project. Separate multiple statuses with commas (,). By default, all online editing projects are returned. Valid values: Normal: Draft. Producing: Being produced. Produced: Produced. ProduceFailed: Failed to be produced.	Normal
PageNo	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Maximum value: 100.	10
SortBy	string	No	The sorting method of the results. Valid values: desc (default): sorts the results in reverse chronological order based on creation time. asc: sorts the results in chronological order based on creation time.	desc
Title	string	No	The title of the online editing project.	test

Response elements

Element	Type	Description	Example
	object
Total	integer	The total number of online editing projects.	2
RequestId	string	The request ID.	9262E3DA-07FA-48*****62-FCBB6BC61D08
ProjectList	object
Project	array<object>	The list of online editing projects.
	object
StorageLocation	string	The path of the Object Storage Service (OSS) bucket where the produced video is stored. Note To view the path of the OSS bucket, log on to the ApsaraVideo VOD console, and choose Configuration Management > Media Management > Storage. On the Storage page, you can view the path of the OSS bucket.	location_s
Status	string	The status of the online editing project. Separate multiple states with commas (,). By default, all online editing projects were queried. Valid values: Normal: indicates that the online editing project is in draft. Producing: indicates that the video is being produced. Produced: indicates that the video was produced. ProduceFailed: indicates that the video failed to be produced.	Normal
CreationTime	string	The time when the online editing project was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-01-11T12:00:00Z
ModifiedTime	string	The last time when the online editing project was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-01-11T13:00:00Z
Description	string	The description of the online editing project.	故事板测试工程001
CoverURL	string	The thumbnail URL of the online editing project.	cover_url
ProjectId	string	The ID of the online editing project.	25cfc178d2de4*****e77aebed6afcd
Duration	number	The duration of the online editing project, which must be consistent with the duration of the timeline. Note The Timeline parameter is not included in response parameters.	22.65
Title	string	The title of the online editing project.	Video_150873681****
RegionId	string	The region where the online editing project was created.	cn-shanghai

Examples

Success response

JSON format

{
  "Total": 2,
  "RequestId": "9262E3DA-07FA-48*****62-FCBB6BC61D08",
  "ProjectList": {
    "Project": [
      {
        "StorageLocation": "location_s",
        "Status": "Normal",
        "CreationTime": "2017-01-11T12:00:00Z",
        "ModifiedTime": "2017-01-11T13:00:00Z",
        "Description": "故事板测试工程001",
        "CoverURL": "cover_url",
        "ProjectId": "25cfc178d2de4*****e77aebed6afcd",
        "Duration": 22.65,
        "Title": "Video_150873681****",
        "RegionId": "cn-shanghai"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.