All Products
Search

This Product

    Intelligent Media Services:UploadStreamByURL

    Document Center

    Intelligent Media Services:UploadStreamByURL

    Last Updated:Dec 16, 2024

    Uploads a media stream file based on the URL of the source file.

    Operation description

    • You can call this operation to pull a media stream file based on a URL and upload the file. After the media stream file is uploaded, the media stream is associated with the specified media asset ID.
    • You can call this operation to upload media stream files only to ApsaraVideo VOD, but not to your own Object Storage Service (OSS) buckets. To upload a media stream file to an OSS bucket, pull the file to a local directory, use OSS SDK to upload the file to an OSS bucket, and then call the RegisterMediaStream operation to associate the media stream with the specified media asset ID.
    • This operation is available only in the China (Shanghai), China (Beijing), and China (Shenzhen) regions.

    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:UploadStreamByURLcreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    StreamURLstringNo

    The URL of the transcoded stream file.

    If the URL of the transcoded stream requires authentication, you must specify the authentication parameters in the stream URL and make sure that the URL can be accessed over the Internet.

    		https://example.com/sample-stream.mp4
    MediaIdstringNo

    The ID of the media asset.

    		411bed50018971edb60b0764a0ec6***
    DefinitionstringNo

    The quality of the media stream. Valid values:

    • FD: low definition.
    • LD: standard definition.
    • SD: high definition.
    • HD: ultra-high definition.
    • OD: original quality.
    • 2K: 2K resolution.
    • 4K: 4K resolution.
    • SQ: standard sound quality.
    • HQ: high sound quality.
    		HD
    FileExtensionstringNo

    The file name extension of the media stream.

    		mp4
    HDRTypestringNo

    The high dynamic range (HDR) format of the transcoded stream. Valid values:

    • HDR
    • HDR10
    • HLG
    • DolbyVision
    • HDRVivid
    • SDR+
    Note

    • The value is not case-sensitive,

    • You can leave this parameter empty for non-HDR streams.

    		HDR10
    UserDatastringNo

    The user data.

    		{"MessageCallback":{"CallbackURL":"http://test.test.com"}, "Extend":{"localId":"xxx","test":"www"}}

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		******89-C21D-4B78-AE24-3788B8******
    JobIdstring

    The ID of the upload job.

    		****cdb3e74639973036bc84****
    MediaIdstring

    The ID of the media asset.

    		411bed50018971edb60b0764a0ec6***
    FileURLstring

    The OSS URL of the file.

    		http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4
    SourceURLstring

    The URL of the source file that is uploaded in the upload job.

    		https://example.com/sample-stream.mp4

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "******89-C21D-4B78-AE24-3788B8******",
  "JobId": "****cdb3e74639973036bc84****",
  "MediaId": "411bed50018971edb60b0764a0ec6***",
  "FileURL": "http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4",
  "SourceURL": "https://example.com/sample-stream.mp4"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history