veImageX
veImageX
文档指南
请输入
- 文档首页
veImageXAPI 参考API 概览
API 概览
文档反馈
问问助手我们为您提供各种能力对应的接口。您可使用 veImageX 提供的 OpenAPI 来对接产品服务，推荐您使用服务端 SDK 来调用 API。
服务管理
| API | 说明 |
|---|---|
| GetImageServiceSubscription | 查询服务开通状态 |
| CreateImageService | 创建服务 |
| DeleteImageService | 删除服务 |
| UpdateServiceName | 更新服务名称 |
| UpdateImageMirrorConf | 更新镜像回源配置 |
| UpdateImageUploadOverwrite | 更新重名覆盖上传配置 |
| UpdateStorageRules | 更新服务存储策略 |
| UpdateResEventRule | 更新事件通知配置 |
| UpdateImageObjectAccess | 更新源地址访问配置 |
| UpdateImageAuthKey | 更新主备鉴权 Key |
| GetImageAuthKey | 获取主备鉴权 Key |
| GetImageService | 获取单个服务信息 |
| GetAllImageServices | 获取所有服务信息 |
| UpdateVpcAccessConfig | 更新内网访问配置 |
| DescribeVpcAccessConfig | 获取内网访问配置 |
| UpdateImageInfoKey | 自定义可查询的 meta 字段 |
| UpdateDefaultPublicDomain | 更新默认公网加速域名配置 |
模板管理
| API | 说明 |
|---|---|
| CreateImageTemplate | 创建图片模板 |
| GetImageTemplate | 获取单个图片模板 |
| GetAllImageTemplates | 获取服务下所有图片模版 |
| GetTemplatesFromBin | 获取回收站中所有模板 |
| 图片编辑数据结构 | 图片编辑数据结构 |
| 支持字体列表 | 支持字体列表 |
| DeleteImageTemplate | 删除图片模板 |
| DeleteTemplatesFromBin | 删除回收站模板 |
| CreateTemplatesFromBin | 恢复回收站模板 |
| CreateImageTemplatesByImport | 导入模板 |
证书管理
| API | 说明 |
|---|---|
| GetImageAllDomainCert | 获取所有域名及证书信息 |
| GetAllCerts | 获取账号下全部证书 |
资源管理
| API | 说明 |
|---|---|
| ApplyImageUpload | 获取文件上传地址 |
| CommitImageUpload | 确认上传并上报上传结果 |
| DeleteImageUploadFiles | 删除服务下多个文件 |
| PreviewImageUploadFile | 预览服务下的文件 |
| GetImageStorageFiles | 列举服务下的文件 |
| UpdateFileStorageClass | 修改文件存储类型 |
| UpdateImageResourceStatus | 更新资源封禁/解封状态 |
| UpdateImageFileKey | 重命名文件 |
| CreateFileRestore | 恢复文件 |
| GetImageUploadFiles | 获取服务下的上传文件列表 |
| GetImageUploadFile | 获取服务下单个上传文件 |
| UpdateImageFileCT | 更新文件的 Content-Type 值 |
| GetResourceURL | 获取资源 URL |
| CreateImageFromUri | 复制资源 |
| UpdateHistoryVersionFile | 恢复历史版本文件 |
| GetImageStorageVersionFiles | 查看文件版本信息 |
| UpdateStorageVersioning | 更新版本控制状态 |
| ApplyVpcUploadInfo | 获取文件 VPC 内网上传地址 |
| GetFileInfos | 根据文件路径获取文件信息 |
刷新/预热/禁用/解禁
| API | 说明 |
|---|---|
| CreateImageContentTask | 创建刷新预热禁用解禁任务 |
| GetImageContentTaskDetail | 获取任务详情 |
| GetImageContentBlockList | 获取禁用 URL 列表详情 |
统计与监控
质量监控
告警管理
| API | 说明 |
|---|---|
| CreateImageMonitorRule | 新建告警规则 |
| DeleteImageMonitorRules | 删除告警规则 |
| DeleteImageMonitorRecords | 删除告警记录 |
| UpdateImageMonitorRule | 更新告警规则 |
| UpdateImageMonitorRuleStatus | 更新告警规则状态 |
| GetImageMonitorRules | 获取所有告警规则 |
| GetImageAlertRecords | 获取所有告警记录 |
| 维度和指标 | 维度和指标 |
客户端配置下发
| API | 说明 |
|---|---|
| GetImageSettings | 获取配置项列表 |
| CreateImageSettingRule | 创建配置项规则 |
| UpdateImageSettingRule | 更新配置项规则 |
| UpdateImageSettingRulePriority | 更新规则优先级 |
| DeleteImageSettingRule | 删除配置项规则 |
| GetImageSettingRules | 获取规则列表 |
| GetImageSettingRuleHistory | 查看规则修改历史 |
veImageX × 豆包 AIGC
| API | 说明 |
|---|---|
| GetCVTextGenerateImage | 创建文生图同步任务 |
| CreateCVImageGenerateTask | 创建文生图异步任务 |
| GetCVImageGenerateTask | 查询文生图异步任务 |
| GetCVImageGenerateResult | 图生图 |
| GetCVAnimeGenerateImage | 漫画版-文生图/图生图 |
盲水印
| API | 说明 |
|---|---|
| CreateImageHmEmbed | 添加盲水印 |
| CreateImageHmExtract | 创建盲水印提取任务（同步） |
| CreateHmExtractTask | 创建盲水印提取任务（异步） |
| CreateHiddenWatermarkImage | 创建盲水印前背景图层 |
| GetImageHmExtractTaskInfo | 获取盲水印异步提取任务信息 |
智能裁剪
| API | 说明 |
|---|---|
| GetImageSmartCropResult | 使用智能裁剪获取结果图 |
画质增强
| API | 说明 |
|---|---|
| GetImageEnhanceResult | 使用画质增强获取结果图 |
| GetImageEnhanceResultWithData | 使用画质增强获取编码后图片二进制数据 |
| GetComprehensiveEnhanceImage | 使用综合增强获取结果图 |
画质评估
| API | 说明 |
|---|---|
| GetImageQuality | 使用画质评估获取分值 |
离线画质评估
| API | 说明 |
|---|---|
| CreateImageAnalyzeTask | 创建任务 |
| DeleteImageAnalyzeTask | 删除任务 |
| DeleteImageAnalyzeTaskRun | 删除任务执行记录 |
| UpdateImageAnalyzeTask | 更新任务配置 |
| UpdateImageAnalyzeTaskStatus | 更新任务状态 |
| GetImageAnalyzeTasks | 获取任务列表 |
| GetImageAnalyzeResult | 获取任务结果 |
图片去重
| API | 说明 |
|---|---|
| GetImageDuplicateDetection | 使用图片去重获取结果值 |
| GetDedupTaskStatus | 获取异步去重任务详情 |
图像PS检测
| API | 说明 |
|---|---|
| GetImagePSDetection | 使用 PS 检测获取结果值 |
图片检测与识别
| API | 说明 |
|---|---|
| GetImageDetectResult | 图片内容检测 |
| GetPrivateImageType | 使用隐私分类获取分类信息 |
智能审核
| API | 说明 |
|---|---|
| CreateImageAuditTask | 创建图片审核任务 |
| UpdateImageAuditTask | 更新图片审核任务配置 |
| GetImageAuditTaskResult | 获取图片审核任务结果 |
| SingleImageAudit | 图片单次审核 |
| BatchImageAudit | 图片批量审核 |
| GetSyncAuditResult | 获取同步审核任务结果 |
| CreateVideoAuditTask | 创建视频审核任务 |
| UpdateVideoAuditTask | 更新视频审核任务配置 |
| GetVideoAuditResult | 获取视频审核任务结果 |
| CreateAudioAuditTask | 创建音频审核任务 |
| UpdateAudioAuditTask | 更新音频审核任务配置 |
| GetAudioAuditResult | 获取音频审核任务结果 |
| GetImageAuditTasks | 查询所有审核任务 |
创意魔方
| API | 说明 |
|---|---|
| CreateImageStyle | 新建样式 |
| UpdateImageStyle | 编辑样式 |
| DeleteImageStyle | 删除样式 |
| GetImageStyleDetail | 获取样式详情 |
| GetImageStyles | 获取样式列表 |
| UpdateImageStyleMeta | 更新样式元数据 |
| AddImageElements | 添加常用图片/背景/蒙版要素 |
| GetImageElements | 获取常用图片/背景/蒙版要素 |
| DeleteImageElements | 删除常用图片/背景/蒙版要素 |
| AddImageBackgroundColors | 添加常用颜色 |
| GetImageBackgroundColors | 获取常用颜色 |
| DeleteImageBackgroundColors | 删除常用颜色 |
| GetImageFonts | 获取可用字体 |
| GetImageStyleResult | 获取结果图 URI |
| 样式结构 | 样式结构 |
多文件压缩处理
| API | 说明 |
|---|---|
| CreateImageCompressTask | 创建多文件压缩异步任务 |
| GetCompressTaskInfo | 获取异步压缩任务详情 |
附加组件标签查询
| API | 说明 |
|---|---|
| GetImageAddOnTag | 获取组件标签列表详情 |
数据迁移
| API | 说明 |
|---|---|
| CreateImageMigrateTask | 创建数据迁移任务 |
| DeleteImageMigrateTask | 删除迁移任务 |
| UpdateImageTaskStrategy | 更新迁移任务策略 |
| RerunImageMigrateTask | 重启迁移失败任务 |
| TerminateImageMigrateTask | 结束迁移任务 |
| ExportFailedMigrateTask | 导出迁移失败列表 |
| GetVendorBuckets | 获取服务商 Bucket |
| GetImageMigrateTasks | 获取迁移任务详情 |
离线转码
| API | 说明 |
|---|---|
| CreateImageTranscodeQueue | 创建任务队列 |
| DeleteImageTranscodeQueue | 删除任务队列 |
| UpdateImageTranscodeQueue | 更新任务队列配置 |
| UpdateImageTranscodeQueueStatus | 更新任务队列状态 |
| GetImageTranscodeQueues | 获取任务队列 |
| CreateImageTranscodeTask | 提交转码任务 |
| CreateImageTranscodeCallback | 手动触发条目维度回调 |
| DeleteImageTranscodeDetail | 删除任务执行详情 |
| GetImageTranscodeDetails | 获取任务执行详情 |
| CreateImageTranscodeTaskCallback | 手动触发任务维度回调 |
| GetImageTranscodeTasks | 获取离线转码任务 |
AI 能力组件 2.0
| API | 说明 |
|---|---|
| AIProcess | 创建 AI 图像处理任务（同步） |
| CreateImageAIProcessQueue | 创建批量处理任务队列 |
| CreateImageAITask | 创建 AI 图像处理任务（异步） |
| GetImageAIProcessQueues | 获取批量处理任务队列 |
| UpdateImageAIProcessQueue | 更新批量处理任务队列配置 |
| UpdateImageAIProcessQueueStatus | 更新批量处理任务队列状态 |
| DeleteImageAIProcessQueue | 删除批量处理任务队列 |
| DeleteImageAIProcessDetail | 删除批量处理条目 |
| CreateImageAIProcessCallback | 手动触发回调 |
| GetImageAITasks | 获取 AI 图像处理任务信息 |
| GetImageAIDetails | 获取 AI 图像处理任务执行详情 |
| AI 图像处理回调 | AI 图像处理回调 |
数据抓取
| API | 说明 |
|---|---|
| FetchImageUrl | 数据抓取 |
| GetUrlFetchTask | 获取异步抓取任务详情 |
日志查询
| API | 说明 |
|---|---|
| DescribeImageVolcCdnAccessLog | 查询离线日志下载地址 |
批处理
| API | 说明 |
|---|---|
| GetBatchProcessResult | 同步批量处理 |
| CreateBatchProcessTask | 创建批量处理异步任务 |
| GetBatchTaskInfo | 查询异步批量处理任务详情 |
其他处理API
| API | 说明 |
|---|---|
| 查询图片 meta 信息 | 查询图片 meta 信息 |
| 获取图片主题色 | 获取图片主题色 |
| 查询图片 alpha 信息 | 查询图片 alpha 信息 |
| 获取图片 BlurHash 码 | 获取图片 BlurHash 码 |
| UpdateImageExifData | 管理图片 EXIF 数据 |
附录
| API | 说明 |
|---|---|
| 盲水印提取回调 | 盲水印提取回调 |
最近更新时间：2026.03.27 17:16:32
这个页面对您有帮助吗？
有用
有用
无用
无用