发起图片处理

最近更新时间:2024-12-23 01:47:39

我的收藏

1. 接口描述

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

发起图片处理,功能包括:

  1. 格式转换;
  2. 图像增强;

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ProcessImage。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
InputInfo MediaInputInfo 图片处理的文件输入信息。
OutputStorage TaskOutputStorage 图片处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。
OutputDir String 图片处理生成的文件输出的路径。如果不填表示与 InputInfo 中文件所在的目录一致。如果是目录,如/image/201907/,表示继承原文件名输出到该目录。
ImageTask ImageTaskInput 图片处理参数。

3. 输出参数

参数名称 类型 描述
TaskId String 任务 ID。
示例值:125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发起图片增强

发起图片增强

输入示例

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

{
    "InputInfo": {
        "Type": "COS",
        "CosInputInfo": {
            "Bucket": "bucket-test",
            "Region": "ap-shanghai",
            "Object": "/image/test.png"
        }
    },
    "OutputStorage": {
        "Type": "COS",
        "CosOutputStorage": {
            "Bucket": "bucket-test",
            "Region": "ap-shanghai"
        }
    },
    "ImageTask": {
        "EncodeConfig": {
            "Format": "jpeg",
            "Quality": 75
        },
        "EnhanceConfig": {
            "SuperResolution": {
                "Switch": "ON"
            }
        }
    }
}

输出示例

{
    "Response": {
        "RequestId": "03b25aab-8883-497e-838f-d760c3e220f6",
        "TaskId": "3pg2p4jEfbFHYo2rgB0Kzl0esg4NeBItcZyllxO4HNJXdNeRUhk9GjDMjCj1auPv"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.SessionContextTooLong SessionContext 过长。
InvalidParameterValue.SessionId 去重识别码重复,请求被去重。
InvalidParameterValue.SessionIdTooLong SessionId 过长。