All Products
Search

This Product

    Intelligent Media Services:CreateUploadStream

    Document Center

    Intelligent Media Services:CreateUploadStream

    Last Updated:Nov 25, 2024

    Obtains the upload URL and credential of a media stream.

    Operation description

    • You can call this operation to upload only a local media stream. After the media stream is uploaded, it is associated with the specified media asset ID.
    • You can call this operation to upload media streams only to ApsaraVideo VOD, but not to your own Object Storage Service (OSS) buckets. To upload a media stream to your own OSS bucket, you can upload the file to your OSS bucket by using OSS SDK, 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:CreateUploadStreamcreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    MediaIdstringNo

    The ID of the media asset.

    		****20b48fb04483915d4f2cd8ac****
    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://aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

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

    The ID of the media asset.

    		****c469e944b5a856828dc2****
    FileURLstring

    The Object Storage Service (OSS) URL of the file. The URL does not contain the information used for authentication.

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

    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.
    		eyJFbmRwb2ludCI6Imh0dHBzOi8vb3NzLWNuLXNoYW5naGFpLmFsaXl1bmNzLmNvbSIsIkJ1Y2tldCI6InN6aGQtdmlkZW8iLCJGaWxlTmFtZSI6InZvZC0yOTYzMWEvc3YvNTBmYTJlODQtMTgxMjdhZGRiMTcvNTBmYTJlODQtMTgxMjdhZGRiM***
    UploadAuthstring

    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.
    		eyJBY2Nlc3NLZXlJZCI6IkxUQUk0Rm53bTk1dHdxQjMxR3IzSE5hRCIsIkFjY2Vzc0tleVNlY3JldCI6Ik9lWllKR0dTMTlkNkZaM1E3UVpJQmdmSVdnM3BPaiIsIkV4cGlyYXRpb24iOiI***

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "MediaId": "****c469e944b5a856828dc2****",
  "FileURL": "http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4",
  "UploadAddress": "eyJFbmRwb2ludCI6Imh0dHBzOi8vb3NzLWNuLXNoYW5naGFpLmFsaXl1bmNzLmNvbSIsIkJ1Y2tldCI6InN6aGQtdmlkZW8iLCJGaWxlTmFtZSI6InZvZC0yOTYzMWEvc3YvNTBmYTJlODQtMTgxMjdhZGRiMTcvNTBmYTJlODQtMTgxMjdhZGRiM***",
  "UploadAuth": "eyJBY2Nlc3NLZXlJZCI6IkxUQUk0Rm53bTk1dHdxQjMxR3IzSE5hRCIsIkFjY2Vzc0tleVNlY3JldCI6Ik9lWllKR0dTMTlkNkZaM1E3UVpJQmdmSVdnM3BPaiIsIkV4cGlyYXRpb24iOiI***"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history