All Products
Search
Document Center

ApsaraVideo VOD:SearchEditingProject

Last Updated:Nov 09, 2022

Queries online editing projects.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:SearchEditingProjectList
  • VOD
    acs:vod:{#regionId}:{#accountId}:editingproject/{#EditingProjectId}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
EndTimestringNo

The end of the time range to query. The query is performed based on the time range during which the required online editing projects were created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2017-01-11T13:00:00Z
StartTimestringNo

The beginning of the time range to query. The query is performed based on the time range during which the required online editing projects were created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2017-01-11T12:00:00Z
StatusstringNo

The status of the online editing project. Separate multiple states with commas (,). By default, all online editing projects are 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
PageNointegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10. Maximum value: 100.

10
SortBystringNo

The sorting rule of results. Valid values:

  • CreationTime:Desc: sorts the results based on the creation time in descending order. This is the default value.
  • CreationTime:Asc: sorts the results based on the creation time in ascending order.
CreationTime:Desc
TitlestringNo

The title of the online editing project.

test

Response parameters

ParameterTypeDescriptionExample
object
Totalinteger

The total number of online editing projects returned.

2
RequestIdstring

The ID of the request.

9262E3DA-07FA-48*****62-FCBB6BC61D08
ProjectListarray

The list of online editing projects.

object
StorageLocationstring

The path of the Object Storage Service (OSS) bucket where the produced video is stored.

NoteTo 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
Statusstring

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
CreationTimestring

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
ModifiedTimestring

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
Descriptionstring

The description of the online editing project.

test project 001
CoverURLstring

The thumbnail URL of the online editing project.

cover_url
ProjectIdstring

The ID of the online editing project.

25cfc178d2de4*****e77aebed6afcd
Durationnumber

The duration of the online editing project, which must be consistent with the duration of the timeline.

NoteThe Timeline parameter is not included in response parameters.
22.65
Titlestring

The title of the online editing project.

video_150873681****
RegionIdstring

The region where the online editing project was created.

cn-shanghai

Example

Normal return example

JSONFormat

{
  "Total": 2,
  "RequestId": "9262E3DA-07FA-48*****62-FCBB6BC61D08",
  "ProjectList": [
    {
      "StorageLocation": "location_s",
      "Status": "Normal",
      "CreationTime": "2017-01-11T12:00:00Z",
      "ModifiedTime": "2017-01-11T13:00:00Z",
      "Description": "test project 001",
      "CoverURL": "cover_url",
      "ProjectId": "25cfc178d2de4*****e77aebed6afcd",
      "Duration": 22.65,
      "Title": "video_150873681****",
      "RegionId": "cn-shanghai"
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.