最近更新时间：2024.02.07 11:20:55
首次发布时间：2022.08.31 15:46:49
我们为您提供各种能力对应的接口。您可使用 veImageX 提供的 OpenAPI 来对接产品服务，推荐您使用服务端SDK来调用 API。
| API | 说明 |
|---|---|
| GetImageServiceSubscription | 查询服务开通状态 |
| API | 说明 |
|---|---|
| CreateImageService | 创建服务 |
| DeleteImageService | 删除服务 |
| UpdateImageAuthKey | 更新主备鉴权 Key |
| GetImageAuthKey | 获取主备鉴权 Key |
| GetImageService | 获取单个服务信息 |
| GetAllImageServices | 获取全部服务信息 |
| UpdateImageObjectAccess | 更新源地址访问配置 |
| UpdateImageMirrorConf | 更新镜像回源配置 |
| UpdateServiceName | 更新服务名称 |
| UpdateImageUploadOverwrite | 更新重名覆盖上传配置 |
| UpdateResEventRule | 更新事件通知配置 |
| UpdateStorageRules | 更新服务存储策略 |
| CreateFileRestore | 恢复文件 |
| UpdateFileStorageClass | 修改文件存储类型 |
| API | 说明 |
|---|---|
| CreateImageTemplate | 创建图片模板 |
| DeleteImageTemplate | 删除图片模板 |
| GetImageTemplate | 获取单个图片模板 |
| GetAllImageTemplates | 获取服务下所有图片模板 |
| CreateImageTemplatesByImport | 导入模板 |
| GetTemplatesFromBin | 获取回收站中所有模板 |
| CreateTemplatesFromBin | 恢复回收站模板 |
| DeleteTemplatesFromBin | 删除回收站模板 |
| API | 说明 |
|---|---|
| AddDomainV1 | 新增域名 |
| GetDomainConfig | 获取域名配置 |
| DelDomain | 删除域名 |
| GetServiceDomains | 获取服务下所有域名信息 |
| SetDefaultDomain | 更新默认域名配置 |
| UpdateResponseHeader | 更新域名 resp header 配置 |
| UpdateRefer | 更新防盗链 |
| UpdateHttps | 更新 https 配置 |
| GetResponseHeaderValidateKeys | 获取 resp header 允许的 key 列表 |
| UpdateImageDomainIPAuth | 更新黑白名单配置 |
| UpdateDomainAdaptiveFmt | 更新域名自适应格式配置 |
| UpdateSlimConfig | 更新集智瘦身配置 |
| UpdateImageDomainUaAccess | 更新 UA 黑白名单配置 |
| UpdateImageDomainAreaAccess | 更新地域访问限制配置 |
| UpdateAdvance | 更新域名高级配置 |
| UpdateImageDomainBandwidthLimit | 更新带宽限制配置 |
| UpdateImageDomainDownloadSpeedLimit | 更新下载限速配置 |
| API | 说明 |
|---|---|
| AddCert | 新增证书 |
| DelCert | 删除证书 |
| GetAllCerts | 获取账号下所有证书 |
| DownloadCert | 下载证书 |
| GetCertInfo | 获取证书详情 |
| GetImageAllDomainCert | 获取所有域名及证书信息 |
| UpdateImageBatchDomainCert | 关联证书域名 |
| API | 说明 |
|---|---|
| UpdateImageFileKey | 重命名文件 |
| GetImageStorageFiles | 列举服务下的文件 |
| GetImageUploadFile | 获取服务下单个上传文件 |
| GetImageUploadFiles | 获取服务下全部上传文件 |
| DeleteImageUploadFiles | 删除服务下多个文件 |
| PreviewImageUploadFile | 预览服务下的文件 |
| GetImageUpdateFiles | 获取服务下的更新文件 |
| ApplyImageUpload | 获取文件上传地址和凭证 |
| CommitImageUpload | 确认上传并上报上传结果 |
| GetResourceURL | 获取资源URL |
| API | 说明 |
|---|---|
| FetchImageUrl | 数据抓取（Fetch） |
| GetUrlFetchTask | 获取异步抓取任务详情 |
| API | 说明 |
|---|---|
| CreateImageCompressTask | 创建多文件压缩异步任务 |
| GetCompressTaskInfo | 获取异步压缩任务详情 |
| API | 说明 |
|---|---|
| CreateImageContentTask | 创建刷新/预热/禁用/解禁任务 |
| GetImageContentTaskDetail | 获取任务详情 |
| GetImageContentBlockList | 获取禁用 URL 列表详情 |
| API | 说明 |
|---|---|
| DescribeImageXSummary | 获取资源用量概览 |
| DescribeImageXDomainTrafficData | 查询流量用量 |
| DescribeImageXDomainBandwidthData | 查询带宽用量 |
| DescribeImageXBucketRetrievalUsage | 获取资源占用量 |
| DescribeImageXRequestCntUsage | 获取请求次数 |
| DescribeImageXBaseOpUsage | 获取基础处理量 |
| DescribeImageXCompressUsage | 获取高效压缩量 |
| DescribeImageXMultiCompressUsage | 查询多文件压缩用量 |
| API | 说明 |
|---|---|
| DescribeImageXEdgeRequest | 查询边缘请求次数 |
| DescribeImageXMirrorRequestHttpCodeByTime | 查询镜像回源请求次时序数据 |
| DescribeImageXMirrorRequestHttpCodeOverview | 查询镜像回源请求次域名明细数据 |
| DescribeImageXMirrorRequestTraffic | 查询镜像回源流量 |
| DescribeImageXMirrorRequestBandwidth | 查询镜像回源带宽 |
| DescribeImageXEdgeRequestBandwidth | 查询边缘分发带宽用量 |
| DescribeImageXEdgeRequestTraffic | 查询边缘分发流量用量 |
| DescribeImageXEdgeRequestRegions | 获取边缘分发地区列表 |
| DescribeImageXServerQPSUsage | 查询数据处理服务 QPS 用量 |
| API | 说明 |
|---|---|
| DescribeImageXHitRateTrafficData | 查询流量命中率 |
| DescribeImageXHitRateRequestData | 查询请求命中率 |
| API | 说明 |
|---|---|
| DescribeImageXDomainBandwidthData | 获取数据统计分析结果 |
| API | 说明 |
|---|---|
| DescribeImageXServiceQuality | 获取服务质量概览 |
| API | 说明 |
|---|---|
| GetImageXQueryApps | 获取应用列表 |
| GetImageXQueryRegions | 获取地区列表 |
| GetImageXQueryDims | 获取自定义维度列表 |
| GetImageXQueryVals | 获取自定义维度值 |
| API | 说明 |
|---|---|
| DescribeImageXUploadSuccessRateByTime | 查询上传成功率 |
| DescribeImageXUploadErrorCodeAll | 查询错误码分布 |
| DescribeImageXUploadErrorCodeAll | 查询错误码时序数据 |
| DescribeImageXUploadCountByTime | 查询上传有效次数 |
| DescribeImageXUploadFileSize | 查询上传文件大小分布 |
| DescribeImageXUploadDuration | 查询上传平均耗时 |
| DescribeImageXUploadSpeed | 查询上传平均速度 |
| DescribeImageXUploadSegmentSpeedByTime | 查询上传分片速度 |
| API | 说明 |
|---|---|
| DescribeImageXCdnSuccessRateByTime | 查询网络成功率时序数据 |
| DescribeImageXCdnSuccessRateAll | 查询网络成功率分布 |
| DescribeImageXCdnErrorCodeByTime | 查询错误码时序数据 |
| DescribeImageXCdnErrorCodeAll | 查询错误码分布 |
| DescribeImageXCdnDurationDetailByTime | 查询网络耗时时序数据 |
| DescribeImageXCdnDurationAll | 查询网络耗时分布 |
| DescribeImageXCdnReuseRateByTime | 查询网络连接复用率时序数据 |
| DescribeImageXCdnReuseRateAll | 查询网络连接复用率分布 |
| DescribeImageXCdnProtocolRateByTime | 查询网络协议占比 |
| API | 说明 |
|---|---|
| DescribeImageXClientErrorCodeAll | 查询错误码分布 |
| DescribeImageXClientErrorCodeByTime | 查询错误码时序数据 |
| DescribeImageXClientDecodeSuccessRateByTime | 查询解码成功率 |
| DescribeImageXClientDecodeDurationByTime | 查询解码耗时 |
| DescribeImageXClientQueueDurationByTime | 查询排队耗时 |
| DescribeImageXClientLoadDurationAll | 查询加载耗时分布 |
| DescribeImageXClientLoadDuration | 查询加载耗时时序数据 |
| DescribeImageXClientFailureRate | 查询用户感知失败率 |
| DescribeImageXClientSdkVerByTime | 查询 SDK 版本变化趋势 |
| DescribeImageXClientFileSize | 查询文件大小分布 |
| DescribeImageXClientTopFileSize | 查询文件大小 TOP URL |
| DescribeImageXClientCountByTime | 查询客户端上报量 |
| DescribeImageXClientScoreByTime | 查询画质评估时序数据 |
| DescribeImageXClientDemotionRateByTime | 查询降级率时序数据 |
| DescribeImageXClientTopDemotionURL | 查询降级率 TOP URL |
| DescribeImageXClientQualityRateByTime | 查询黑白屏率时序数据 |
| DescribeImageXClientTopQualityURL | 查询黑白屏 TOP URL |
| API | 说明 |
|---|---|
| DescribeImageXSensibleCountByTime | 查询采集样本量 |
| DescribeImageXSensibleCacheHitRateByTime | 查询内存/磁盘命中率 |
| DescribeImageXSensibleTopSizeURL | 查询大图文件体积 TOP URL |
| DescribeImageXSensibleTopRamURL | 查询大图文件内存 TOP URL |
| DescribeImageXSensibleTopResolutionURL | 查询大图文件分辨率 TOP URL |
| DescribeImageXSensibleTopUnknownURL | 查询大图文件未知原因 TOP URL |
| API | 说明 |
|---|---|
| GetImageSettings | 获取配置项列表 |
| GetImageSettingRules | 获取规则列表 |
| CreateImageSettingRule | 创建配置项规则 |
| UpdateImageSettingRule | 更新配置项规则 |
| DeleteImageSettingRule | 删除配置项规则 |
| UpdateImageSettingRulePriority | 更新规则优先级 |
| GetImageSettingRuleHistory | 获取规则修改历史 |
| API | 说明 |
|---|---|
| GetImageAddOnTag | 获取组件标签列表 |
| GetImageAddOnConf | 获取增值能力配置 |
| GetImageOCR | 使用文字识别 OCR 获取识别信息 |
| GetImageBgFillResult | 使用智能图像扩展获取结果图 |
| GetSegmentImage | 使用智能背景移除获取结果图 |
| GetImageQuality | 使用画质评估获取分值 |
| GetImageSuperResolutionResult | 使用图像超分辨率获取结果图 |
| GetImageComicResult | 使用漫画风获取结果图 |
| GetImageSmartCropResult | 使用智能裁剪获取结果图 |
| GetDenoisingImage | 使用图像降噪获取结果图 |
| GetLicensePlateDetection | 使用车牌检测获取车牌位置 |
| GetImagePSDetection | 使用 PS 检测获取结果值 |
| GetPrivateImageType | 使用隐私分类获取分类信息 |
| API | 说明 |
|---|---|
| CreateImageStyle | 新建样式 |
| DeleteImageStyle | 删除样式 |
| UpdateImageStyle | 更新样式 |
| GetImageStyleDetail | 获取样式详情 |
| UpdateImageStyleMeta | 更新样式元数据 |
| GetImageStyles | 获取样式列表 |
| GetImageFonts | 获取可用字体 |
| AddImageElements | 添加常用图片或背景要素 |
| DeleteImageElements | 删除常用图片或背景要素 |
| GetImageElements | 获取常用图片或背景要素 |
| AddImageBackgroundColors | 添加常用颜色 |
| DeleteImageBackgroundColors | 删除常用颜色 |
| GetImageBackgroundColors | 获取常用颜色 |
| GetImageStyleResult | 获取结果图 URL |
| API | 说明 |
|---|---|
| CreateImageAuditTask | 创建审核任务 |
| GetImageAuditTasks | 查询所有审核任务 |
| UpdateImageAuditTask | 更新审核任务配置 |
| GetImageAuditResult | 获取审核任务结果 |
| API | 说明 |
|---|---|
| GetImageEnhanceResult | 使用画质增强获取结果图 |
| GetImageEnhanceResultWithData | 使用画质增强获取编码后图片二进制数据 |
| GetComprehensiveEnhanceImage | 使用综合增强获取结果图 |
| API | 说明 |
|---|---|
| GetDedupTaskStatus | 使用图片去重获取结果值 |
| GetImageDuplicateDetection | 获取异步去重任务详情 |
| API | 说明 |
|---|---|
| GetImageEraseModels | 获取图像修复列表详情 |
| GetImageEraseResult | 使用图像修复获取结果图 |
| API | 说明 |
|---|---|
| CreateHiddenWatermarkImage | 创建盲水印前背景图层 |
| CreateImageHmEmbed | 添加盲水印 |
| CreateImageHmExtract | 提取盲水印 |
| API | 说明 |
|---|---|
| CreateImageAnalyzeTask | 创建任务 |
| UpdateImageAnalyzeTask | 更新任务配置 |
| DeleteImageAnalyzeTask | 删除任务 |
| GetImageAnalyzeTasks | 获取任务列表 |
| DeleteImageAnalyzeTaskRun | 删除任务执行记录 |
| GetImageAnalyzeResult | 获取任务结果 |
| UpdateImageAnalyzeTaskStatus | 更新任务状态 |
| API | 说明 |
|---|---|
| CreateImageMigrateTask | 创建数据迁移任务 |
| GetImageMigrateTasks | 获取迁移任务详情 |
| UpdateImageTaskStrategy | 更新迁移任务策略 |
| GetVendorBuckets | 获取服务商 Bucket |
| TerminateImageMigrateTask | 结束迁移任务 |
| RerunImageMigrateTask | 重启迁移失败任务 |
| ExportFailedMigrateTask | 导出迁移失败列表 |
| API | 说明 |
|---|---|
| DescribeImageVolcCdnAccessLog | 查询离线日志下载地址 |
| API | 说明 |
|---|---|
| CreateImageTranscodeQueue | 创建任务队列 |
| DeleteImageTranscodeQueue | 删除任务队列 |
| UpdateImageTranscodeQueue | 更新任务队列配置 |
| UpdateImageTranscodeQueueStatus | 更新任务队列状态 |
| GetImageTranscodeQueues | 获取任务队列 |
| CreateImageTranscodeTask | 提交转码任务 |
| GetImageTranscodeDetails | 获取转码任务详情 |
| CreateImageTranscodeCallback | 手动触发回调 |
| DeleteImageTranscodeDetail | 删除转码执行任务 |
| API | 说明 |
|---|---|
| CreateImageMonitorRule | 新建告警规则 |
| GetImageMonitorRules | 获取所有告警规则 |
| UpdateImageMonitorRule | 更新告警规则 |
| UpdateImageMonitorRuleStatus | 更新告警规则状态 |
| DeleteImageMonitorRules | 删除告警规则 |
| GetImageAlertRecords | 获取所有告警记录 |
| DeleteImageMonitorRecords | 删除告警记录 |
| API | 说明 |
|---|---|
| GetBatchProcessResult | 同步批量处理 |
| CreateBatchProcessTask | 创建批量处理异步任务 |
| GetBatchTaskInfo | 查询异步批量处理任务详情 |
| API | 说明 |
|---|---|
| 查询图片 meta 信息 | 获取图片 meta 信息 |
| 图片主题色获取 | 获取主题色 |
| 查询图片 alpha 信息 | 查询图片 alpha 信息 |