Add Video Materials via AddEditingProjectMaterials API - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Adds one or more materials to an online editing 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

vod:AddEditingProjectMaterials

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	The online editing project ID.	afa31b483b5c41609185de0e1b790579
MaterialIds	string	Yes	The material IDs. Separate multiple IDs with commas (,). A maximum of 10 material IDs are supported. Note When you associate multiple materials, ensure that all materials are of the same type and correspond to the MaterialType value.	d3251979f9fd41f2acb29ccda5a6f772
MaterialType	string	Yes	The material type. Valid values: video: video. audio: audio-only. image: image.	video

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	85237CDA-0B54-5CED-BA10-A8A71AA13C1A
MaterialList	array<object>	The list of materials.
	object	The material details.
Status	string	The material status. Valid values: Normal: Normal. Uploading: Uploading. UploadFail: Upload failed.	Normal
CateId	integer	The category ID.	1000487543
CreateTime	string	The time when the material was created. The time follows the format: yyyy-mm-ddthh:mm:ssz (UTC).	2019-10-02T08:26Z
MaterialType	string	The material type. Valid values: video: video. audio: audio-only. image: image.	video
Tags	string	The material tags. Multiple tags are separated by commas (,).	tag1,tag2
SpriteConfig	string	The sprite configuration.	xxx
CateName	string	The material category name.	Category 1
Description	string	The material description.	Material description
MaterialId	string	The material ID.	85befc4118b84c6723e53b80b1****
Size	integer	The file size.	1682694
CoverURL	string	The thumbnail URL of the material.	http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg
Duration	number	The material duration. Unit: seconds. The value is accurate to four decimal places.	3690.2332
CustomerId	integer	The user ID.	1234751840694470
Title	string	The material title.	test
ModifyTime	string	The time when the material was last modified. The time follows the format: yyyy-mm-ddthh:mm:ssz (UTC).	2022-11-25T07:28:34Z
Sprites	array	The array of sprite URLs for the material.
	string	The sprite URL of the material.	"http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0**.jpg?auth_key=**"
Snapshots	array	The array of snapshot URLs for the material.
	string	The snapshot URL of the material.	"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0**.jpg?auth_key=","http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0**.jpg?auth_key="

Examples

Success response

JSON format

{
  "RequestId": "85237CDA-0B54-5CED-BA10-A8A71AA13C1A",
  "MaterialList": [
    {
      "Status": "Normal",
      "CateId": 1000487543,
      "CreateTime": "2019-10-02T08:26Z",
      "MaterialType": "video",
      "Tags": "tag1,tag2",
      "SpriteConfig": "xxx",
      "CateName": "Category 1",
      "Description": "Material description",
      "MaterialId": "85befc4118b84c6723e53b80b1****",
      "Size": 1682694,
      "CoverURL": "http://example.aliyundoc.com/aivideocover/46fa444aa34065cb9250f6c****/image_01.jpg",
      "Duration": 3690.2332,
      "CustomerId": 1234751840694470,
      "Title": "test",
      "ModifyTime": "2022-11-25T07:28:34Z",
      "Sprites": [
        "\"http://example.aliyundoc.com/material_big_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=****\""
      ],
      "Snapshots": [
        "\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\",\"http://example.aliyundoc.com/material_small_snapshot/0f325c157386f2a7e91b2ff0****.jpg?auth_key=\""
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.