All Products
Search
Document Center

SearchEditingProject

Last Updated: Jul 11, 2019

Description

You can call this operation to search for online editing projects (video editing tasks).

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set this parameter to SearchEditingProject.
StartTime String No The earliest creation time of the online editing project among the list of online editing projects.
  • The value is an open interval, which indicates that the actual start time is later than the specified start time.
  • Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. [DO NOT TRANSLATE]
    For example, a value of 2017-01-11T12:00:00Z indicates 20:00:00 on January 11, 2017, China Standard Time.
EndTime String No The latest creation time of the online editing project among the list of online editing projects.
  • The value is a closed interval, which indicates that the actual end time is earlier than or the same as the specified end time.
  • Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. [DO NOT TRANSLATE]
    For example, a value of 2017-01-11T12:00:00Z indicates 20:00:00 on January 11, 2017, China Standard Time.
Status String No The status of the online editing project. Separate multiple statuses with commas (,), for example, Normal, Produced. Online editing projects in all statuses are obtained by default.
Valid values:
  • Normal
  • Producing
  • Produced
  • ProduceFailed
Title String No The title of the online editing project.
PageNo Long No The number of the page to return.
Default value: 1.
PageSize Long No The number of entries to return on each page.
  • Default value: 10.
  • Maximum value: 100.
SortBy String No The sorting rule of results. Valid values:
  • CreationTime:Desc
  • CreationTime:Asc
Default value: CreationTime:Desc (indicating that results are sorted based on the creation time in descending order).

Sample request

http://vod.cn-shanghai.aliyuncs.com/?Action=SearchEditingProject&Format=JSON&<Common request parameters>

Note: For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Description
RequestId String The ID of the request.
Total Long The total number of online editing projects.
ProjectList EditingProject[] The list of online editing projects. For more information about the structure, see EditingProject.

Note: Response parameters do not include the Timeline parameter.

API examples

Sample request

http://vod.cn-shanghai.aliyuncs.com/?Action=SearchEditingProject&Title=test&Format=JSON&<Common request parameters>

Note: For more information about common request parameters, see Common parameters.

Sample response

JSON format

{
    "RequestId": "9262E3DA-07FA-48CA-A362-FCBB6BC61D08",
    "ProjectList": {
        "Project": [
            {
                "Status": "Normal",
                "Duration": 22.65,
                "CreateTime": "2017-10-23 13:33:40",
                "ModifyTime": "2017-10-23 19:07:14",
                "ProjectId": "25cfc178d2de418baace77aebed6afcd",
                "Title": "Video_1508736815000"
            },
            {
                "Status": "Normal",
                "Description": "Storyboard test project 001 description 1231313",
                "CreateTime": "2017-10-19 18:15:15",
                "ModifyTime": "2017-10-19 18:15:15",
                "ProjectId": "fb2101bf24bf41c78b2754cb318787dc",
                "Title": "Storyboard test project 001"
            }
        ]
    },
    "Total": 2
}

SDK examples

We recommend that you use a server SDK to call this operation. For more information about the sample code used to call this operation in various languages, see the following topics: