SearchEditingProject - - Alibaba Cloud Documentation Center

Queries online editing projects by creation time and status.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
ice:SearchEditingProject		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The beginning of the time range to query. 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
EndTime	string	No	The end of the time range to query. 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
Status	string	No	The status of the online editing project. Separate multiple values with commas (,). By default, all online editing projects are queried. Valid values: -Draft -Producing -Produced -ProduceFailed	Producing
SortBy	string	No	The sorting rule of results. Valid values: - CreationTime:Desc (default): The results are sorted in reverse chronological order based on the creation time. - CreationTime:Asc: The results are sorted in chronological order based on the creation time.	CreationTime:Desc
PageNo	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page. Default value: 10. Valid values: 1 to 100.	10
CreateSource	string	No	The source of the project. -OpenAPI -AliyunConsole -WebSDK Valid values: AliyunConsole: The project is created in the Alibaba Cloud console. WebSDK: The project is created by using the SDK for Web. OpenAPI: The project is created by calling API operations.	WebSDK
TemplateType	string	No	The template type. Valid values: -Timeline -VETemplate Valid values: Timeline: regular template. VETemplate: advanced template. None: No template is used.	Timeline
ProjectType	string	No	The type of the editing project. Default value: EditingProject. Valid values: EditingProject: a regular editing project. LiveEditingProject: a live stream editing project.	EditingProject

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	**9262E3DA-07FA-4862-FCBB6BC61D08***
ProjectList	array<object>	The queried online editing projects.
ProjectList	object
ProjectId	string	The ID of the online editing project.	**fddd7748b58bf1d47e95**
Title	string	The title of the online editing project.	title
Timeline	string	The timeline of the online editing project.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"**4d7cf14dc7b83b0e801c"},{"MediaId":"4d7cf14dc7b83b0e801c**"}]}]}
Description	string	The description of the online editing project.	sample description
CoverURL	string	The thumbnail URL of the online editing project.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg
CreateTime	string	The time when the online editing project was created.	2017-01-11T12:00:00Z
ModifiedTime	string	The time when the online editing project was last modified.	2017-01-11T12:00:00Z
Duration	long	The total length of the online editing project. Unit: seconds.	30.100000
Status	string	The status of the online editing project. Valid values: -Draft -Editing -Producing -Produced -ProduceFailed Valid values: Draft Produced Editing Producing ProduceFailed	PRODUCE_FAILED
ErrorCode	string	The error code returned if the production of the online editing project failed.	InvalidParameter
ErrorMessage	string	The error message returned if the production of the online editing project failed.	"EventTime":"2021-08-12T10:04:15Z","ErrorCode":"InvalidParameter","ErrorMessage":"The specified parameter \"LiveStreamConfig\" is not valid. specified parameter example is not valid.
CreateSource	string	The method for editing the online editing project. -OpenAPI -AliyunConsole -WebSDK Valid values: AliyunConsole: The project is created in the Alibaba Cloud console. WebSDK: The project is created by using the SDK for Web. OpenAPI: The project is created by calling API operations.	OpenAPI
ModifiedSource	string	The method used when the online editing project was last modified.	2017-01-11T12:00:00Z
TemplateType	string	The type of the template.	Timeline
ProjectType	string	The type of the editing project. Valid values: LiveEditingProject: a live stream editing project. EditingProject: a regular editing project.	EditingProject
BusinessConfig	string	The business configuration of the project. This parameter can be ignored for general editing projects.	{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }
BusinessStatus	string	The business status of the project. This parameter can be ignored for general editing projects. Valid values: Valid values: BroadCasting: ReservationCanceled LiveFinished LoadingFailed Reserving	Reserving
MaxResults	long	The maximum number of entries returned on a single page. The value is set to the maximum number of entries returned on each page except for the last page. Examples: Valid example: 10,10,5. Invalid example: 10,5,10.	10
TotalCount	long	Optional. The total number of entries returned. By default, this parameter is not returned.	110
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	null

Examples

Sample success responses

JSONformat

{
  "RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "ProjectList": [
    {
      "ProjectId": "****fddd7748b58bf1d47e95****",
      "Title": "title",
      "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"},{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"}]}]}",
      "Description": "sample description",
      "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg",
      "CreateTime": "2017-01-11T12:00:00Z",
      "ModifiedTime": "2017-01-11T12:00:00Z",
      "Duration": 30.1,
      "Status": "PRODUCE_FAILED",
      "ErrorCode": "InvalidParameter",
      "ErrorMessage": "\"EventTime\":\"2021-08-12T10:04:15Z\",\"ErrorCode\":\"InvalidParameter\",\"ErrorMessage\":\"The specified parameter \\\"LiveStreamConfig\\\" is not valid. specified parameter example is not valid.",
      "CreateSource": "OpenAPI",
      "ModifiedSource": "2017-01-11T12:00:00Z",
      "TemplateType": "Timeline",
      "ProjectType": "EditingProject",
      "BusinessConfig": "{ \"OutputMediaConfig\" : { \"StorageLocation\": \"test-bucket.oss-cn-shanghai.aliyuncs.com\", \"Path\": \"test-path\" }, \"OutputMediaTarget\": \"oss-object\", \"ReservationTime\": \"2021-06-21T08:05:00Z\" }",
      "BusinessStatus": "Reserving"
    }
  ],
  "MaxResults": 10,
  "TotalCount": 110,
  "NextToken": "null"
}

Error codes

For a list of error codes, visit the Service error codes.