You need to enable JavaScript to run this app.
导航
离线转码
最近更新时间:2024.08.22 11:55:46首次发布时间:2023.06.28 10:56:47

veImageX 在支持使用图片处理模版对存储图像进行实时处理之外,还为您提供了离线转码功能。相较于实时图像处理,离线转码功能可以批量处理指定的图像文件,并在配置回调后在回调地址接收处理结果。从而为您节省带宽和时间,以减少使用成本,提高运行效率。

计费说明

该能力涉及的图片计费项与您所选用的模版配置功能有关,详情请参考图片处理配置计费说明

说明

若对低频存储图片资源执行了离线转码,将产生低频存储数据取回费用

前提条件

使用流程

alt

操作步骤

新建任务队列

说明

veImageX 在每个账号内置了一个默认任务队列,如无特殊需求,您可直接使用默认任务队列。

  1. 登录 veImageX 控制台

  2. 在左侧导航栏选择工具箱 > 离线转码,进入离线转码页面。

  3. 单击新建任务队列按钮,参考下表填写任务队列配置。

    配置项说明
    任务队列名必填。自定义任务名称。此处以offline_test为例。
    任务描述可填。自定义任务作用描述。
  4. 单击确定按钮,保存当前配置。

提交任务

  1. 在离线转码页面,选择在新建任务队列已创建的任务队列后,单击操作提交任务按钮。

  2. 在新建任务弹窗中,参考下表完成新建任务配置。

    配置项说明
    服务名称在下拉框选择一个该账号下已创建的服务。

    提交类型

    在 txt 或 csv 文件内指定自定义图像地址并拖拽上传,每行填写一个,以换行分隔,建议最多不超过10 万条(避免因数据过多导致处理失败)。支持以下两种图像地址类型:

    • URL:可公网访问 URL,例如http://imagexdemo.volcengine.com/aaaa.jpeg

    • URI:指定服务下的存储 URI,例如tos-i-h3***ko/aaa.jpeg

    示例文件下载
    74.00Bytes

    说明

    模板 ID在下拉框选择一个指定服务下已创建的图片处理模版。您将使用该模版配置功能对指定图像资源进行离线处理。

    输出格式

    指定的图像输出格式。支持的格式有 image、png、jpeg、heic、avif、webp、vvic。

    说明

    当您指定输出图像格式为 heic、avif、vvic 时,veImageX 将按照高效图像压缩计费项收取相应费用。

回调配置

说明

  • 该回调配置所应用范围为整个任务队列内所有已提交任务,但仅当各任务内每个 URL/URI 资源转码成功或失败时,才会向回调 URL 发送回调内容。
  • UpdateImageTranscodeQueue 接口和控制台同时配置了不同的回调参数,则接口配置优先生效。
  1. 在离线转码页面,选择已创建的任务队列,单击回调配置列的开关

  2. 在弹窗中参考下表完成回调配置。

    配置项说明
    回调类型仅支持普通 API

    回调 URL

    支持自定义回调协议(http / https),并输入回调地址,接收图片转码结果。回调详情请见回调内容

    说明

    若该 URL 未成功接收回调内容,您可以通过队列详情-手工触发回调来手动向该 URL 发送回调内容。

    回调格式

    支持以下两种回调格式:

    • XML

    • JSON

  3. 单击确定按钮,保存当前配置。

启动任务

在离线转码页面,选择已完成提交任务的任务队列,单击状态启动按钮,对指定的图像资源进行处理。

说明

若一个队列提交了多个 URL/URI 任务时,则该队列中的任务将按照提交先后顺序执行离线转码操作。

获取任务结果

  1. 在离线转码页面,选择状态为进行中的任务队列,单击操作详情按钮。

  2. 在队列详情页面,您可对该任务队列中的各个 URL/URI 所在处理任务查看其任务状态、详情以及执行删除等操作。具体操作项说明如下表所示。

    说明

    仅支持保存并查询近 7 天的处理任务。

    操作项说明
    详情查看该条任务信息、输入信息、输出信息等具体内容。
    手工触发回调
    手动对该条 URL/URI 处理任务发送回调内容。
    删除删除该条执行任务状态。

管理任务

  1. 在离线转码页面,选择并管理已创建的任务队列。

  2. 请参考下表管理您的任务队列。

    配置操作项说明
    状态启动启动任务队列,开始对提交的任务执行转码处理。
    暂停暂停任务队列,暂停正在执行转码处理的任务。
    回调配置编辑更新该任务队列的回调配置,支持更新回调 URL 和回调格式。
    操作详情查看该任务队列中各 URL/URI 的转码处理结果,或执行手工触发回调等操作,详情请参考获取任务结果
    提交任务向该任务队列提交 URL/URI 转码任务,详情请参考提交任务
    删除删除该条任务队列。您也可以在详情页面,选中多条任务进行批量删除操作。

回调内容

在离线转码任务结束后 veImageX 将会把转码结果以您指定的格式回调至您的自定义回调 URL中。您可以通过回调内容,进行后续的文件处理操作,具体如下所示:

回调参数
说明
callback_type
回调类型,当前仅支持 entry
callback_args
业务设置的回调参数透传
queue_id
任务队列 ID
task_id
提交任务的 ID。该任务由一条或多条 URL/URI 所组成,每条 URL/URI 对应一个 entry_id。
entry_info
任务队列中单个 URL/URI 所在处理任务的具体处理数据

JSON 类型回调示例如下所示:

{
    "callback_type": "entry",
    "callback_args": "873076320",
    "queue_id": "649a9dbc32d22064d44cf5b0",
    "task_id": "649b9d39hjs75537684010a7",
    "entry_info": {
        "entry_id": "649a9332k02j80e9cc0a0ef",
        "submit_at": 1686860626,
        "start_at": 1686860651,
        "end_at": 1686860653,
        "status": "Fail",
        "uri": "tos-cn-i-5sq****fo/f194ac4b7e22dc92fba0ff3aa4638b3c",
        "template": "tplv-5sq****fo-42:25:90.png",
        "fsize": 410400,
        "format": "png",
        "output": "tos-cn-i-5sq****fo/_offtrans__1248x1053_fe7b9183347e58c1ada53466d83165b8_bf6b6c5c8be8a0853417566b7938648fca9550181691d1f3775aa1f2cfc3d3bf_png",
        "err_code": 615011,
        "err_msg": "解码图片要素失败"
    }
}

错误码

转码失败错误码及相关说明如下表所示。

错误码说明
600002内部错误,例如发送回调参数序列化失败等错误
600003参数错误
600006数据库错误
603002模板参数有误
604010图片 StoreUri 无效
604026图片下载失败
615011图片解码失败
616002图片编码失败
615013图片处理失败,模板功能处理中出现的错误如非法参数或者非算子侧模型的图片处理错误以及算子进程异常错误
699001算子侧图片处理失败(不包含算子进程异常错误)

OpenAPI

您可以通过调用 OpenAPI 来完成离线转码相关操作,具体如下所示: