tencent cloud

APIs

CreateProcessImageAsyncTemplate

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-09-18 16:50:18

1. API Description

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

This API is used to create a user-customized image async processing template. Maximum quantity: 50. HLS format is not supported currently.

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: CreateProcessImageAsyncTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
ProcessImageConfigure Yes ProcessImageAsyncTask Configuration of async image processing tasks.
SubAppId No Integer VOD application ID. For customers who activate VOD services on or after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).
Name No String Image asynchronous processing template name. Length limit: 64 characters.
Comment No String Description information of the image asynchronous processing template. The length cannot exceed 256 characters.

3. Output Parameters

Parameter Name Type Description
Definition Integer Unique identifier of the image asynchronous processing template.
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 Creating an Advanced Super-Resolution Template

Input Example

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

{
    "ProcessImageConfigure": {
        "EncodeConfig": {
            "Format": "PNG"
        },
        "EnhanceConfig": {
            "AdvancedSuperResolution": {
                "Switch": "ON",
                "Type": "super",
                "Mode": "fixed",
                "Width": 1920,
                "Height": 1080
            }
        }
    }
}

Output Example

{
    "Response": {
        "Definition": 30023,
        "RequestId": "e35641c1-4b92-49e8-9786-06d20161b5d7"
    }
}

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.Comment Parameter error: description of this template.
InvalidParameterValue.Definition Parameter error: Definition.
InvalidParameterValue.Name Parameter value error: Name exceeds the length limit.
LimitExceeded.TooMuchTemplate Exceed the limit: The number of templates exceeds the upper limit of 100. If needed, submit a ticket (https://console.tencentcloud.com/workorder/category).
UnauthorizedOperation Unauthorized operation.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック