tencent cloud

云点播

ModifyProcessImageAsyncTemplate

下载
聚焦模式
字号
最后更新时间: 2026-09-18 18:10:24

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to modify a user-customized asynchronous image processing template.

Note: Templates with IDs below 10000 are preset templates and are not allowed to be modified.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: ModifyProcessImageAsyncTemplate.
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 Unique identifier of the image asynchronous processing template.
SubAppId No Integer VOD application ID. For customers who activate VOD services after December 25, 2023, when accessing resources in VOD applications (whether the default application or a newly created application), this field must be set to the app ID.
Name No String Image asynchronous processing template name. The length cannot exceed 64 characters.
Comment No String Description information of the image asynchronous processing template. Length limit: 256 characters.
ProcessImageConfigure No ProcessImageAsyncTask Configuration for asynchronous image processing.

3. Output Parameters

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.

4. Example

Example1 Modify Template Configuration

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProcessImageAsyncTemplate
<Common request parameters>

{
    "Definition": 7,
    "SubAppId": 221073,
    "Name": "test3",
    "Comment": "testcomment",
    "ProcessImageConfigure": {
        "EncodeConfig": {
            "Format": "JPEG",
            "Quality": 100
        },
        "EnhanceConfig": {
            "SuperResolution": {
                "Switch": "ON",
                "Type": "lq",
                "Size": 2
            },
            "Denoise": {
                "Switch": "ON",
                "Type": "weak"
            },
            "ImageQualityEnhance": {
                "Switch": "ON",
                "Type": "weak"
            },
            "ColorEnhance": {
                "Switch": "ON",
                "Type": "weak"
            },
            "SharpEnhance": {
                "Switch": "ON",
                "Intensity": 1
            },
            "FaceEnhance": {
                "Switch": "ON",
                "Intensity": 1
            },
            "LowLightEnhance": {
                "Switch": "ON",
                "Type": "normal"
            }
        }
    }
}

Output Example

{
    "Response": {
        "RequestId": "108471cb-3414-4309-ac74-24443116ddda"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue.ClassifcationConfigure Intelligent classification control field parameter error.
InvalidParameterValue.Comment Parameter error: description of this template.
InvalidParameterValue.CoverConfigure Intelligent cover control field parameter error.
InvalidParameterValue.FrameTagConfigure Intelligent frame tagging control field parameter error.
InvalidParameterValue.HighlightConfigure Intelligent highlights control parameter error.
InvalidParameterValue.Name Parameter value error: Name exceeds the length limit.
InvalidParameterValue.TagConfigure Intelligent tag control field parameter error.
ResourceNotFound The resource does not exist.
ResourceNotFound.TemplateNotExist Resource does not exist: template does not exist.
UnauthorizedOperation Unauthorized operation.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈