Domain name for API request: vod.intl.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.
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 | Media URL to be pulled. Dash format is not currently supported (HLS is supported). |
| MediaType | No | String | Media type (extension). For supported types, see media type. |
| SubAppId | No | Integer | Video-on-demand (VOD) application ID. Customers who activate on-demand services after December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether the default application or a newly created application). |
| MediaName | No | String | Media name. |
| CoverUrl | No | String | Video cover URL to pull. Supported file formats: gif, jpeg (jpg), png. |
| Procedure | No | String | For media subsequent task operation, see upload specified task flow. |
| ExpireTime | No | Timestamp ISO8601 | Media file expiry time, format according to ISO 8601 standard representation. For details, see ISO date format description. |
| StorageRegion | No | String | Designated upload park, applicable only to the user with special requirement for upload target region: |
| ClassId | No | Integer | Category ID, used to categorize and manage media. You can create a category and obtain the category ID via the Create Category API. |
| TasksPriority | No | Integer | Task priority. The higher the value, the higher the priority. The value ranges from -10 to 10. If this is not specified, the default value is 0. |
| SessionContext | No | String | Source context. This is used to pass through user request information. When specifying a Procedure task, the task flow status change callback returns the value of this field. The maximum length is 1000 characters. |
| SessionId | No | String | Identifier for deduplication. If a request with the same identifier has been sent within the past three days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed. |
| ExtInfo | No | String | Reserved field, used for special purpose. |
| SourceContext | No | String | Source context. This is used to pass through user request information. The upload completion callback returns the value of this field. The maximum length is 250 characters. |
| MediaStoragePath | No | String | Media storage path, starting with /. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Pull upload video task ID. This can be used to query the task status. |
| 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. |
and uploading it to VOD
This example shows you how to pull an MP4 video from a URL and upload it to VOD.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PullUpload
<Common request parameters>
{
"MediaUrl": "http://www.abc.com/abc.mp4"
}
{
"Response": {
"RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
"TaskId": "125xxxxxx07-pull-893dc41e6fdc22dcf24aa6e9c61cp94"
}
}
(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.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PullUpload
<Common request parameters>
{
"StorageRegion": "ap-chongqing",
"MediaUrl": "http://www.abc.com/abc.mp4"
}
{
"Response": {
"RequestId": "6ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
"TaskId": "125xxxxxx07-pull-793dc41e6fdc22dcf24aa6e9c61cp94"
}
}
(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.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PullUpload
<Common request parameters>
{
"StorageRegion": "ap-singapore",
"MediaUrl": "http://www.abc.com/abc.mp4"
}
{
"Response": {
"RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
"TaskId": "125xxxxxx07-pull-693dc41e6fdc22dcf24aa6e9c61cp94"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Parameter value error. |
| InvalidParameterValue.CoverUrl | Incorrect parameter value: cover URL. |
| InvalidParameterValue.ExpireTime | Incorrect parameter value: incorrect ExpireTime format. |
| InvalidParameterValue.MediaStoragePath | Parameter value error: Media storage path. |
| 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. |
文档反馈