All Products
Search
Document Center

Intelligent Media Services:UpdateMediaInfo

Last Updated:Oct 29, 2024

Updates information about a media asset based on the ID of the media asset in Intelligent Media Services (IMS) or the input URL of the media asset.

Operation description

If the MediaId parameter is specified, the MediaId parameter is preferentially used for the query. If the MediaId parameter is left empty, the InputURL parameter must be specified. The request ID and media asset ID are returned. You cannot modify the input URL of a media asset by specifying the ID of the media asset.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:UpdateMediaInfo
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MediaIdstringNo

The ID of the media asset. If this parameter is left empty, you must specify the input URL of the media asset, which has been registered in the IMS content library.

****20b48fb04483915d4f2cd8ac****
InputURLstringNo

The input URL of the media asset in another service. The URL must be bound to the ID of the media asset in IMS. The URL cannot be modified once registered.

For a media asset from Object Storage Service (OSS), the URL may have one of the following formats:

1. http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4

2. oss://example-bucket/example.mp4. This format indicates that the region in which the OSS bucket of the media asset resides is the same as the region in which OSS is activated.

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4
BusinessTypestringNo

The business type. Valid values:

  • subtitles
  • watermark
  • opening
  • ending
  • general
video
TitlestringNo

The title.

  • The value can be up to 128 bytes in length.
  • The value must be encoded in UTF-8.
defaultTitle
DescriptionstringNo

The content description.

  • The value can be up to 1,024 bytes in length.
  • The value must be encoded in UTF-8.
defaultDescription
CategorystringNo

The category.

  • The value can be up to 64 bytes in length.
  • The value must be encoded in UTF-8.
defaultCategory
MediaTagsstringNo

The tags.

  • Up to 16 tags are supported.
  • Separate multiple tags with commas (,).
  • Each tag can be up to 32 bytes in length.
  • The value must be encoded in UTF-8.
updateTags1,updateTags2
CoverURLstringNo

The URL of the thumbnail.

  • The value can be up to 128 bytes in length.
  • The value must be encoded in UTF-8.
http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png
UserDatastringNo

The user data. It can be up to 1,024 bytes in size.

userData
AppendTagsbooleanNo

Specifies whether to append tags. Default value: false. Valid values:

  • true: updates the MediaTags parameter by appending new tags.
  • false: updates the MediaTags parameter by overwriting existing tags with new tags.
true
CateIdlongNo

The category ID.

3048
ReferenceIdstringNo

The custom ID. The ID can be 6 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (_). Make sure that the ID is unique among users.

123-123

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

******11-DB8D-4A9A-875B-275798******
MediaIdstring

The ID of the media asset in IMS.

****20b48fb04483915d4f2cd8ac****

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "MediaId": "****20b48fb04483915d4f2cd8ac****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history