Obtain upload URL and credential for a media asset using CreateUploadMedia - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Operation description

Obtain the upload URLs and credentials of audio and video files. You can also call this operation to obtain the upload URLs and credentials of images and auxiliary media assets.
Obtaining an upload URL and credential is essential for Intelligent Media Services (IMS) and is required in each upload operation.
If the video upload credential expires, you can call the RefreshUploadMedia operation to obtain a new upload credential. The default validity period of a video upload credential is 3,000 seconds.
After you upload a media asset, you can configure a callback to receive upload event notifications or call the GetMediaInfo operation to determine whether the media asset is uploaded based on the returned status.
The MediaId parameter returned by this operation can be used for media asset lifecycle management or media processing.
Upload media assets only to ApsaraVideo VOD, but not to your own Object Storage Service (OSS) buckets. To upload a media asset to your own OSS bucket, you can upload the file to your OSS bucket by using OSS SDK, and then call the RegisterMediaInfo operation to register the file in the OSS bucket with the media asset library.
This operation is available only in the China (Shanghai), China (Beijing), and China (Shenzhen) regions.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The application ID. Default value: app-1000000.	app-1000000
EntityId	string	No	The entity ID. You can call the CreateEntity operation to create an entity and specify a dynamic metadata structure.	9e177cac2fb44f8b8c67b199fcc7bffd
FileInfo	string	No	The file information, which is in the JSON format and contains the following fields: Type: required. The file type. Valid values: video, image, audio, text, and other. Name: required. The file name without the extension. Size: optional. The file size. Ext: required. The file name extension.	{\"Type\":\"video\",\"Name\":\"test\",\"Size\":108078336,\"Ext\":\"mp4\"}
UserData	string	No	The user data. The value must be a JSON string. You can configure settings such as message callbacks.	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}
UploadTargetConfig	string	No	The destination storage address. Set StorageType to oss. Set StorageLocation to an address in ApsaraVideo VOD. You cannot set this field to an OSS URL.	{\"StorageType\":\"oss\",\"StorageLocation\":\"outin-***.oss-cn-shanghai.aliyuncs.com\"}
MediaMetaData	string	No	The metadata of the media asset, which is a JSON string that contains the following fields: Title: required. The value can be up to 128 characters in length. The value must be encoded in UTF-8. Description: optional. The value can be up to 1,024 characters in length. The value must be encoded in UTF-8. CateId: optional. Tags: optional. BusinessType: required. Valid values: opening or ending if Type is set to video default or cover if Type is set to image subtitles or font if Type is set to text watermark if Type is set to material general CoverURL: optional. DynamicMetaData: The value is a string.	{\"Title\": \"UploadTest\", \"Description\": \"UploadImageTest\", \"Tags\": \"tag1,tag2\",\"BusinessType\":\"cover\"}
PostProcessConfig	string	No	The postprocessing configurations. You can specify this parameter if Type is set to video or audio. Set ProcessType to Workflow.	{\"ProcessType\":\"Workflow\",\"ProcessID\":\"74ba870f1a4873a3ba238e0bf6fa9***\"}

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4E84BE44-58A7-**-**-FBEBEA16EF94
MediaId	string	The ID of the media asset.	**20b48fb04483915d4f2cd8ac**
MediaURL	string	The URL of the media asset. Note If a domain name for Alibaba Cloud CDN (CDN) is specified, a CDN URL is returned. Otherwise, an OSS URL is returned. If the HTTP status code 403 is returned when you access the URL from your browser, the URL authentication feature of ApsaraVideo VOD is enabled. To resolve this issue, disable URL authentication or generate an authentication signature.	https://xxq-live-playback.oss-cn-shanghai.aliyuncs.com/capture/5d96d2b4-111b-4e5d-a0e5-20f44405bb55.mp4
FileURL	string	The OSS URL of the file. The URL does not contain the information used for authentication.	http://outin-***.oss-cn-north-2-gov-1.aliyuncs.com/sv/40360f05-181f63c3110-0004-cd8e-27f-de3c9.mp4
UploadAddress	string	The upload URL. Note The returned upload URL is a Base64-encoded URL. You must decode the Base64-encoded upload URL before you use an SDK or call an API operation to upload media files. You need to parse UploadAddress only if you use OSS SDK or call an OSS API operation to upload media files.	eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****
UploadAuth	string	The upload credential. Note The returned upload credential is a Base64-encoded value. You must decode the Base64-encoded upload URL before you use an SDK or call an API operation to upload media files. You need to parse UploadAuth only if you use OSS SDK or call an OSS API operation to upload media files.	eyJFbmRwb2ludCI6Imm****

Examples

Success response

JSON format

{
  "RequestId": "4E84BE44-58A7-****-****-FBEBEA16EF94",
  "MediaId": "****20b48fb04483915d4f2cd8ac****",
  "MediaURL": "https://xxq-live-playback.oss-cn-shanghai.aliyuncs.com/capture/5d96d2b4-111b-4e5d-a0e5-20f44405bb55.mp4",
  "FileURL": "http://outin-***.oss-cn-north-2-gov-1.aliyuncs.com/sv/40360f05-181f63c3110-0004-cd8e-27f-de3c9.mp4",
  "UploadAddress": "eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****",
  "UploadAuth": "eyJFbmRwb2ludCI6Imm****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.