Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to pull a video from the network 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. Temporary not support pull in Dash format (support HLS). |
| MediaType | No | String | Media type (extension). For supported types, see Media Type. |
| SubAppId | No | Integer | Video-on-demand (VOD) application ID. For customers who activate VOD services from December 25, 2023, if they access resources in VOD applications (whether the default application or a newly created application), they must fill in this field with the app ID. |
| MediaName | No | String | Media name. |
| CoverUrl | No | String | Video cover URL to fetch. 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 the ISO 8601 standard representation. For details, see ISO date format description. |
| StorageRegion | No | String | Designated upload park, applicable only to users with special requirements for upload region: |
| ClassId | No | Integer | Category ID, used to categorize and manage media. You can create a category through the Create Category API to obtain the category ID. |
| TasksPriority | No | Integer | Task priority. The higher the value, the higher the priority. The value range is from -10 to 10. If this is not specified, the default value is 0. |
| SessionContext | No | String | Source context. This is used to pass user request information. When a Procedure task is specified, 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 purposes. |
| SourceContext | No | String | Source context. This is used to pass 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 the upload video task ID. This can be used to query the pull upload 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. |
http://www.abc.com/abc.mp4
Pull upload an MP4 video.
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"
}
}http://www.abc.com/abc.mp4
Pull upload an MP4 video to the Chongqing park.
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"
}
}http://www.abc.com/abc.mp4
Pull upload an MP4 to the Singapore park.
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 | Parameter value error. Expiration time. |
| InvalidParameter.StorageRegion | Parameter value error. Storage region. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.CoverUrl | Parameter value error: Cover URL. |
| InvalidParameterValue.ExpireTime | Parameter value error: Incorrect ExpireTime format. |
| InvalidParameterValue.MediaStoragePath | Parameter value error: media storage path. |
| InvalidParameterValue.MediaUrl | Parameter value error: Media file URL. |
| InvalidParameterValue.SessionContextTooLong | SessionContext is too long. |
| InvalidParameterValue.SessionId | Duplicate recognition code. Request deduplicated. |
| InvalidParameterValue.SessionIdTooLong | SessionId is too long. |
| InvalidParameterValue.StorageRegion | Parameter value error: storage region. |
| ResourceNotFound.CoverUrl | Resource does not exist: cover not found. |
| ResourceNotFound.UserNotExist | The user does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈