GetEditingProjectMaterials-Intelligent Media Services(IMS)-阿里云帮助中心

Retrieves all media assets associated with the current project.

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:GetEditingProjectMaterials

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	The ID of the cloud editing project.	***fb2101cb318***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****89-C21D-4B78-AE24-3788B8****
ProjectId	string	The project ID.	***67ae06542b9b93e0d1c387***
MediaInfos	array<object>	The media assets that meet the requirements.
	array<object>
MediaId	string	The media ID.	***64623a94eca8516569c8fe***
MediaBasicInfo	object	The basic information of the media asset.
MediaId	string	The media ID.	***64623a94eca8516569c8f***
InputURL	string	The URL of the media asset to be registered in the corresponding system.	http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4
MediaType	string	The media type.	video
BusinessType	string	The business type.	general
Source	string	The source.	oss
Title	string	The title.	file.mp4
Description	string	The description.	sample_description
Category	string	The category.	video
MediaTags	string	The tags.	Tag,tag1
CoverURL	string	The URL of the cover image.	http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature
UserData	string	The user data.	userData
Snapshots	string	The snapshots.	null
Status	string	The resource status.	Normal
TranscodeStatus	string	The transcoding status. Valid values: TranscodeFailed : Transcoding failed. TranscodeSuccess : Transcoding completed. Init : Initialized. Transcoding : Transcoding.	Init
CreateTime	string	The time when the media asset was created. The time follows the ISO 8601 standard in UTC (ending with Z).	2020-12-26T04:11:08Z
ModifiedTime	string	The time when the media asset was modified. The time follows the ISO 8601 standard in UTC (ending with Z).	2020-12-26T04:11:08Z
DeletedTime	string	The time when the media asset was deleted. The time follows the ISO 8601 standard in UTC (ending with Z).	2020-12-26T04:11:08Z
SpriteImages	string	The image sprites.	null
FileInfoList	array<object>	The file information.
	array<object>
FileBasicInfo	object	The basic information of the file, including the duration and size.
FileName	string	The file name.	example.mp4
FileStatus	string	The file status.	Normal
FileType	string	The file type.	source_file
FileSize	string	The file size in bytes.	30611502
FileUrl	string	The OSS URL of the file.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=
Region	string	The storage region of the file.	cn-shanghai
FormatName	string	The container format.	mov,mp4,m4a,3gp,3g2,mj2
Duration	string	The duration.	216.206667
Bitrate	string	The bitrate.	1132.68
Width	string	The width.	960
Height	string	The height.	540
LiveMaterials	array<object>	The materials associated with the live stream.
	object
AppName	string	The application name of the live stream.	testrecord
StreamName	string	The stream name of the live stream.	testrecord
DomainName	string	The domain name of the live stream.	test.alivecdn.com
LiveUrl	string	The URL of the live stream.	rtmp://test.alivecdn.com/testrecord/teststream
ProjectMaterials	array	The materials associated with the editing project. A live editing project is associated with a regular editing project after the live stream ends.	***9b145c5cafc2e057304fcd***
	string	The ID of the regular editing project associated with the live editing project.	***c38767ae06542b9b93e0d1***

Examples

Success response

JSON format

{
  "RequestId": "******89-C21D-4B78-AE24-3788B8******",
  "ProjectId": "*****67ae06542b9b93e0d1c387*****",
  "MediaInfos": [
    {
      "MediaId": "*****64623a94eca8516569c8fe*****",
      "MediaBasicInfo": {
        "MediaId": "*****64623a94eca8516569c8f*****",
        "InputURL": "http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4",
        "MediaType": "video",
        "BusinessType": "general",
        "Source": "oss",
        "Title": "file.mp4",
        "Description": "sample_description",
        "Category": "video",
        "MediaTags": "Tag,tag1",
        "CoverURL": "http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature",
        "UserData": "userData",
        "Snapshots": "null",
        "Status": "Normal",
        "TranscodeStatus": "Init",
        "CreateTime": "2020-12-26T04:11:08Z",
        "ModifiedTime": "2020-12-26T04:11:08Z",
        "DeletedTime": "2020-12-26T04:11:08Z",
        "SpriteImages": "null"
      },
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "FileName": "example.mp4",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileSize": "30611502",
            "FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=",
            "Region": "cn-shanghai",
            "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
            "Duration": "216.206667",
            "Bitrate": "1132.68",
            "Width": "960",
            "Height": "540"
          }
        }
      ]
    }
  ],
  "LiveMaterials": [
    {
      "AppName": "testrecord",
      "StreamName": "testrecord",
      "DomainName": "test.alivecdn.com",
      "LiveUrl": "rtmp://test.alivecdn.com/testrecord/teststream"
    }
  ],
  "ProjectMaterials": [
    "*****c38767ae06542b9b93e0d1*****"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter \ is not valid.
404	ProjectNotFound	The specified project not found

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.