All Products
Search

This Product

    ApsaraVideo VOD:UpdateVideoInfo

    Document Center

    ApsaraVideo VOD:UpdateVideoInfo

    Last Updated:Feb 06, 2025

    Modifies the information about an audio or video file.

    Operation description

    You can call this operation to modify information such as the title, tags, and description about audio and video files based on audio or video IDs. You must pass in the parameters that you want to modify. Otherwise, parameter configurations are not overwritten.

    Queries per second (QPS) limit

    You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits on API operations.

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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
    vod:UpdateVideoInfoupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    VideoIdstringYes

    The ID of the audio or video file. Perform the following operations to obtain the storage address:

    • Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, view the ID of the audio or video file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console.
    • Obtain the value of VideoId from the response to the CreateUploadVideo operation that you called to obtain the upload URL and credential.
    • View the value of the VideoId parameter returned by the SearchMedia operation that you called to query media information after the audio or video file is uploaded.
    		2deda93265312baf9b0ed810d****
    TitlestringNo

    The title of the audio or video file.

    • The name cannot exceed 128 bytes.
    • The value is encoded in UTF-8.
    		video title
    TagsstringNo

    The tags of the media file.

    • Each tag can be up to 32 bytes in length. You can specify up to 16 tags.
    • Separate multiple tags with commas (,).
    • The value is encoded in UTF-8.
    		tag1,tag2
    DescriptionstringNo

    The description of the audio or video file.

    • The description can be up to 1,024 bytes in length.
    • The value is encoded in UTF-8.
    		video description
    CoverURLstringNo

    The URL of the audio/video thumbnail.

    		https://example.aliyundoc.com/****.jpg
    CateIdlongNo

    The category ID. You can use one of the following methods to obtain the ID:

    • Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Configuration Management > Media Management > Categories to view the category ID of the media file.
    • View the value of the CateId parameter returned by the AddCategory operation that you called to create a category.
    • View the value of the CateId parameter returned by the GetCategories operation that you called to query a category.
    		384761111
    UserDatastringNo

    Custom settings. This is a JSON string that supports message callbacks, upload acceleration, and other settings. For more information, please refer to UserData .

    		{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned result.

    RequestIdstring

    The request ID.

    		25818875-5F78-4AF6-D7393642CA58****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-11-26The request parameters of the API has changedView Change Details

    Common errors

    The following table describes the common errors that this operation can return.

    Error codeError messageHTTP status codeDescription
    InvalidVideo.NotFoundThe video does not exist.404The error message returned because the video does not exist.