Queries a list of projects that meet the specified conditions. You can filter projects by project creation time.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ice:ListEditingProjects |
list |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectType |
string |
No |
The type of the editing project. Valid values:
|
EditingProject |
| TemplateType |
string |
No |
The template type. This parameter is required if you create a template-based online editing project. Default value: Timeline. Valid values:
Valid values:
|
None |
| StartTime |
string |
No |
The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
2017-12-21T08:00:01Z |
| EndTime |
string |
No |
The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
2022-02-02T23:59:59Z |
| Keyword |
string |
No |
The search keyword. You can search by job ID. |
******6f36bc45d09a9d5cde49****** |
| Status |
string |
No |
The status of the online editing project. By default, online editing projects in all states are queried. |
Produced |
| CreateSource |
string |
No |
The method for creating the online editing project. Valid values: - OpenAPI - AliyunConsole - WebSDK |
OpenAPI |
| NextToken |
string |
No |
The pagination token that is used in the next request to retrieve a new page of results. |
8EqYpQbZ6Eh7+Zz8DxVYoQ== |
| MaxResults |
string |
No |
The number of entries per page. A maximum of 100 entries can be returned on each page. Default value: 10. |
10 |
| SortBy |
string |
No |
The order of sorting of the results. Valid values:
|
CreationTime:Desc |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
*****ACB-44F2-5F2D-88D7-1283E70***** |
| 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. |
Nzv3rcKla9wHUGua9YXHNA== |
| MaxResults |
integer |
The maximum number of entries returned. |
10 |
| ProjectList |
array<object> |
The queried online editing projects. |
|
|
object |
|||
| ProjectId |
string |
The ID of the online editing project. |
****fddd7748b58bf1d47e95**** |
| Title |
string |
The title of the online editing project. |
Project Title |
| Description |
string |
The description of the online editing project. |
Project Description |
| CoverURL |
string |
The thumbnail URL of the online editing project. |
https://xxx.com/cover/xxx.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 |
| Status |
string |
The status of the online editing project. Valid values: - Draft - Editing - Producing - Produced - ProduceFailed |
Produced |
| 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. |
The specified parameter \"LiveStreamConfig\" is not valid. specified parameter example is not valid. |
| CreateSource |
string |
The method for editing the online editing project. Valid values: - OpenAPI - AliyunConsole - WebSDK |
OpenAPI |
| ModifiedSource |
string |
The method for modifying the online editing project last time. |
OpenAPI |
| TemplateType |
string |
The template type. Valid values:
|
Timeline |
| ProjectType |
string |
The type of the editing project. Valid values:
|
EditingProject |
| BusinessConfig |
string |
The business configuration of the project. This parameter can be ignored for general editing projects. |
{} |
| BusinessStatus |
string |
The business status of the project. This parameter can be ignored for general editing projects. |
{} |
Examples
Success response
JSON format
{
"RequestId": "*****ACB-44F2-5F2D-88D7-1283E70*****",
"NextToken": "Nzv3rcKla9wHUGua9YXHNA==",
"MaxResults": 10,
"ProjectList": [
{
"ProjectId": "****fddd7748b58bf1d47e95****",
"Title": "工程Title",
"Description": "Project Description",
"CoverURL": "https://xxx.com/cover/xxx.jpg",
"CreateTime": "2017-01-11T12:00:00Z",
"ModifiedTime": "2017-01-11T12:00:00Z",
"Status": "Produced",
"ErrorCode": "InvalidParameter",
"ErrorMessage": "The specified parameter \\\"LiveStreamConfig\\\" is not valid. specified parameter example is not valid.",
"CreateSource": "OpenAPI",
"ModifiedSource": "OpenAPI",
"TemplateType": "Timeline",
"ProjectType": "EditingProject",
"BusinessConfig": "{}",
"BusinessStatus": "{}"
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.