SDK API 参考--veImageX-火山引擎

文档中心

简体

文档备案控制台

登录立即注册

veImageX

veImageX

veImageX

文档指南

请输入

产品动态

功能发布历史

服务公告

【通知】DigiCert 根证书升级

基础安全审核能力升级公告

智能审核维度整合优化通知

关于 Let's Encrypt 根证书轮换的公告

libwebp 高危漏洞，请立即升级！

附加组件计费与开通规则变更通知

关于 veImageX 降低标准存储单价的公告

关于 veImageX 免费试用礼包调整的通知

veImageX 图片迁移活动规则

关于 veImageX 添加域名时新增域名归属校验的公告

产品简介

注意与使用限制

地域和访问域名

产品计费

计费方式

附加组件计费说明

高额账单风险警示

快速入门

全链路使用快速入门

资源分发使用快速入门

控制台指南

控制台介绍

通过素材万创 Agent 使用 AI 能力

服务管理

服务管理概述

存储配置

版本控制

开启版本控制后对文件的操作

暂停版本控制后文件的操作

重名覆盖上传

上传 Content-Type 限制

限制文件名仅云端生成

分发配置

新增自定义域名

校验域名归属权

域名配置

域名配置概览

HTTPS 配置

TLS 版本支持

访问控制

URL 鉴权

地域访问限制

缓存配置

节点缓存规则

忽略参数缓存

URL 重定向改写

高级配置

格式自适应

默认公网加速域名

veImageX 域名风险操作说明

高级配置

自定义可查询的 meta 字段

源地址访问

自定义处理样式

资源级别封禁

处理配置

资源管理

查看资源详情

获取资源地址

修改资源存储类型

恢复历史版本资源

刷新预热禁用

证书管理

统计与监控

数据统计分析

组件市场

附加组件

ImageX-豆包 AIGC

应用管理

License 授权管理

SDK 配置下发

SDK 配置下发

加载 SDK HTTPDNS 配置

质量监控

上传数据监控

HEIF 编码监控

下行网络监控

客户状态监控

感知指标监控

附录错误码列表

资源包管理

工具箱

数据迁移

数据迁移任务时间预估

数据迁移任务失败说明

迁移准备

优刻得（Ucloud File）

URL 列表迁移说明

SDK 在线调试

账号与授权

域名管理

更新域名配置

更新响应头配置

更新默认域名配置

更新 Referer 防盗链配置

更新 https 配置

更新 IP 黑白名单配置

更新 UA 黑白名单配置

更新地域访问限制配置

更新域名自适应格式配置

更新集智瘦身配置

更新域名高级配置

更新下载限速配置

获取域名配置

获取服务下全部域名

获取响应头允许的 Key 列表

获取域名归属权校验内容

校验域名归属权

开发指南

发起请求

发起请求概述

使用 SDK 发起请求概述

使用 IAM 用户访问密钥发起请求

使用 STS 临时访问凭证发起请求

服务（Service）

切换上传线路

veImageX 存储 Key 通用字符规则

数据处理（proscessing）

数据处理机制

模板与Pipline机制

图像处理

饱和度/公祭日场景

图片信息属性

获取主题色

图像压缩

压缩质量参数

BVC 压缩算法

自适应质量编码

图像编码降级说明

图像自适应压缩

输出体积上限

视频截帧/动图截帧

小视频转动图

基础图像处理（历史版本）

历史版本概述

用法说明

A 版用法说明

Q 版用法说明

视频截帧/截图（vframe）

音视频元信息（avinfo）

T 版用法说明

图片加载

客户端展示

附加组件 2.0

AIGC 大模型超分辨率

ImageX-SeeDream 生图方案

智能图像扩展

图像超分辨率（云端）

大模型画质评估

AIGC 图片翻译

智能背景移除

文字识别 OCR

电商牛皮癣擦除

API 参考

API 发布历史

使用 API Explorer

服务管理

查询服务开通状态

更新服务名称

更新镜像回源配置

更新重名覆盖上传配置

更新服务存储策略

更新事件通知配置

更新源地址访问配置

更新主备鉴权 Key

获取主备鉴权 Key

获取单个服务信息

获取所有服务信息

更新内网访问配置

获取内网访问配置

自定义可查询的 meta 字段

更新默认公网加速域名配置

模板管理

创建图片模板

获取单个图片模板

获取服务下所有图片模版

获取回收站中所有模板

图片编辑数据结构

支持字体列表

删除图片模板

删除回收站模板

恢复回收站模板

证书管理

获取所有域名及证书信息

获取账号下全部证书

资源管理

获取文件上传地址

确认上传并上报上传结果

删除服务下多个文件

预览服务下的文件

列举服务下的文件

修改文件存储类型

更新资源封禁/解封状态

重命名文件

获取服务下的上传文件列表

获取服务下单个上传文件

更新文件的 Content-Type 值

获取资源 URL

恢复历史版本文件

查看文件版本信息

更新版本控制状态

获取文件 VPC 内网上传地址

刷新/预热/禁用/解禁

创建刷新预热禁用解禁任务

获取任务详情

获取禁用 URL 列表详情

统计与监控

查询用量概览

获取流量用量

查询带宽用量

查询 95 带宽用量

查询请求次数

查询基础处理量

查询高效压缩量

查询截帧用量

查询小视频转动图用量

查询多文件压缩用量

获取附加组件通用请求次数

查询资源占用量

查询边缘分发请求次

查询边缘分发地区列表

查询边缘分发带宽用量

查询边缘分发流量用量

查询回源请求次

查询回源流量用量

查询回源带宽用量

查询镜像回源请求次

查询镜像回源请求次域名明细数据

查询镜像回源流量

查询数据处理服务 QPS 用量

查询镜像回源带宽

查询流量命中率

查询请求命中率

获取数据统计分析结果

质量监控

查询应用列表

查询地区列表

查询自定义维度列表

查询自定义维度值

查询上传成功率

查询错误码时序数据

查询错误码分布

查询上传有效次数

查询上传文件大小分布

查询上传平均耗时

查询上传平均速度

查询上传分片速度

查询 HEIF 编码成功次数时序数据

查询 HEIF 编码成功率时序数据

查询 HEIF 编码后文件大小时序数据

查询 HEIF 编码错误码时序数据

查询 HEIF 编码耗时时序数据

查询 HEIF 编码前文件大小时序数据

查询网络成功率时序数据

查询网络成功率分布

查询错误码时序数据

查询错误码分布

查询网络耗时时序数据

查询网络耗时分布

查询网络连接复用率时序数据

查询网络连接复用率分布

查询网络协议占比

查询错误码时序数据

查询错误码分布

查询解码耗时

查询排队耗时

查询加载耗时分布

查询加载耗时时序数据

查询用户感知失败率

查询文件大小分布

查询 SDK 版本变化趋势

查询文件大小 TOP URL

查询客户端上报量

查询画质评估时序数据

查询降级率 TOP URL

查询黑白屏率时序数据

查询解码成功率

查询降级率时序数据

查询黑白屏 TOP URL

查询内存/磁盘命中率

查询采集样本量

查询大图文件未知原因 Top URL

查询大图监控样本量

查询大图文件分辨率 Top URL

查询大图文件体积 Top URL

查询大图文件体积大小分布

查询大图分辨率占比分布

查询大图文件内存 Top URL

告警管理

新建告警规则

删除告警规则

删除告警记录

更新告警规则

更新告警规则状态

获取所有告警规则

获取所有告警记录

维度和指标

客户端配置下发

获取配置项列表

创建配置项规则

更新配置项规则

更新规则优先级

删除配置项规则

获取规则列表

查看规则修改历史

veImageX × 豆包 AIGC

创建文生图同步任务

创建文生图异步任务

查询文生图异步任务

漫画版-文生图/图生图

盲水印

添加盲水印

创建盲水印提取任务（同步）

创建盲水印提取任务（异步）

创建盲水印前背景图层

获取盲水印异步提取任务信息

智能裁剪

使用智能裁剪获取结果图

画质增强

使用画质增强获取结果图

使用画质增强获取编码后图片二进制数据

使用综合增强获取结果图

画质评估

使用画质评估获取分值

离线画质评估

删除任务执行记录

更新任务配置

更新任务状态

获取任务列表

获取任务结果

图片去重

使用图片去重获取结果值

获取异步去重任务详情

图像PS检测

使用 PS 检测获取结果值

图片检测与识别

图片内容检测

使用隐私分类获取分类信息

智能审核

创建图片审核任务

更新图片审核任务配置

获取图片审核任务结果

图片单次审核

图片批量审核

获取同步审核任务结果

创建视频审核任务

更新视频审核任务配置

获取视频审核任务结果

创建音频审核任务

更新音频审核任务配置

获取音频审核任务结果

查询所有审核任务

创意魔方

获取样式详情

获取样式列表

更新样式元数据

添加常用图片/背景/蒙版要素

获取常用图片/背景/蒙版要素

删除常用图片/背景/蒙版要素

添加常用颜色

获取常用颜色

删除常用颜色

获取可用字体

获取结果图 URI

多文件压缩处理

创建多文件压缩异步任务

获取异步压缩任务详情

附加组件标签查询

获取组件标签列表详情

数据迁移

创建数据迁移任务

删除迁移任务

更新迁移任务策略

重启迁移失败任务

结束迁移任务

导出迁移失败列表

获取服务商 Bucket

获取迁移任务详情

离线转码

创建任务队列

删除任务队列

更新任务队列配置

更新任务队列状态

获取任务队列

提交转码任务

手动触发回调

删除任务执行详情

获取任务执行详情

手动触发任务维度回调

获取离线转码任务

附加组件 2.0

创建 AI 图像处理任务（同步）

创建批量处理任务队列

创建 AI 图像处理任务（异步）

获取批量处理任务队列

更新批量处理任务队列配置

更新批量处理任务队列状态

删除批量处理任务队列

删除批量处理条目

手动触发回调

获取 AI 图像处理任务信息

获取 AI 图像处理任务执行详情

AI 图像处理回调

数据抓取

获取异步抓取任务详情

日志查询

查询离线日志下载地址

批处理

同步批量处理

创建批量处理异步任务

查询异步批量处理任务详情

其他处理API

查询图片 meta 信息

获取图片主题色

查询图片 alpha 信息

获取图片 BlurHash 码

管理图片 EXIF 数据

附录

盲水印提取回调

客户端 SDK

加载 SDK

接入准备（必看）

Android 加载 SDK

SDK API 参考

HTTPDNS 接入文档

iOS 加载 SDK

SDK API 参考

SDWebImage 接口适配说明

HTTPDNS 接入文档

JS 加载 SDK

React 加载 SDK

集成 React 加载 SDK

SDK API 参考

Vue.js 加载 SDK

集成 Vue.js 加载 SDK

SDK API 参考

Vue2

Vue3

抖音小程序加载 SDK

集成抖音小程序加载 SDK

SDK API 参考

微信小程序加载 SDK

集成微信小程序加载 SDK

SDK API 参考

Taro 小程序加载 SDK

集成 Taro 小程序加载 SDK

SDK API 参考

Hybrid-React 加载 SDK

Hybrid 同层渲染

SDK API 参考

Web 监控 SDK

SDK API 参考

加载 SDK 错误码

历史文档

Android BDGlide 加载 SDK（旧版）

iOS 接入文档（旧版）

Glide 接入 HEIF 解码库操作说明

HarmonyOS NEXT 加载 SDK

上传 SDK

客户端上传说明

Android 上传 SDK

上传网络请求代理

附录

Android 10 分区存储

iOS 上传 SDK

升级指南

动态库升级指南

JS 上传 SDK

集成 Web 上传 SDK

集成小程序上传 SDK

集成 HarmonyOS NEXT 上传 SDK

Flutter 上传 SDK

上传 SDK 错误码

历史文档

Android 上传 SDK 接入文档（旧版）

iOS 上传 SDK 接入文档（旧版）

小程序版上传 SDK 接入文档（旧版）

服务端 SDK

使用 SDK 在线调试

Golang SDK

安装及初始化

生成上传凭证

刷新/预热/禁用/解禁

统计与监控

数据统计分析

质量监控

获取下拉选项

上传数据监控

HEIF 编码监控

下行网络监控

客户状态监控

感知指标监控

附加组件

图像 PS 检测

图片检测与识别

多文件压缩

ImageX-豆包 AIGC（智能生图）

离线画质评估

其他处理 API

Python SDK

安装及初始化

生成上传凭证

刷新/预热/禁用/解禁

统计与监控

数据统计分析

质量监控

获取下拉选项

上传数据监控

下行网络监控

客户状态监控

感知指标监控

附加组件

图像 PS 检测

图片检测与识别

多文件压缩

ImageX-豆包 AIGC（智能生图）

离线画质评估

Java SDK

安装及初始化

生成上传凭证

刷新/预热/禁用/解禁

统计与监控

数据统计分析

质量监控

获取下拉选项

上传数据监控

HEIF 编码监控

下行网络监控

客户状态监控

感知指标监控

附加组件

图像 PS 检测

图片检测与识别

多文件压缩

ImageX-豆包 AIGC（智能生图）

离线画质评估

其他处理 API

PHP SDK

安装及初始化

生成上传凭证

刷新/预热/禁用/解禁

统计与监控

数据统计分析

质量监控

获取下拉选项

上传数据监控

HEIF 编码监控

下行网络监控

客户状态监控

感知指标监控

附加组件

图像 PS 检测

图片检测与识别

多文件压缩

ImageX-豆包 AIGC（智能生图）

离线画质评估

Node.js SDK

安装及初始化

生成上传凭证

生成临时访问凭证

刷新/预热/禁用/解禁

统计与监控

数据统计分析

质量监控

获取下拉选项

上传数据监控

下行网络监控

客户状态监控

感知指标监控

附加组件

图片检测与识别

多文件压缩

ImageX-豆包 AIGC（智能生图）

离线画质评估

历史版本

生成上传凭证

最佳实践

数据迁移最佳实践

数据迁移最佳实践

迁移指南

使用桶清单方式进行数据迁移

平台使用最佳实践

veImageX 上传最佳实践

veImageX 素材托管最佳实践

如何优雅切量最佳实践

使用 veImageX 实时处理点播空间图片

使用 veImageX 实时处理 TOS 存储图片

直播截图转 veImageX 存储管理

通过云监控配置 veImageX 告警策略

veImageX 监控告警方案选型推荐

使用 Postman 调用 API 接口最佳实践

veImageX 成本的精细化分账

veImageX 内网数据互访

图像处理最佳实践

全链路数据加解密

LivePhoto 上传加载全链路

使用移动端 SDK 实现图片渐进式加载

管理图片 Exif 信息最佳实践

小程序使用 veImageX 最佳实践

iOS 最佳实践

AIGC 最佳实践

veImageX-豆包智能生图最佳实践

veImageX-豆包视觉理解大模型最佳实践

周边工具

本地迁移与上传工具

第三方工具与社区插件

通过 Exporter 导出 veImageX 监控数据至 Prometheus

常见问题

上传与存储相关

CDN 与分发相关

图像处理和使用相关

客户端相关

控制台相关

相关协议

veImageX 服务等级协议（SLA）

视频云服务专用条款

veImageX 产品/服务线上计费结算规则

veImageX 图片加载 SDK 相关协议

veImageX 图片加载 SDK 隐私政策

veImageX 图片加载 SDK 开发者使用合规规范

veImageX 图片加载 SDK 扩展功能说明目录

veImageX 图片上传 SDK 相关协议

veImageX 图片上传 SDK 隐私政策

veImageX 图片上传 SDK 开发者使用合规规范

veImageX 图片上传 SDK 扩展功能说明目录

文档首页

veImageX

客户端 SDK

加载 SDK

JS 加载 SDK

微信小程序加载 SDK

SDK API 参考

微信小程序加载 SDK

SDK API 参考

API 详情
事件