Domain name for API request: vod.intl.tencentcloudapi.com.
Modifies a title and trailer template.
A maximum of 20 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: ModifyHeadTailTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Definition | Yes | Integer | Opening and ending template ID. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD 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 application ID. |
| Name | No | String | Template name. Length limited to 64 characters. If not passed, it represents no modification. |
| Comment | No | String | Template description. Length limited to 256 characters. If not passed, no modification is made. If passed empty, the description is cleared. |
| HeadCandidateSet.N | No | Array of String | Opening candidate list. Fill in the FileId of the video. During transcoding, the opening scene with the aspect ratio closest to that of the main content is automatically selected. If the aspect ratios are identical, the candidate positioned towards the front takes precedence. A maximum of 5 candidate opening scenes is supported. If not passed, no modification is made. An empty array clears the list. |
| TailCandidateSet.N | No | Array of String | Ending candidate list. Fill in the FileId of the video. During transcoding, the ending with the aspect ratio closest to that of the main content is automatically selected. If the aspect ratios are the same, candidates positioned towards the front take precedence. A maximum of 5 title candidates is supported. If not passed, no modification is made. An empty array clears the list. |
| FillType | No | String | Filling method. When the video stream configuration width and height parameters are inconsistent with the aspect ratio of the original video, the processing method for transcoding is "padding". Optional filling methods: The default value is no modification. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
Modify a Title and Trailer Template.
https://vod.intl.tencentcloudapi.com/?Action=ModifyHeadTailTemplate
&Definition=10000
&Name=Template 1
&HeadCandidateSet.0=1234422xxxx123
&TailCandidateSet.0=1234422xxxx124
&<Common request parameters>{
"Response": {
"RequestId": "12ae8d8e-xxxx-9d4b-5594145287e1"
}
}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 | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.Comment | Parameter error: description of this template. |
| InvalidParameterValue.Name | Parameter value error: Name exceeds the length limit. |
| InvalidParameterValue.StorageRegions | Parameter value error. StorageRegions is invalid. |
| ResourceNotFound.TemplateNotExist | Resource does not exist: template does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback