tencent cloud

APIs

ModifyProcessImageAsyncTemplate

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-19 15:00:40

1. API Description

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

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

Note: Template IDs below 10000 are system-preset templates and 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 On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
Name No String Image async processing template name. The length cannot exceed 64 characters.
Comment No String Description information of the image asynchronous processing template. The length cannot exceed 256 characters.
ProcessImageConfigure No ProcessImageAsyncTask Image asynchronous processing configuration.

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 The control field parameter for intelligent categorization is incorrect.
InvalidParameterValue.Comment Invalid parameter: template description.
InvalidParameterValue.CoverConfigure The control field parameter for intelligent cover generation is incorrect.
InvalidParameterValue.FrameTagConfigure The control field parameter for intelligent frame-specific tagging is incorrect.
InvalidParameterValue.HighlightConfigure Invalid intelligent highlight generating control parameter.
InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
InvalidParameterValue.TagConfigure The control field parameter for intelligent tagging is incorrect.
ResourceNotFound The resource does not exist.
ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
UnauthorizedOperation Unauthorized operation.

Ajuda e Suporte

Esta página foi útil?

comentários