DocsICP FilingConsole
Documentation
Home Page Intelligent Media Services Developer Reference API Reference API catalog Miscellaneous SearchEditingProject

SearchEditingProject

Updated at:
Copy as MD
Product
My Favorites

Searches for cloud editing projects by creation time and status.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:SearchEditingProject

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
StartTime

string

No

The start time of the creation time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

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

string

No

The end time of the creation time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

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

string

No

The status of the cloud editing project. Separate multiple values with commas (,). By default, all cloud editing projects are retrieved.

Valid values:

  • Draft: draft.

  • Producing: producing.

  • Produced: produced.

  • ProduceFailed: production failed.

Valid values:

  • Draft :

    Draft.

  • Produced :

    Produced.

  • Producing :

    Producing.

  • ProduceFailed :

    Production failed.

Producing
SortBy

string

No

The sorting method for the results. Valid values:

  • CreationTime:Desc: Sort by creation time in descending order. This is the default value.

  • CreationTime:Asc: Sort by creation time in ascending order.

Valid values:

  • CreationTime:Asc :

    Sort by creation time in ascending order.

  • CreationTime:Desc :

    Sort by creation time in descending order.

CreationTime:Desc
PageNo

integer

No

The page number. Default value: 1.

1
PageSize

integer

No

The number of entries per page. Default value: 10. Maximum value: 100.

10
CreateSource

string

No

The creation source. Valid values:

  • OpenAPI: OpenAPI.

  • AliyunConsole: Alibaba Cloud console.

  • WebSDK: WebSDK.

Valid values:

  • AliyunConsole :

    Alibaba Cloud console.

  • WebSDK :

    WebSDK.

  • OpenAPI :

    OpenAPI.

WebSDK
TemplateType

string

No

The templatetype. Valid values:

  • Timeline: timeline.

  • VETemplate: advanced template.

Valid values:

  • Timeline :

    Standard template.

  • VETemplate :

    Advanced template.

  • None :

    No template used.

Timeline
ProjectType

string

No

The type of the editing project. Default value: EditingProject.

Valid values:

  • EditingProject: Standard editing project. This is the default value.

  • LiveEditingProject: Live editing project.

Valid values:

  • LiveEditingProject :

    Live editing project.

  • EditingProject :

    Standard editing project.

EditingProject

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

****9262E3DA-07FA-4862-FCBB6BC61D08*****
ProjectList

array<object>

The cloud editing project list.

object

ProjectId

string

The ID of the cloud editing project.

****fddd7748b58bf1d47e95****
Title

string

The title of the cloud editing project.

title
Timeline

string

The timeline of the cloud editing project.

{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}
Description

string

The description of the cloud editing project.

sample description
CoverURL

string

The cover of the cloud editing project.

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg
CreateTime

string

The creation time of the cloud editing project. The time is in ISO 8601 format and uses UTC (ending with Z).

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

string

The last modification time of the cloud editing project. The time is in ISO 8601 format and uses UTC (ending with Z).

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

integer

The total duration of the cloud editing project. Unit: seconds.

30.100000
Status

string

The list of all cloud editing project statuses. Valid values:

  • Draft

  • Editing

  • Producing

  • Produced

  • ProduceFailed

Valid values:

  • Draft :

    Draft.

  • Produced :

    Production completed.

  • Editing :

    Editing.

  • Producing :

    Producing.

  • ProduceFailed :

    Production failed.

PRODUCE_FAILED
ErrorCode

string

The error code returned when the production of the cloud editing project fails.

InvalidParameter
ErrorMessage

string

The error message returned when the production of the cloud editing project fails.

"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 editing method of the cloud editing project. Valid values:

  • OpenAPI

  • AliyunConsole

  • WebSDK

Valid values:

  • AliyunConsole :

    Alibaba Cloud console.

  • WebSDK :

    WebSDK.

  • OpenAPI :

    OpenAPI.

OpenAPI
ModifiedSource

string

The source of the last modification.

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

string

The templatetype.

Timeline
ProjectType

string

The type of the editing project.

Valid values:

  • LiveEditingProject :

    Live editing project.

  • EditingProject :

    Standard editing project.

EditingProject
BusinessConfig

string

The business configuration of the project. You can ignore this parameter 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. You can ignore this parameter for general editing projects.

Valid values:

  • BroadCasting :

    Live streaming.

  • ReservationCanceled :

    Reservation canceled.

  • LiveFinished :

    Live streaming ended.

  • LoadingFailed :

    Loading failed.

  • Reserving :

    Reserving.

Reserving
MaxResults

integer

The maximum number of records returned by the current request. The number of records on each page before the last page is the value of MaxResults. Examples: Valid example: 10, 10, 5. Invalid example: 10, 5, 10.

10
TotalCount

integer

The total number of data entries that meet the request conditions. This parameter is optional and is not returned by default.

110
NextToken

string

The token that indicates the position where the current call stops reading. An empty value indicates that all data has been read.

null

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：GetStorageListNext：StopRtcRobotInstance