tencent cloud

Feedback

PullUpload

Last updated: 2024-01-02 12:24:00

    1. API Description

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

    This API is used to pull a video on the internet to the VOD platform.

    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: PullUpload.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    MediaUrl Yes String The URL of the media to pull, which can be in HLS format, but not DASH format.
    For more information about supported extensions, see Media types. Please make sure the URL is accessible.
    MediaType No String The file format (extension). For information about supported extensions, see Media Types.
    If you do not specify this parameter or pass in an empty string, the file obtained will have the same extension as MediaUrl.
    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.
    CoverUrl No String The URL of the video to pull. Supported formats include GIF, JPEG (JPG), and PNG.
    Procedure No String Subsequent task for media. For more information, please see Specifying Task Flow After Upload.
    ExpireTime No Timestamp ISO8601 Expiration time of 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:
  • If it is left empty, the upload region is your default region;
  • If it is specified, please make sure that the upload region has been enabled for storage.
  • 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 CreateClass API.
    SessionContext No String The source context which is used to pass through the user request information. After Procedure is specified, the task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
    SessionId No String Used to identify duplicate requests. After you send a request, if any request with the same SessionId has already been sent in the last three days (72 hours), an error message will be returned. SessionId contains up to 50 characters. If this parameter is not carried or is an empty string, no deduplication will be performed.
    ExtInfo No String Reserved field for special purposes.
    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.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String Video pull for upload task ID, which can be used to query the status of pull for upload task.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Pulling an MP4 video from http://www.abc.com/abc.mp4 and uploading it to VOD

    This example shows you how to pull an MP4 video from a URL and upload it to VOD.

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: PullUpload
    <Common request parameters>
    
    {
        "MediaUrl": "http://www.abc.com/abc.mp4"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
            "TaskId": "125xxxxxx07-pull-893dc41e6fdc22dcf24aa6e9c61cp94"
        }
    }
    

    Example2 Pulling an MP4 video from http://www.abc.com/abc.mp4 (inside the Chinese mainland) and uploading it to the Chongqing storage region

    This example shows you how to pull an MP4 video from a URL and upload it to the Chongqing storage region.

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: PullUpload
    <Common request parameters>
    
    {
        "StorageRegion": "ap-chongqing",
        "MediaUrl": "http://www.abc.com/abc.mp4"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "6ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
            "TaskId": "125xxxxxx07-pull-793dc41e6fdc22dcf24aa6e9c61cp94"
        }
    }
    

    Example3 Pulling an MP4 video from http://www.abc.com/abc.mp4 (outside the Chinese mainland) and uploading it to the Singapore storage region

    This example shows you how to pull an MP4 video from a URL and upload it to the Singapore storage region.

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: PullUpload
    <Common request parameters>
    
    {
        "StorageRegion": "ap-singapore",
        "MediaUrl": "http://www.abc.com/abc.mp4"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
            "TaskId": "125xxxxxx07-pull-693dc41e6fdc22dcf24aa6e9c61cp94"
        }
    }
    

    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.
    FailedOperation.CoverType Operation failed: unsupported cover type.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    FailedOperation.MediaType Operation failed: unsupported media type.
    InternalError Internal error.
    InvalidParameter.ExpireTime Incorrect parameter value: expiration time.
    InvalidParameter.StorageRegion Incorrect parameter value: storage region.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.CoverUrl Incorrect parameter value: cover URL.
    InvalidParameterValue.ExpireTime Incorrect parameter value: incorrect ExpireTime format.
    InvalidParameterValue.MediaUrl Incorrect parameter value: media file URL.
    InvalidParameterValue.SessionContextTooLong SessionContext is too long.
    InvalidParameterValue.SessionId The deduplication ID already exists. The request is removed due to duplication.
    InvalidParameterValue.SessionIdTooLong SessionId is too long.
    InvalidParameterValue.StorageRegion Incorrect parameter value: StorageRegion.
    ResourceNotFound.CoverUrl The resource does not exist: the cover does not exist.
    ResourceNotFound.UserNotExist The user does not exist.
    UnauthorizedOperation Unauthorized operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support