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, refer to Upload Capability Summary. |
| 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 available values, refer to Upload Capability Summary. |
| Procedure | No | String | Subsequent media task processing operations allow automatic task initiation after media upload is completed. The parameter value is the task flow template name. VOD supports creating a task flow template and template naming. |
| ExpireTime | No | Timestamp ISO8601 | Media file expiry time, format according to ISO 8601 standard representation. See ISO date format description for details. |
| 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. |
| SourceContext | No | String | Source context, used to pass through user request information. The callback on upload completion will return the value of this field, up to 250 characters. |
| SessionContext | No | String | Session context, used for passing through user request information. When specifying the Procedure parameter, the task flow status change callback will return the value of this field, with a maximum of 1000 characters. |
| ExtInfo | No | String | Reserved field, used when special purpose. |
| MediaStoragePath | No | String | Media storage path, starting with /. Only sub-apps in FileID + Path mode can specify the storage path. |
| Parameter Name | Type | Description |
|---|---|---|
| StorageBucket | String | Bucket for uploading the API URL bucket_name. |
| StorageRegion | String | Storage campus for uploading the Host Region of the port. |
| VodSessionKey | String | VOD session for confirmation of API parameters VodSessionKey. |
| MediaStoragePath | String | Media storage path for the object key (Key) used by the upload API to store media. |
| CoverStoragePath | String | Cover storage path for uploading the object Key of the cover via API. |
| TempCertificate | TempCertificate | Temporary credentials for uploading API permission verification. |
| 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 | Incorrect parameter value: expiration time. |
| InvalidParameterValue.CoverType | Incorrect parameter value: cover type. |
| InvalidParameterValue.ExpireTime | Incorrect parameter value: incorrect ExpireTime format. |
| InvalidParameterValue.MediaStoragePath | Parameter value error: Media storage path. |
| InvalidParameterValue.MediaType | Incorrect parameter value: media type. |
| InvalidParameterValue.SubAppId | Incorrect parameter value: application id. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈