查询图片处理模板列表

最近更新时间:2025-11-24 19:55:09

我的收藏

1. 接口描述

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

查询图片处理模板列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProcessImageTemplates。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
Definitions.N Array of Integer 图片处理模板唯一标识过滤条件,数组长度限制:100。
示例值:[1001]
Offset Integer 分页偏移量,默认值:0。
示例值:0
Limit Integer 返回记录条数 默认值:10;最大值:100。
示例值:10
Name String 图片处理模板标识过滤条件。
示例值:图片处理模板1
OrderType Integer 排序方式,OrderBy设置后才有效,可选值: 0:升序 1:降序 默认 0。
示例值:0
OrderBy String 排序字段,可选值:
Definition:模板唯一标识;
默认值:创建时间。
示例值:Definition
Type String 模板类型过滤条件,可选值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值:Preset

    3. 输出参数

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

    4. 示例

    示例1 查询所有图片处理模板

    查询包括预设模板和自定义模板在内的所有图片处理模板信息

    输入示例

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

    输出示例

    {
        "Response": {
            "ProcessImageTemplateSet": [
                {
                    "Comment": "",
                    "CreateTime": "2025-11-11T02:40:24Z",
                    "Definition": 20180,
                    "Name": "",
                    "ProcessImageConfig": {
                        "EncodeConfig": {
                            "Format": "JPEG",
                            "Quality": 80
                        },
                        "EnhanceConfig": {
                            "ImageQualityEnhance": {
                                "Switch": "ON",
                                "Type": "weak"
                            }
                        }
                    },
                    "Type": "Custom",
                    "UpdateTime": "2025-11-11T02:40:24Z"
                }
            ],
            "RequestId": "6781d678-c8d0-4af3-87c1-f31050c8a76a",
            "TotalCount": 1
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.Definitions 参数错误:Definitions。
    InvalidParameterValue.Limit 参数错误:Limit。
    ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。