All Products
Search

This Product

    Intelligent Media Services:UpdateMediaInfo

    Document Center

    Intelligent Media Services:UpdateMediaInfo

    Last Updated:Mar 30, 2026

    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.

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

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    MediaId

    string

    No

    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****
    InputURL

    string

    No

    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
    BusinessType

    string

    No

    The business type. Valid values:

    • subtitles

    • watermark

    • opening

    • ending

    • general

    video
    Title

    string

    No

    The title.

    • The value can be up to 128 bytes in length.

    • The value must be encoded in UTF-8.

    defaultTitle
    Description

    string

    No

    The content description.

    • The value can be up to 1,024 bytes in length.

    • The value must be encoded in UTF-8.

    defaultDescription
    Category

    string

    No

    The category.

    • The value can be up to 64 bytes in length.

    • The value must be encoded in UTF-8.

    defaultCategory
    MediaTags

    string

    No

    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
    CoverURL

    string

    No

    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
    UserData

    string

    No

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

    userData
    AppendTags

    boolean

    No

    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
    CateId

    integer

    No

    The category ID.

    3048
    ReferenceId

    string

    No

    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 elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

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

    string

    The ID of the media asset in IMS.

    ****20b48fb04483915d4f2cd8ac****

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.