Description
You can call this operation to delete transcoding configurations. Specifically, you can delete transcoding templates from a transcoding template group or forcibly delete the entire transcoding template group.
Note:
- The default transcoding template cannot be deleted. You can delete it only after it is no longer set as the default.
- For security reasons, you cannot perform custom operations on transcoding template groups that are locked in the ApsaraVideo for VOD console. To operate such transcoding template groups, submit a ticket or use the after-sales service to contact ApsaraVideo for VOD technical support to unlock them.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Action | String | Yes | The operation that you want to perform. Set this parameter to DeleteTranscodeTemplateGroup. |
| TranscodeTemplateGroupId | String | Yes | The ID of the transcoding template group. |
| TranscodeTemplateIds | String | No | The ID list of transcoding templates to be deleted.
|
| ForceDelGroup | String | No | Specifies whether to forcibly delete the entire transcoding template group. Valid values: true and false. Default value: false. |
If the ForceDelGroup parameter is set to false, you can only delete the specified transcoding templates. If the ForceDelGroup parameter is set to true, you can delete the entire template group and its listed transcoding templates.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| RequestId | String | The ID of the request. |
| NonExistTranscodeTemplateIds | String[] | The ID list of transcoding templates that were not found when you attempted to delete transcoding templates based on the ID list. |
API examples
Sample request
https://vod.cn-shanghai.aliyuncs.com?Action=DeleteTranscodeTemplateGroup&TranscodeTemplateGroupId="ddddddddd"&ForceDelGroup=true
Sample response
JSON format
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58"
"NonExistTranscodeTemplateIds":["dddddd","ffffff"]
}
Error codes
This operation also returns common errors. For more information about errors common to all operations, see common errors.
| Error code | Error message | HTTP status code | Description |
|---|---|---|---|
| InvalidTranscodeTemplateGroup.NotFound | The transcode template does not exist | 404 | The error message returned because the specified transcoding template group does not exist. |
| Forbidden.LockedTemplateGroup | The transcode template group has been locked. | 403 | The error message returned because the specified transcoding template group is locked and cannot be operated. To operate the transcoding template group, contact ApsaraVideo for VOD technical support. |
| Forbidden.DefaultTemplateGroup | The transcode template group is default. | 403 | The error message returned because the specified transcoding template group is the default one that cannot be deleted. |
SDK examples
We recommend that you use a server SDK to call this operation. For more information about the sample code used to call this operation in various languages, see the following topics: