Domain name for API request: vod.intl.tencentcloudapi.com.
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: 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 available values, see Upload Capability Summary. |
| SubAppId | No | Integer | Video-on-demand (VOD) application ID. For customers who activate VOD services from December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| MediaName | No | String | Media name. |
| CoverType | No | String | Cover Type. For available values, see upload capability summary. |
| Procedure | No | String | Subsequent media task processing operations, which can automatically initiate task flow operations after media upload is completed. The parameter value is the task flow template name. VOD supports creating a task flow template and naming the template. |
| 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 and obtain the category ID through the create category API. |
| 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. |
| SessionContext | No | String | Session context. This is used to pass user request information. After specifying the Procedure parameter, the task flow status change callback returns the value of this field. The maximum length is 1000 characters. |
| ExtInfo | No | String | Reserved field, used when special usage. |
| MediaStoragePath | No | String | Media storage path, starting with /. |
| Parameter Name | Type | Description |
|---|---|---|
| StorageBucket | String | Bucket, used as the bucket_name for uploading API URL. |
| StorageRegion | String | Storage campus, used for the Region of the upload API Host. |
| VodSessionKey | String | VOD session, used for the VodSessionKey parameter of the confirm upload API. |
| MediaStoragePath | String | Media storage path, the object Key for storing media uploaded through the API. |
| CoverStoragePath | String | Cover storage path, the object Key for uploading and storing the cover via the API. |
| TempCertificate | TempCertificate | Temporary credentials for access verification 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. |
Successful application upload examples.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyUpload
<Common request parameters>
{
"SubAppId": 123456,
"MediaType": "mp4"
}{
"Response": {
"CoverStoragePath": "/dir/cover.xx",
"RequestId": "880f3005-a8c9-4bba-8c87-74e216a17a0b",
"StorageBucket": "xadacq111211-100922",
"StorageRegion": "ap-chongqing",
"MediaStoragePath": "/dir/name.xx",
"VodSessionKey": "VodSessionKey",
"TempCertificate": {
"SecretId": "xxxxxxx",
"SecretKey": "xxxxxxxx",
"Token": "xxxxxxxx",
"ExpiredTime": 182823331
}
}
}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. |
| InternalError | Internal error. |
| InvalidParameter.ExpireTime | Parameter value error. Expiration time. |
| InvalidParameterValue.CoverType | Parameter value error: Cover Type. |
| InvalidParameterValue.ExpireTime | Parameter value error: Incorrect ExpireTime format. |
| InvalidParameterValue.MediaStoragePath | Parameter value error: media storage path. |
| InvalidParameterValue.MediaType | Parameter value error: media type. |
| InvalidParameterValue.SubAppId | Parameter value error: app ID. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈