Queries a list of projects that meet the specified conditions. You can filter projects by project creation time.
Debugging
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 Resourcesis 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:ListEditingProjects | list | *All Resources * |
| 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:
| 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 parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "*****ACB-44F2-5F2D-88D7-1283E70*****",
"NextToken": "Nzv3rcKla9wHUGua9YXHNA==",
"MaxResults": 10,
"ProjectList": [
{
"ProjectId": "****fddd7748b58bf1d47e95****",
"Title": "",
"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
For a list of error codes, visit the Service error codes.