tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ApplyUpload

Last updated: 2024-03-27 16:08:34

    1. API Description

    Domain name for API request: vod.tencentcloudapi.com.

    • This API is used to apply for uploading a media file (and cover file) to VOD and obtain the metadata of file storage (including upload path and upload signature) for subsequent use by the uploading API.
    • For the detailed upload process, please see Overview of Upload from Client.

    A maximum of 100 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: ApplyUpload.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    MediaType Yes String Media type. For the detailed valid values, please see Upload Overview.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    MediaName No String Media name.
    CoverType No String Cover type. For the detailed valid values, please see Upload Overview.
    Procedure No String Subsequent task operation on a media file, i.e., after a media file is uploaded, task flow operations will be initiated automatically. This parameter value is a task flow template name. VOD supports creating task flow templates and naming the templates.
    ExpireTime No Timestamp ISO8601 Expiration time of a media file in ISO 8601 format. For more information, please see Notes on ISO Date Format.
    StorageRegion No String Specifies upload region. This is only applicable to users that have special requirements for the upload region.
    ClassId No Integer Category ID, which is used to categorize the media for management. A category can be created and its ID can be obtained by using the category creating API.
  • Default value: 0, which means "Other".
    		•
    SourceContext No String Source context, which is used to pass through the user request information. The upload callback API will return the value of this field. It can contain up to 250 characters.
    SessionContext No String Session context, which is used to pass through the user request information. If the Procedure parameter is specified, the task flow status change callback API will return the value of this field. It can contain up to 1,000 characters.
    ExtInfo No String Reserved parameter for special purposes.

    3. Output Parameters

    Parameter Name Type Description
    StorageBucket String Storage bucket, which is used as the bucket_name in the URL of the upload API.
    StorageRegion String Storage region, which is used as the Region in the Host of the upload API.
    VodSessionKey String VOD session, which is used to confirm the VodSessionKey parameter of the upload API.
    MediaStoragePath String Media storage path, which is used as the Key of the stored media of the upload API.
    Note: this field may return null, indicating that no valid values can be obtained.
    CoverStoragePath String Cover storage path, which is used as the Key of the stored cover of the upload API.
    Note: this field may return null, indicating that no valid values can be obtained.
    TempCertificate TempCertificate Temporary credential, which is used for authentication of the upload API.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Successful application upload examples

    Successful application upload examples.

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyUpload
<Public Request Parameter>

{
    "SubAppId": "1",
    "MediaType": "mp4"
}

    Output Example

    {
    "Response": {
        "CoverStoragePath": "/dir/cover.xx",
        "RequestId": "880f3005-a8c9-4bba-8c87-74e216a17a0b",
        "StorageBucket": "xadagzp111211-100922",
        "StorageRegion": "ap-guangzhou-2",
        "MediaStoragePath": "/dir/name.xx",
        "VodSessionKey": "VodSessionKey",
        "TempCertificate": {
            "SecretId": "xxxxxxx",
            "SecretKey": "xxxxxxxx",
            "Token": "xxxxxxxx",
            "ExpiredTime": 182823331
        }
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter.ExpireTime Incorrect parameter value: expiration time.
    InvalidParameterValue.CoverType Incorrect parameter value: cover type.
    InvalidParameterValue.ExpireTime Incorrect parameter value: incorrect ExpireTime format.
    InvalidParameterValue.MediaType Incorrect parameter value: media type.
    InvalidParameterValue.SubAppId Incorrect parameter value: subapplication ID
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy