获取图片异步处理模板列表

最近更新时间:2026-01-28 03:37:01

我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

根据图像异步处理模板唯一标识,获取图像异步处理模板详情列表。返回结果包含符合条件的所有用户自定义图像异步处理模板。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProcessImageAsyncTemplates。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:123456
Definitions.N Array of Integer 图片异步处理模板唯一标识过滤条件,数组长度最大值:100。
示例值:[30]
Offset Integer 分页偏移量,默认值:0。
示例值:0
Limit Integer 返回记录条数,默认值:10,最大值:100。
示例值:10

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合过滤条件的记录总数。
示例值:1
ProcessImageAsyncTemplateSet Array of ProcessImageAsyncTemplateItem 图片异步处理模板详情列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询图片异步处理模板列表

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProcessImageAsyncTemplates
<公共请求参数>

{
    "SubAppId": 221073,
    "Definitions": [
        7
    ]
}

输出示例

{
    "Response": {
        "ProcessImageAsyncTemplateSet": [
            {
                "Comment": "testcomment",
                "CreateTime": "2026-01-20T03:02:33Z",
                "Definition": 7,
                "Name": "test3",
                "ProcessImageConfigure": {
                    "EncodeConfig": {
                        "Format": "PNG",
                        "Quality": 100
                    },
                    "EnhanceConfig": {
                        "AdvancedSuperResolution": {
                            "Height": 720,
                            "Mode": "percent",
                            "Percent": 2,
                            "Switch": "ON",
                            "Type": "standard",
                            "Width": 1280
                        },
                        "ColorEnhance": {
                            "Switch": "ON",
                            "Type": "weak"
                        },
                        "Denoise": {
                            "Switch": "ON",
                            "Type": "weak"
                        },
                        "FaceEnhance": {
                            "Intensity": 1,
                            "Switch": "ON"
                        },
                        "ImageQualityEnhance": {
                            "Switch": "ON",
                            "Type": "weak"
                        },
                        "LowLightEnhance": {
                            "Switch": "ON",
                            "Type": "normal"
                        },
                        "SharpEnhance": {
                            "Intensity": 1,
                            "Switch": "ON"
                        },
                        "SuperResolution": null
                    }
                },
                "Type": "Custom",
                "UpdateTime": "2026-01-26T09:21:49Z"
            }
        ],
        "TotalCount": 1,
        "RequestId": "08cfed0c-2b5a-41bf-b0dd-b1985db203d8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
LimitExceeded.TooMuchTemplate 超过限制值:模板数超过上限 100 个,如需更多请提交工单
ResourceNotFound 资源不存在。
ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。
UnauthorizedOperation 未授权操作。