public class ImagexTrait extends BaseServiceImpl
| Modifier and Type | Class and Description |
|---|---|
static class |
ImagexTrait.ResponseModel |
apiInfoList, credentials, ISigner, serviceInfo| Modifier | Constructor and Description |
|---|---|
protected |
ImagexTrait() |
protected |
ImagexTrait(ServiceInfo serviceInfo) |
destroy, getAccessKey, getApiInfoList, getHttpClient, getISigner, getRegion, getSecretKey, getServiceInfo, getSessionToken, getSignUrl, json, makeRequest, post, postDataWithResponse, postFileMultiPart, prepareRequest, proto, put, putData, putData, putDataWithResponse, putDataWithResponse, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSessionToken, setSocketTimeout, signSts2protected ImagexTrait()
protected ImagexTrait(ServiceInfo serviceInfo)
public <T> T getImageX(String action, Map<String,String> param, Class<T> resType) throws Exception
Exceptionpublic <T> T postImageX(String action, Map<String,String> param, Object req, Class<T> resType) throws Exception
Exceptionpublic CommonResponse getImageX(String action, Map<String,String> param) throws Exception
Exceptionpublic CommonResponse postImageX(String action, Map<String,String> param, Object req) throws Exception
Exceptionpublic UpdateImageDomainVolcOriginRes updateImageDomainVolcOrigin(UpdateImageDomainVolcOriginQuery query, UpdateImageDomainVolcOriginBody body) throws Exception
updateImageDomainVolcOrigin
修改源站配置
query - query argumentsbody - body payloadException - error during requestpublic DelDomainRes delDomain(DelDomainQuery query, DelDomainBody body) throws Exception
delDomain
删除域名
本接口支持删除指定服务下的域名。
query - query argumentsbody - body payloadException - error during requestpublic AddDomainV1Res addDomainV1(AddDomainV1Query query, AddDomainV1Body body) throws Exception
addDomainV1
新增域名
本接口支持通过指定服务 ID 以及输入域名等相关配置项,向该服务新增域名。
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageDomainIPAuthRes updateImageDomainIPAuth(UpdateImageDomainIPAuthQuery query, UpdateImageDomainIPAuthBody body) throws Exception
updateImageDomainIPAuth
更新 IP 黑白名单配置
本接口支持修改指定服务 ID 下域名的 IP 黑白名单配置。
query - query argumentsbody - body payloadException - error during requestpublic UpdateReferRes updateRefer(UpdateReferQuery query, UpdateReferBody body) throws Exception
updateRefer
更新 Referer 防盗链配置
本接口支持通过其指定服务 ID 和域名更新防盗链配置。
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageDomainUaAccessRes updateImageDomainUaAccess(UpdateImageDomainUaAccessQuery query, UpdateImageDomainUaAccessBody body) throws Exception
updateImageDomainUaAccess
更新 UA 黑白名单配置
本接口支持通过指定服务 ID、域名来配置 UA 访问限制。
query - query argumentsbody - body payloadException - error during requestpublic UpdateHttpsRes updateHttps(UpdateHttpsQuery query, UpdateHttpsBody body) throws Exception
updateHttps
更新 https 配置
本接口支持通过指定服务 ID 和域名来更新 HTTPS 配置。
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageDomainDownloadSpeedLimitRes updateImageDomainDownloadSpeedLimit(UpdateImageDomainDownloadSpeedLimitQuery query, UpdateImageDomainDownloadSpeedLimitBody body) throws Exception
updateImageDomainDownloadSpeedLimit
更新下载限速配置
本接口支持通过指定服务 ID 和域名更新下载限速相关配置。
query - query argumentsbody - body payloadException - error during requestpublic UpdateResponseHeaderRes updateResponseHeader(UpdateResponseHeaderQuery query, UpdateResponseHeaderBody body) throws Exception
updateResponseHeader
更新响应头配置
支持通过指定服务 ID 等参数修改响应头配置。
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageDomainAreaAccessRes updateImageDomainAreaAccess(UpdateImageDomainAreaAccessQuery query, UpdateImageDomainAreaAccessBody body) throws Exception
updateImageDomainAreaAccess
更新地域访问限制配置
本接口支持通过指定服务 ID、域名等配置区域访问限制。
query - query argumentsbody - body payloadException - error during requestpublic UpdateDomainAdaptiveFmtRes updateDomainAdaptiveFmt(UpdateDomainAdaptiveFmtQuery query, UpdateDomainAdaptiveFmtBody body) throws Exception
updateDomainAdaptiveFmt
更新域名自适应格式配置
本接口支持修改指定服务 ID 下域名的自适应格式配置。
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageDomainConfigRes updateImageDomainConfig(UpdateImageDomainConfigQuery query, UpdateImageDomainConfigBody body) throws Exception
updateImageDomainConfig
更新域名配置
本接口支持服务的多个域名批量更新域名各配置。
query - query argumentsbody - body payloadException - error during requestpublic UpdateAdvanceRes updateAdvance(UpdateAdvanceQuery query, UpdateAdvanceBody body) throws Exception
updateAdvance
更新域名高级配置
本接口支持更新指定服务和域名下的域名高级配置,如 IPV6,智能压缩。
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageDomainBandwidthLimitRes updateImageDomainBandwidthLimit(UpdateImageDomainBandwidthLimitQuery query, UpdateImageDomainBandwidthLimitBody body) throws Exception
updateImageDomainBandwidthLimit
更新带宽限制配置
本接口支持通过指定服务 ID 和域名更新带宽限速相关配置,如带宽阈值、控制策略等。
query - query argumentsbody - body payloadException - error during requestpublic UpdateSlimConfigRes updateSlimConfig(UpdateSlimConfigQuery query, UpdateSlimConfigBody body) throws Exception
updateSlimConfig
更新集智瘦身配置
本接口支持修改指定服务 ID 下域名的集智瘦身配置。
:::tip
* 集智瘦身支持[模板配置](https://www.volcengine.com/docs/508/114402)和域名配置,但仅支持运行一种处理方式。请选择其中一种配置,来使用集智瘦身功能。
* 使用域名配置的效果一般会低于模板配置。
:::
query - query argumentsbody - body payloadException - error during requestpublic SetDefaultDomainRes setDefaultDomain(SetDefaultDomainBody body) throws Exception
setDefaultDomain
更新默认域名配置
本接口支持更改默认域名。
body - body payloadException - error during requestpublic DescribeImageVolcCdnAccessLogRes describeImageVolcCdnAccessLog(DescribeImageVolcCdnAccessLogQuery query, DescribeImageVolcCdnAccessLogBody body) throws Exception
describeImageVolcCdnAccessLog
查询离线日志下载地址
本接口支持通过指定服务 ID 、域名和地域等获取查询离线日志下载链接。您可通过下载链接获取离线日志,日志字段说明请参考[日志字段说明与示例](https://www.volcengine.com/docs/508/184315
query - query argumentsbody - body payloadException - error during requestpublic VerifyDomainOwnerRes verifyDomainOwner(VerifyDomainOwnerBody body) throws Exception
verifyDomainOwner
校验域名归属权
校验域名归属权。
body - body payloadException - error during requestpublic GetResponseHeaderValidateKeysRes getResponseHeaderValidateKeys() throws Exception
getResponseHeaderValidateKeys
获取响应头允许的key列表
本接口支持获取当前账号全部合法的响应头 key 信息。
Exception - error during requestpublic GetDomainConfigRes getDomainConfig(GetDomainConfigQuery query) throws Exception
getDomainConfig
获取域名配置
通过指定服务 ID 以及域名,获取当前域名的配置信息。
query - query argumentsException - error during requestpublic GetDomainOwnerVerifyContentRes getDomainOwnerVerifyContent(GetDomainOwnerVerifyContentQuery query) throws Exception
getDomainOwnerVerifyContent
获取归属权校验内容
获取归属权校验内容
query - query argumentsException - error during requestpublic GetServiceDomainsRes getServiceDomains(GetServiceDomainsQuery query) throws Exception
getServiceDomains
获取服务下全部域名
本接口支持通过指定服务 ID 获取服务下所有域名信息。
query - query argumentsException - error during requestpublic DeleteImageMonitorRulesRes deleteImageMonitorRules(DeleteImageMonitorRulesBody body) throws Exception
deleteImageMonitorRules
删除告警规则
本接口支持删除指定的告警规则。
body - body payloadException - error during requestpublic DeleteImageMonitorRecordsRes deleteImageMonitorRecords(DeleteImageMonitorRecordsBody body) throws Exception
deleteImageMonitorRecords
删除告警记录
本接口支持通过指定待删除的告警记录 ID 列表来删除对应告警记录。
body - body payloadException - error during requestpublic CreateImageMonitorRuleRes createImageMonitorRule(CreateImageMonitorRuleBody body) throws Exception
createImageMonitorRule
新建告警规则
本接口支持在账号下创建一条告警规则。
body - body payloadException - error during requestpublic UpdateImageMonitorRuleRes updateImageMonitorRule(UpdateImageMonitorRuleBody body) throws Exception
updateImageMonitorRule
更新告警规则
本接口支持更新指定告警规则的配置,如规则名称、监控应用等。
body - body payloadException - error during requestpublic UpdateImageMonitorRuleStatusRes updateImageMonitorRuleStatus(UpdateImageMonitorRuleStatusBody body) throws Exception
updateImageMonitorRuleStatus
更新告警规则状态
本接口支持修改指定告警规则的开启状态。
body - body payloadException - error during requestpublic GetImageAlertRecordsRes getImageAlertRecords(GetImageAlertRecordsBody body) throws Exception
getImageAlertRecords
获取所含有报警记录
获取所含有报警记录
body - body payloadException - error during requestpublic GetImageMonitorRulesRes getImageMonitorRules(GetImageMonitorRulesQuery query) throws Exception
getImageMonitorRules
获取所有告警规则
本接口支持获取该账号下全部的报警规则详情,包含规则 ID、创建时间和更新时间等。
query - query argumentsException - error during requestpublic CreateImageSettingRuleRes createImageSettingRule(CreateImageSettingRuleBody body) throws Exception
createImageSettingRule
创建配置规则
本接口支持创建指定配置项的规则。
body - body payloadException - error during requestpublic DeleteImageSettingRuleRes deleteImageSettingRule(DeleteImageSettingRuleBody body) throws Exception
deleteImageSettingRule
删除配置项规则
本接口支持删除指定应用中某个配置项的规则。
body - body payloadException - error during requestpublic UpdateImageSettingRulePriorityRes updateImageSettingRulePriority(UpdateImageSettingRulePriorityBody body) throws Exception
updateImageSettingRulePriority
更新规则优先级
本接口支持通过指定应用 ID、配置项 ID 以及待更新后的全部规则 ID 及规则优先级,来更新配置项下的规则优先级。
body - body payloadException - error during requestpublic UpdateImageSettingRuleRes updateImageSettingRule(UpdateImageSettingRuleBody body) throws Exception
updateImageSettingRule
更新配置规则
本接口支持更新指定应用中配置项的规则。
body - body payloadException - error during requestpublic GetImageSettingsRes getImageSettings(GetImageSettingsQuery query) throws Exception
getImageSettings
查看配置
本接口支持通过指定应用 ID 以及所属组件,来获取当前组件配置项列表信息。
query - query argumentsException - error during requestpublic GetImageSettingRuleHistoryRes getImageSettingRuleHistory(GetImageSettingRuleHistoryQuery query) throws Exception
getImageSettingRuleHistory
查看配置历史
本接口支持查询指定应用中配置的规则修改历史。
query - query argumentsException - error during requestpublic GetImageSettingRulesRes getImageSettingRules(GetImageSettingRulesQuery query) throws Exception
getImageSettingRules
查看配置规则
本接口支持指定应用以及具体配置项,来获取配置项下的配置的规则列表信息。
query - query argumentsException - error during requestpublic CreateImageMigrateTaskRes createImageMigrateTask(CreateImageMigrateTaskBody body) throws Exception
createImageMigrateTask
创建数据迁移任务
本接口支持您通过自定义迁移源信息和具体迁移策略等配置,创建从源存储至 veImageX 的数据迁移任务。
## 迁移准备
您需要在迁移前根据迁移方式在源存储服务商处获取以下配置参数。
| 源服务商 | 准备内容 | 文档地址 |
| --- | --- | --- |
| 阿里云OSS | 桶遍历方式:Access Key、Secret Key、Bucket | [迁移准备](https://www.volcengine.com/docs/508/129214) |
| 腾讯云COS | - 桶遍历方式:Access Key、Secret Key、Bucket、Region | [迁移准备](https://www.volcengine.com/docs/508/129215) |\
| | - 桶清单方式:Access Key、Secret Key、Bucket、Region、BucketInventoryDir、BucketInventorySchema | |\
| | :::tip | |\
| | 桶清单方式完整迁移流程详见[使用桶清单方式进行数据迁移](https://www.volcengine.com/docs/508/1347855)。 | |\
| | ::: | |
| 七牛云Kodo | 桶遍历方式:Access Key、Secret Key、Bucket | [迁移准备](https://www.volcengine.com/docs/508/129216) |
| 百度云BOS | 桶遍历方式:Access Key、Secret Key、Bucket、Region | [迁移准备](https://www.volcengine.com/docs/508/129219) |
| 华为云OBS | 桶遍历方式:Access Key、Secret Key、Bucket、Region | [迁移准备](https://www.volcengine.com/docs/508/129220) |
| 优刻得(Ucloud File) | 桶遍历方式:Access Key、Secret Key、Bucket、Region | [迁移准备](https://www.volcengine.com/docs/508/129217) |
| AWS国际站 | 桶遍历方式:Access Key、Secret Key、Bucket | [迁移准备](https://www.volcengine.com/docs/508/129218) |
| 其他 S3 协议存储 | 桶遍历方式:Access Key、Secret Key、Bucket、Region、Endpoint | 请根据实际源站获取 |
| URL | 迁移 URL 列表文件(.txt)的公网访问地址 | [URL 列表迁移说明](https://www.volcengine.com/docs/508/1263268) |
body - body payloadException - error during requestpublic DeleteImageMigrateTaskRes deleteImageMigrateTask(DeleteImageMigrateTaskQuery query) throws Exception
deleteImageMigrateTask
删除迁移任务
本接口支持您通过指定任务 ID 来删除该迁移任务,仅对状态是非**运行中**外的任务生效。
:::tip
仅当状态非`Running`时,该删除操作有效。您可调用[GetImageMigrateTasks](https://www.volcengine.com/docs/508/1108670) 查看待结束任务的状态。
:::
query - query argumentsException - error during requestpublic ExportFailedMigrateTaskRes exportFailedMigrateTask(ExportFailedMigrateTaskQuery query) throws Exception
exportFailedMigrateTask
导出迁移失败列表
本接口支持您通过指定迁移失败的任务 ID 来导出文件地址和迁移失败错误信息。
query - query argumentsException - error during requestpublic UpdateImageTaskStrategyRes updateImageTaskStrategy(UpdateImageTaskStrategyBody body) throws Exception
updateImageTaskStrategy
更新迁移任务策略
本接口支持通过指定任务 ID 来更新该任务的迁移策略。
body - body payloadException - error during requestpublic TerminateImageMigrateTaskRes terminateImageMigrateTask(TerminateImageMigrateTaskQuery query) throws Exception
terminateImageMigrateTask
结束迁移任务
通过指定任务 ID 来结束该迁移任务。结束迁移任务将停止后续的迁移文件,已完成的迁移文件不被删除。
:::tip
仅当状态为`Initial`和`Running`时,该结束操作有效。您可调用[GetImageMigrateTasks](https://www.volcengine.com/docs/508/1108670) 查看待结束任务的状态。
:::
query - query argumentsException - error during requestpublic GetVendorBucketsRes getVendorBuckets(GetVendorBucketsBody body) throws Exception
getVendorBuckets
获取服务商 Bucket
本接口支持通过指定云服务商和访问密钥获取迁移源 Bucket 详情。
body - body payloadException - error during requestpublic GetImageMigrateTasksRes getImageMigrateTasks(GetImageMigrateTasksQuery query) throws Exception
getImageMigrateTasks
获取迁移任务详情
本接口支持分页获取当前账号下的迁移任务及其迁移详情。
query - query argumentsException - error during requestpublic RerunImageMigrateTaskRes rerunImageMigrateTask(RerunImageMigrateTaskQuery query) throws Exception
rerunImageMigrateTask
重启迁移失败任务
本接口支持您通过指定任务 ID 来重新启动该迁移任务(原任务基础上重试失败列表),仅对状态为部分迁移完成的任务生效。
:::tip
仅当状态为`Partial`时,该重启操作有效。您可调用[GetImageMigrateTasks](https://www.volcengine.com/docs/508/1108670) 查看待结束任务的状态。
:::
query - query argumentsException - error during requestpublic GetImageAddOnTagRes getImageAddOnTag(GetImageAddOnTagQuery query) throws Exception
getImageAddOnTag
获取组件标签列表详情
本接口支持通过指定组件标签 key 获取已发布且对应账号可见的组件相关标签值。
query - query argumentsException - error during requestpublic DescribeImageXCubeUsageRes describeImageXCubeUsage(DescribeImageXCubeUsageQuery query) throws Exception
describeImageXCubeUsage
查询创意魔方用量
本接口支持通过自定义查询时间段,查询该时间段的创意魔方用量。
query - query argumentsException - error during requestpublic DescribeImageXSourceRequestBandwidthRes describeImageXSourceRequestBandwidth(DescribeImageXSourceRequestBandwidthQuery query) throws Exception
describeImageXSourceRequestBandwidth
查询回源带宽用量
本接口支持通过自定义查询时间段,查询该时间段的回源带宽用量。
query - query argumentsException - error during requestpublic DescribeImageXSourceRequestTrafficRes describeImageXSourceRequestTraffic(DescribeImageXSourceRequestTrafficQuery query) throws Exception
describeImageXSourceRequestTraffic
查询回源流量用量
本接口支持通过自定义查询时间段,查询该时间段的回源流量用量。
query - query argumentsException - error during requestpublic DescribeImageXSourceRequestRes describeImageXSourceRequest(DescribeImageXSourceRequestQuery query) throws Exception
describeImageXSourceRequest
查询回源请求次
本接口支持通过自定义查询时间段,查询该时间段的回源请求次数。
query - query argumentsException - error during requestpublic DescribeImageXStorageUsageRes describeImageXStorageUsage(DescribeImageXStorageUsageQuery query) throws Exception
describeImageXStorageUsage
查询存储监控用量
本接口支持通过自定义查询时间段,查询该时间段的存储监控用量。
query - query argumentsException - error during requestpublic DescribeImageXBucketRetrievalUsageRes describeImageXBucketRetrievalUsage(DescribeImageXBucketRetrievalUsageQuery query) throws Exception
describeImageXBucketRetrievalUsage
查询资源占用量
本接口支持通过自定义查询时间段,查询该时间段的每天资源占用量。
:::tip
单次查询最大时间跨度为 93 天。
:::
query - query argumentsException - error during requestpublic DescribeImageXAIRequestCntUsageRes describeImageXAIRequestCntUsage(DescribeImageXAIRequestCntUsageQuery query) throws Exception
describeImageXAIRequestCntUsage
查询附加组件智能处理请求次
本接口支持通过自定义查询时间段,查询该时间段的附加组件智能处理请求次数。
query - query argumentsException - error during requestpublic DescribeImageXSummaryRes describeImageXSummary(DescribeImageXSummaryQuery query) throws Exception
describeImageXSummary
查询用量概览
本接口支持通过指定时间点以及服务 ID,查询本月用量概览,包括带宽、流量、存储、请求次数、基础图像处理。
query - query argumentsException - error during requestpublic DescribeImageXDomainTrafficDataRes describeImageXDomainTrafficData(DescribeImageXDomainTrafficDataQuery query) throws Exception
describeImageXDomainTrafficData
查询流量用量
本接口支持通过自定义时间段,来查询域名流量用量。
query - query argumentsException - error during requestpublic DescribeImageXDomainBandwidthDataRes describeImageXDomainBandwidthData(DescribeImageXDomainBandwidthDataQuery query) throws Exception
describeImageXDomainBandwidthData
查询带宽用量
本接口支持通过自定义时间段,查询域名带宽用量。
query - query argumentsException - error during requestpublic DescribeImageXDomainBandwidthNinetyFiveDataRes describeImageXDomainBandwidthNinetyFiveData(DescribeImageXDomainBandwidthNinetyFiveDataQuery query) throws Exception
describeImageXDomainBandwidthNinetyFiveData
查询带宽95值
本接口支持通过自定义时间段,查询域名的 95 峰值带宽用量。
query - query argumentsException - error during requestpublic DescribeImageXBucketUsageRes describeImageXBucketUsage(DescribeImageXBucketUsageQuery query) throws Exception
describeImageXBucketUsage
查询资源占用量
本接口支持通过自定义查询时间段,查询该时间段的每天资源占用量。
:::tip
单次查询最大时间跨度为 93 天。
:::
query - query argumentsException - error during requestpublic DescribeImageXBillingRequestCntUsageRes describeImageXBillingRequestCntUsage(DescribeImageXBillingRequestCntUsageQuery query) throws Exception
describeImageXBillingRequestCntUsage
获取附加组件通用请求次数
本接口支持通过自定义查询时间段,获取该时间段的附加组件通用请求次数。
query - query argumentsException - error during requestpublic DescribeImageXRequestCntUsageRes describeImageXRequestCntUsage(DescribeImageXRequestCntUsageQuery query) throws Exception
describeImageXRequestCntUsage
查询请求次数
本接口支持通过自定义查询时间段,查询该时间段的请求次数。
query - query argumentsException - error during requestpublic DescribeImageXBaseOpUsageRes describeImageXBaseOpUsage(DescribeImageXBaseOpUsageQuery query) throws Exception
describeImageXBaseOpUsage
查询基础处理量
本接口支持通过自定义时间段,查询该时间段的图像基础处理量。
query - query argumentsException - error during requestpublic DescribeImageXCompressUsageRes describeImageXCompressUsage(DescribeImageXCompressUsageQuery query) throws Exception
describeImageXCompressUsage
查询高效压缩量
本接口支持通过自定义查询时间段,查询该时间段的图像高效压缩量。
query - query argumentsException - error during requestpublic DescribeImageXScreenshotUsageRes describeImageXScreenshotUsage(DescribeImageXScreenshotUsageQuery query) throws Exception
describeImageXScreenshotUsage
查询截帧用量
本接口支持通过自定义查询时间段,查询该时间段的截帧用量。
query - query argumentsException - error during requestpublic DescribeImageXVideoClipDurationUsageRes describeImageXVideoClipDurationUsage(DescribeImageXVideoClipDurationUsageQuery query) throws Exception
describeImageXVideoClipDurationUsage
查询小视频转动图用量
本接口支持通过自定义查询时间段,查询该时间段的小视频转动图的视频转换时长用量。
query - query argumentsException - error during requestpublic DescribeImageXMultiCompressUsageRes describeImageXMultiCompressUsage(DescribeImageXMultiCompressUsageQuery query) throws Exception
describeImageXMultiCompressUsage
查询多文件压缩用量
本接口支持通过自定义查询时间段,查询该时间段的多文件压缩用量。
query - query argumentsException - error during requestpublic DescribeImageXEdgeRequestRes describeImageXEdgeRequest(DescribeImageXEdgeRequestQuery query) throws Exception
describeImageXEdgeRequest
查询边缘分发请求次
本接口支持通过自定义查询时间段,查询该时间段的边缘请求次数。
query - query argumentsException - error during requestpublic DescribeImageXEdgeRequestBandwidthRes describeImageXEdgeRequestBandwidth(DescribeImageXEdgeRequestBandwidthQuery query) throws Exception
describeImageXEdgeRequestBandwidth
查询边缘分发带宽用量
本接口支持通过自定义查询时间段,查询该时间段的边缘分发带宽用量。
query - query argumentsException - error during requestpublic DescribeImageXEdgeRequestTrafficRes describeImageXEdgeRequestTraffic(DescribeImageXEdgeRequestTrafficQuery query) throws Exception
describeImageXEdgeRequestTraffic
查询边缘分发流量用量
本接口支持通过自定义查询时间段,查询该时间段的边缘分发流量用量。
query - query argumentsException - error during requestpublic DescribeImageXEdgeRequestRegionsRes describeImageXEdgeRequestRegions(DescribeImageXEdgeRequestRegionsQuery query) throws Exception
describeImageXEdgeRequestRegions
获取边缘分发地区列表
本接口支持通过自定义查询时间段,查询该时间段的边缘分发数据的地区列表。
query - query argumentsException - error during requestpublic DescribeImageXMirrorRequestHttpCodeByTimeRes describeImageXMirrorRequestHttpCodeByTime(DescribeImageXMirrorRequestHttpCodeByTimeBody body) throws Exception
describeImageXMirrorRequestHttpCodeByTime
查询镜像回源请求次
本接口支持通过自定义查询时间段,查询该时间段的镜像回源请求次。
body - body payloadException - error during requestpublic DescribeImageXMirrorRequestHttpCodeOverviewRes describeImageXMirrorRequestHttpCodeOverview(DescribeImageXMirrorRequestHttpCodeOverviewBody body) throws Exception
describeImageXMirrorRequestHttpCodeOverview
查询镜像回源请求次域名明细数据
本接口支持通过自定义查询时间段,查询该时间段的镜像回源请求次的域名明细数据用量。
body - body payloadException - error during requestpublic DescribeImageXMirrorRequestTrafficRes describeImageXMirrorRequestTraffic(DescribeImageXMirrorRequestTrafficBody body) throws Exception
describeImageXMirrorRequestTraffic
查询镜像回源流量
本接口支持通过自定义查询时间段,查询该时间段的镜像回源流量用量数据。
body - body payloadException - error during requestpublic DescribeImageXMirrorRequestBandwidthRes describeImageXMirrorRequestBandwidth(DescribeImageXMirrorRequestBandwidthBody body) throws Exception
describeImageXMirrorRequestBandwidth
查询镜像回源带宽
本接口支持通过自定义查询时间段,查询该时间段的镜像回源带宽用量数据。
body - body payloadException - error during requestpublic DescribeImageXServerQPSUsageRes describeImageXServerQPSUsage(DescribeImageXServerQPSUsageQuery query) throws Exception
describeImageXServerQPSUsage
查询数据处理服务QPS
本接口支持通过自定义查询时间段,查询该时间段的数据处理服务QPS。
query - query argumentsException - error during requestpublic DescribeImageXHitRateTrafficDataRes describeImageXHitRateTrafficData(DescribeImageXHitRateTrafficDataQuery query) throws Exception
describeImageXHitRateTrafficData
查询流量命中率
本接口支持通过自定义查询时间段,查询该时间段的域名的 CDN 流量命中率用量数据。
query - query argumentsException - error during requestpublic DescribeImageXHitRateRequestDataRes describeImageXHitRateRequestData(DescribeImageXHitRateRequestDataQuery query) throws Exception
describeImageXHitRateRequestData
查询请求命中率
本接口支持通过自定义查询时间段,查询该时间段的域名的 CDN 请求次数命中率用量数据。
query - query argumentsException - error during requestpublic DescribeImageXCDNTopRequestDataRes describeImageXCDNTopRequestData(DescribeImageXCDNTopRequestDataQuery query) throws Exception
describeImageXCDNTopRequestData
获取数据统计分析结果
本接口支持获取按照流量/请求次数排序的数据列表,即按流量或请求次数由大到小排序后,访问量最靠前的域名/URL/Refer/客户端IP/UA/访问区域/运营商等数据。
:::tip
- URL/Refer/客户端IP/UA 最多支持展示 Top 1000 的数据。
- 访问区域/运营商可展示展示全量数据。
:::
query - query argumentsException - error during requestpublic DescribeImageXHeifEncodeFileInSizeByTimeRes describeImageXHeifEncodeFileInSizeByTime(DescribeImageXHeifEncodeFileInSizeByTimeBody body) throws Exception
describeImageXHeifEncodeFileInSizeByTime
查询heif编码前文件大小时序数据
本接口支持通过指定查询维度,来获取 HEIF 编码监控的编码前文件大小时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXHeifEncodeFileOutSizeByTimeRes describeImageXHeifEncodeFileOutSizeByTime(DescribeImageXHeifEncodeFileOutSizeByTimeBody body) throws Exception
describeImageXHeifEncodeFileOutSizeByTime
查询heif编码后文件大小时序数据
本接口支持通过指定查询维度,来获取 HEIF 编码监控的编码后文件大小时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXHeifEncodeSuccessCountByTimeRes describeImageXHeifEncodeSuccessCountByTime(DescribeImageXHeifEncodeSuccessCountByTimeBody body) throws Exception
describeImageXHeifEncodeSuccessCountByTime
查询heif编码成功次数时序数据
本接口支持通过指定查询维度,来获取 HEIF 编码监控的编码成功次数时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXHeifEncodeSuccessRateByTimeRes describeImageXHeifEncodeSuccessRateByTime(DescribeImageXHeifEncodeSuccessRateByTimeBody body) throws Exception
describeImageXHeifEncodeSuccessRateByTime
查询heif编码成功率时序数据
本接口支持通过指定查询维度,来获取 HEIF 编码监控的编码成功率时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXHeifEncodeDurationByTimeRes describeImageXHeifEncodeDurationByTime(DescribeImageXHeifEncodeDurationByTimeBody body) throws Exception
describeImageXHeifEncodeDurationByTime
查询heif编码耗时时序数据
本接口支持通过指定查询维度,来获取 HEIF 编码监控的编码耗时时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXHeifEncodeErrorCodeByTimeRes describeImageXHeifEncodeErrorCodeByTime(DescribeImageXHeifEncodeErrorCodeByTimeBody body) throws Exception
describeImageXHeifEncodeErrorCodeByTime
查询heif编码错误码时序数据
本接口支持通过指定查询维度,来获取 HEIF 编码监控的编码错误码时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXExceedResolutionRatioAllRes describeImageXExceedResolutionRatioAll(DescribeImageXExceedResolutionRatioAllBody body) throws Exception
describeImageXExceedResolutionRatioAll
查询大图分辨率占比分布
本接口支持通过指定查询维度,来获取大图分辨率占比分布数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXExceedFileSizeRes describeImageXExceedFileSize(DescribeImageXExceedFileSizeBody body) throws Exception
describeImageXExceedFileSize
查询大图文件体积大小分布
本接口支持通过指定查询维度,来获取大图文件体积大小分布数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXExceedCountByTimeRes describeImageXExceedCountByTime(DescribeImageXExceedCountByTimeBody body) throws Exception
describeImageXExceedCountByTime
查询大图样本量
本接口支持查询大图样本量数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXServiceQualityRes describeImageXServiceQuality(DescribeImageXServiceQualityQuery query) throws Exception
describeImageXServiceQuality
服务质量概览
本接口支持通过指定服务地区,从而获取当前账号下的服务数据。
query - query argumentsException - error during requestpublic GetImageXQueryAppsRes getImageXQueryApps(GetImageXQueryAppsQuery query) throws Exception
getImageXQueryApps
查询应用列表
本接口支持指定应用数据传入来源,查询账号下当前来源的应用信息。
query - query argumentsException - error during requestpublic GetImageXQueryRegionsRes getImageXQueryRegions(GetImageXQueryRegionsQuery query) throws Exception
getImageXQueryRegions
查询地区列表
本接口支持通过指定数据来源,查询当前数据查询的的具体国内省份和海外国家。
query - query argumentsException - error during requestpublic GetImageXQueryDimsRes getImageXQueryDims(GetImageXQueryDimsQuery query) throws Exception
getImageXQueryDims
查询自定义维度列表
本接口支持通过指定数据来源,查询上传数据中的维度信息。
query - query argumentsException - error during requestpublic GetImageXQueryValsRes getImageXQueryVals(GetImageXQueryValsQuery query) throws Exception
getImageXQueryVals
查询自定义维度值
本接口支持通过自定义查询维度以及指定数据来源,查询按降序排列的上报数据中出现的维度值信息。
query - query argumentsException - error during requestpublic DescribeImageXUploadCountByTimeRes describeImageXUploadCountByTime(DescribeImageXUploadCountByTimeBody body) throws Exception
describeImageXUploadCountByTime
查询上传有效次数
本接口支持通过指定查询维度,来获取上传数据中的有效上传次数数据,包含有效次数和数据对应时间点。
body - body payloadException - error during requestpublic DescribeImageXUploadDurationRes describeImageXUploadDuration(DescribeImageXUploadDurationBody body) throws Exception
describeImageXUploadDuration
查询上传平均耗时
本接口支持通过指定查询维度,来获取上传数据中的上传平均耗时数据等。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXUploadSuccessRateByTimeRes describeImageXUploadSuccessRateByTime(DescribeImageXUploadSuccessRateByTimeBody body) throws Exception
describeImageXUploadSuccessRateByTime
查询上传成功率
本接口支持通过指定查询维度,查询上传成功率及数据对应时间点。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXUploadFileSizeRes describeImageXUploadFileSize(DescribeImageXUploadFileSizeBody body) throws Exception
describeImageXUploadFileSize
查询上传文件大小分布
本接口支持通过指定查询维度,来获取上传数据中的上传文件大小数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXUploadErrorCodeByTimeRes describeImageXUploadErrorCodeByTime(DescribeImageXUploadErrorCodeByTimeBody body) throws Exception
describeImageXUploadErrorCodeByTime
查询错误码时序数据
本接口支持通过指定查询维度,来获取上传数据中的错误码信息以及时序数据等。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXUploadErrorCodeAllRes describeImageXUploadErrorCodeAll(DescribeImageXUploadErrorCodeAllBody body) throws Exception
describeImageXUploadErrorCodeAll
查询错误码分布
本接口支持通过指定查询维度,查询错误码详细数据,如:错误码内容、错误码数量和地域信息等。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXUploadSpeedRes describeImageXUploadSpeed(DescribeImageXUploadSpeedBody body) throws Exception
describeImageXUploadSpeed
查询上传平均速度
本接口支持通过指定查询维度,来获取上传数据中的上传平均速度数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXUploadSegmentSpeedByTimeRes describeImageXUploadSegmentSpeedByTime(DescribeImageXUploadSegmentSpeedByTimeBody body) throws Exception
describeImageXUploadSegmentSpeedByTime
查询上传分片速度
本接口支持通过指定查询时间段和时间粒度获取 2.0 模式下的上传分片速度。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXCdnSuccessRateByTimeRes describeImageXCdnSuccessRateByTime(DescribeImageXCdnSuccessRateByTimeBody body) throws Exception
describeImageXCdnSuccessRateByTime
查询网络成功率时序数据
本接口支持通过指定查询维度,来获取下行网络监控的网络成功率时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXCdnSuccessRateAllRes describeImageXCdnSuccessRateAll(DescribeImageXCdnSuccessRateAllBody body) throws Exception
describeImageXCdnSuccessRateAll
查询网络成功率分布
本接口支持通过指定查询维度,来获取下行网络监控的网络成功率分布数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXCdnErrorCodeByTimeRes describeImageXCdnErrorCodeByTime(DescribeImageXCdnErrorCodeByTimeBody body) throws Exception
describeImageXCdnErrorCodeByTime
查询错误码时序数据
本接口支持通过指定查询维度,来获取下行网络监控的错误码时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXCdnErrorCodeAllRes describeImageXCdnErrorCodeAll(DescribeImageXCdnErrorCodeAllBody body) throws Exception
describeImageXCdnErrorCodeAll
查询错误码分布
本接口支持通过指定查询维度,来获取下行网络监控的错误码分布数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXCdnDurationDetailByTimeRes describeImageXCdnDurationDetailByTime(DescribeImageXCdnDurationDetailByTimeBody body) throws Exception
describeImageXCdnDurationDetailByTime
查询网络耗时时序数据
本接口支持通过指定查询维度,来获取下行网络监控的网络耗时时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXCdnDurationAllRes describeImageXCdnDurationAll(DescribeImageXCdnDurationAllBody body) throws Exception
describeImageXCdnDurationAll
查询网络耗时分布
本接口支持通过指定查询维度,来获取下行网络监控的网络耗时分布数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXCdnReuseRateByTimeRes describeImageXCdnReuseRateByTime(DescribeImageXCdnReuseRateByTimeBody body) throws Exception
describeImageXCdnReuseRateByTime
查询网络连接复用率时序数据
本接口支持通过指定查询维度,来获取下行网络监控的网络连接复用率时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXCdnReuseRateAllRes describeImageXCdnReuseRateAll(DescribeImageXCdnReuseRateAllBody body) throws Exception
describeImageXCdnReuseRateAll
查询网络连接复用率分布
本接口支持通过指定查询维度,来获取下行网络监控的网络连接复用率分布数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXCdnProtocolRateByTimeRes describeImageXCdnProtocolRateByTime(DescribeImageXCdnProtocolRateByTimeBody body) throws Exception
describeImageXCdnProtocolRateByTime
查询网络协议占比
本接口支持通过指定查询维度,来获取下行网络监控的网络协议占比数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientFailureRateRes describeImageXClientFailureRate(DescribeImageXClientFailureRateBody body) throws Exception
describeImageXClientFailureRate
查询用户感知失败率
本接口支持通过指定查询维度,来获取客户端状态监控的用户感知失败率数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientDecodeSuccessRateByTimeRes describeImageXClientDecodeSuccessRateByTime(DescribeImageXClientDecodeSuccessRateByTimeBody body) throws Exception
describeImageXClientDecodeSuccessRateByTime
查询解码成功率
本接口支持通过指定查询维度,来获取客户端状态监控的解码成功率数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientDecodeDurationByTimeRes describeImageXClientDecodeDurationByTime(DescribeImageXClientDecodeDurationByTimeBody body) throws Exception
describeImageXClientDecodeDurationByTime
查询解码耗时
本接口支持通过指定查询维度,来获取客户端状态监控的解码耗时数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientQueueDurationByTimeRes describeImageXClientQueueDurationByTime(DescribeImageXClientQueueDurationByTimeBody body) throws Exception
describeImageXClientQueueDurationByTime
查询排队耗时
本接口支持通过指定查询维度,来获取客户端状态监控的排队耗时数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientErrorCodeByTimeRes describeImageXClientErrorCodeByTime(DescribeImageXClientErrorCodeByTimeBody body) throws Exception
describeImageXClientErrorCodeByTime
查询错误码时序数据
本接口支持通过指定查询维度,来获取客户端状态监控的错误码时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientErrorCodeAllRes describeImageXClientErrorCodeAll(DescribeImageXClientErrorCodeAllBody body) throws Exception
describeImageXClientErrorCodeAll
查询错误码分布
本接口支持通过指定查询维度,来获取客户端状态监控的错误码分布数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientLoadDurationRes describeImageXClientLoadDuration(DescribeImageXClientLoadDurationBody body) throws Exception
describeImageXClientLoadDuration
查询加载耗时时序数据
本接口支持通过指定查询维度,来获取客户端状态监控的加载耗时时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientLoadDurationAllRes describeImageXClientLoadDurationAll(DescribeImageXClientLoadDurationAllBody body) throws Exception
describeImageXClientLoadDurationAll
查询加载耗时分布
本接口支持通过指定查询维度,来获取客户端状态监控的加载耗时分布数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientSdkVerByTimeRes describeImageXClientSdkVerByTime(DescribeImageXClientSdkVerByTimeBody body) throws Exception
describeImageXClientSdkVerByTime
查询 SDK 版本变化趋势
本接口支持通过指定查询维度,来获取客户端状态监控的 SDK 版本变化趋势数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientFileSizeRes describeImageXClientFileSize(DescribeImageXClientFileSizeBody body) throws Exception
describeImageXClientFileSize
查询文件大小分布
本接口支持通过指定查询维度,来获取客户端状态监控的文件大小分布数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientTopFileSizeRes describeImageXClientTopFileSize(DescribeImageXClientTopFileSizeBody body) throws Exception
describeImageXClientTopFileSize
查询文件大小 TOP URL
本接口支持通过指定查询维度,来获取客户端状态监控的文件大小 TOP URL。
body - body payloadException - error during requestpublic DescribeImageXClientCountByTimeRes describeImageXClientCountByTime(DescribeImageXClientCountByTimeBody body) throws Exception
describeImageXClientCountByTime
查询客户端上报量
本接口支持通过指定查询维度,来获取客户端状态监控的客户端上报量数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientQualityRateByTimeRes describeImageXClientQualityRateByTime(DescribeImageXClientQualityRateByTimeBody body) throws Exception
describeImageXClientQualityRateByTime
查询黑白屏率时序数据
本接口支持通过指定查询维度,来获取客户端状态监控的黑白屏率时序数据。
:::tip
- 单次查询的时间跨度不能超过 **90** 天。
- 黑白屏监控指客户端解码后出现纯黑、纯白、透明图占上报图片总数量的比例。
:::
body - body payloadException - error during requestpublic DescribeImageXClientTopQualityURLRes describeImageXClientTopQualityURL(DescribeImageXClientTopQualityURLBody body) throws Exception
describeImageXClientTopQualityURL
查询黑白屏 TOP URL
本接口支持通过指定查询维度,来获取客户端状态监控的黑白屏 Top URL 数据明细。
body - body payloadException - error during requestpublic DescribeImageXClientDemotionRateByTimeRes describeImageXClientDemotionRateByTime(DescribeImageXClientDemotionRateByTimeBody body) throws Exception
describeImageXClientDemotionRateByTime
查询降级率时序数据
本接口支持通过指定查询维度,来获取客户端状态监控的处理降级成功率时序数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXClientTopDemotionURLRes describeImageXClientTopDemotionURL(DescribeImageXClientTopDemotionURLBody body) throws Exception
describeImageXClientTopDemotionURL
查询降级率 TOP URL
本接口支持通过指定查询维度,来获取客户端状态监控的降级率 TOP URL 数据明细。
body - body payloadException - error during requestpublic DescribeImageXClientScoreByTimeRes describeImageXClientScoreByTime(DescribeImageXClientScoreByTimeBody body) throws Exception
describeImageXClientScoreByTime
查询画质评估时序数据
本接口支持通过指定查询时间段和时间粒度,获取画质评估上报数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXSensibleCountByTimeRes describeImageXSensibleCountByTime(DescribeImageXSensibleCountByTimeBody body) throws Exception
describeImageXSensibleCountByTime
查询采集样本量
本接口支持查询感知指标采集样本量数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXSensibleCacheHitRateByTimeRes describeImageXSensibleCacheHitRateByTime(DescribeImageXSensibleCacheHitRateByTimeBody body) throws Exception
describeImageXSensibleCacheHitRateByTime
查询内存/磁盘命中率
本接口支持查询感知指标内存/磁盘命中率数据。
:::tip
单次查询的时间跨度不能超过 **90** 天。
:::
body - body payloadException - error during requestpublic DescribeImageXSensibleTopSizeURLRes describeImageXSensibleTopSizeURL(DescribeImageXSensibleTopSizeURLBody body) throws Exception
describeImageXSensibleTopSizeURL
查询大图文件体积 Top URL
本接口支持查询大图文件体积 Top URL 数据。
body - body payloadException - error during requestpublic DescribeImageXSensibleTopResolutionURLRes describeImageXSensibleTopResolutionURL(DescribeImageXSensibleTopResolutionURLBody body) throws Exception
describeImageXSensibleTopResolutionURL
查询大图文件分辨率 Top URL
本接口支持查询大图文件分辨率 Top URL 数据。
body - body payloadException - error during requestpublic DescribeImageXSensibleTopRamURLRes describeImageXSensibleTopRamURL(DescribeImageXSensibleTopRamURLBody body) throws Exception
describeImageXSensibleTopRamURL
查询大图文件内存 Top URL
本接口支持查询大图文件内存 Top URL 数据。
body - body payloadException - error during requestpublic DescribeImageXSensibleTopUnknownURLRes describeImageXSensibleTopUnknownURL(DescribeImageXSensibleTopUnknownURLBody body) throws Exception
describeImageXSensibleTopUnknownURL
查询大图文件未知原因 TOP URL
本接口查询大图文件未知原因 Top URL 列表。
body - body payloadException - error during requestpublic CreateBatchProcessTaskRes createBatchProcessTask(CreateBatchProcessTaskQuery query, CreateBatchProcessTaskBody body) throws Exception
createBatchProcessTask
创建批量处理异步任务
创建批量处理异步任务
query - query argumentsbody - body payloadException - error during requestpublic GetBatchProcessResultRes getBatchProcessResult(GetBatchProcessResultQuery query, GetBatchProcessResultBody body) throws Exception
getBatchProcessResult
同步批量处理
同步批量处理
query - query argumentsbody - body payloadException - error during requestpublic GetBatchTaskInfoRes getBatchTaskInfo(GetBatchTaskInfoQuery query) throws Exception
getBatchTaskInfo
查询异步批量处理任务详情
查询异步批量处理任务详情
query - query argumentsException - error during requestpublic AIProcessRes aIProcess(AIProcessBody body) throws Exception
aIProcess
AI图像处理
提交一条 URL 或 URI 资源执行同步 AI 图像处理任务。
body - body payloadException - error during requestpublic CreateImageAITaskRes createImageAITask(CreateImageAITaskBody body) throws Exception
createImageAITask
创建离线AI图像处理任务
提交一条或多条 URL 或 URI 资源执行异步 AI 图像处理任务。
body - body payloadException - error during requestpublic GetImageAITasksRes getImageAITasks(GetImageAITasksQuery query) throws Exception
getImageAITasks
获取离线AI图像处理任务
查询指定队列下提交的各个 AI 图像处理任务的执行信息。
:::tip
解析返回参数时,需要根据 `workflow_template_id` 的值来解析,以免解析失败。
:::
query - query argumentsException - error during requestpublic GetImageAIDetailsRes getImageAIDetails(GetImageAIDetailsQuery query) throws Exception
getImageAIDetails
获取离线AI图像处理任务执行详情
指定任务 ID,查询 AI 图像处理任务的执行详情。
:::tip
- 仅支持查询结束时间在近 7 天的处理任务。
- 解析返回参数时,需要根据 `workflow_template_id` 的值来解析,以免解析失败。
:::
query - query argumentsException - error during requestpublic UpdateImageResourceStatusRes updateImageResourceStatus(UpdateImageResourceStatusQuery query, UpdateImageResourceStatusBody body) throws Exception
updateImageResourceStatus
修改上传文件状态
本接口支持修改指定服务下资源的封禁状态。
:::tip
若您在封禁服务`ServiceId`开启了[重名覆盖上传](https://www.volcengine.com/docs/508/1119912),当封禁的资源被上传的重名文件覆盖后,该资源的封禁状态会重置为正常。
:::
query - query argumentsbody - body payloadException - error during requestpublic UpdateFileStorageClassRes updateFileStorageClass(UpdateFileStorageClassQuery query, UpdateFileStorageClassBody body) throws Exception
updateFileStorageClass
修改文件存储类型
本接口支持修改单个文件的存储类型。
query - query argumentsbody - body payloadException - error during requestpublic GetImageStorageFilesRes getImageStorageFiles(GetImageStorageFilesQuery query) throws Exception
getImageStorageFiles
列举服务下的文件
本接口列举并返回服务对应存储下的全量资源,并按照 `Key` 的字典序返回。列举资源包括您自行上传的资源,以及您开通持久化后 veImageX 通过服务持久化存储的资源。
query - query argumentsException - error during requestpublic DeleteImageUploadFilesRes deleteImageUploadFiles(DeleteImageUploadFilesQuery query, DeleteImageUploadFilesBody body) throws Exception
deleteImageUploadFiles
删除服务下多个文件
通过指定服务 ID 以及文件 URI 列表来删除指定的文件,并返回成功删除的文件 URI 以及文件不存在的无效 URI。
query - query argumentsbody - body payloadException - error during requestpublic CreateFileRestoreRes createFileRestore(CreateFileRestoreQuery query, CreateFileRestoreBody body) throws Exception
createFileRestore
恢复文件
恢复文件
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageUploadFilesRes updateImageUploadFiles(UpdateImageUploadFilesQuery query, UpdateImageUploadFilesBody body) throws Exception
updateImageUploadFiles
指定服务下多个文件URL状态
指定服务下多个文件URL状态
query - query argumentsbody - body payloadException - error during requestpublic CommitImageUploadRes commitImageUpload(CommitImageUploadQuery query, CommitImageUploadBody body) throws Exception
commitImageUpload
文件上传完成上报
本接口用于确认文件上传到 veImageX 的结果。确认文件上传成功,并向您返回上传结果。具体上传流程请参考[服务端上传](https://www.volcengine.com/docs/508/477196#%E6%9C%8D%E5%8A%A1%E7%AB%AF%E4%B8%8A%E4%BC%A0)。
:::tip
强烈不建议您依赖本接口返回的图片 meta 信息,有获取 meta 需求推荐在上传完成后拼接`~info`模板获取[图片 meta 信息](https://www.volcengine.com/docs/508/64085)。原因请见[为什么不建议依赖 Commit 阶段返回的图片 meta 信息?](https://www.volcengine.com/docs/508/477196#%E4%B8%BA%E4%BB%80%E4%B9%88%E4%B8%8D%E5%BB%BA%E8%AE%AE%E4%BE%9D%E8%B5%96-commit-%E9%98%B6%E6%AE%B5%E8%BF%94%E5%9B%9E%E7%9A%84%E5%9B%BE%E7%89%87-meta-%E4%BF%A1%E6%81%AF%EF%BC%9F)
:::
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageFileCTRes updateImageFileCT(UpdateImageFileCTQuery query, UpdateImageFileCTBody body) throws Exception
updateImageFileCT
更新文件的存储content-type
本接口支持更新指定服务下文件的 Content-Type 值。
query - query argumentsbody - body payloadException - error during requestpublic ApplyVpcUploadInfoRes applyVpcUploadInfo(ApplyVpcUploadInfoQuery query) throws Exception
applyVpcUploadInfo
获取文件Vpc内网上传地址
本接口用于指定内网上传文件信息,并获取文件上传链接和 Header 信息。成功获取到上述信息后,按照链接及 Header 进行请求即可完成上传。
query - query argumentsException - error during requestpublic ApplyImageUploadRes applyImageUpload(ApplyImageUploadQuery query) throws Exception
applyImageUpload
获取文件上传地址
本接口用于指定上传文件信息,并获取文件上传地址和凭证。成功获取到上传地址和凭证后,使用[公网域名](https://www.volcengine.com/docs/508/477196#%E4%B8%8A%E4%BC%A0%E7%9B%B8%E5%85%B3%E5%9F%9F%E5%90%8D)上传您指定的文件二进制数据,对返回的上传地址发起 PUT 请求上传文件。(**可选操作**:通过调用 [CommitImageUpload](https://www.volcengine.com/docs/508/9398) 接口,确认文件上传并获取上报上传结果。)
推荐您使用[服务端 SDK](https://www.volcengine.com/docs/508/9397#%E6%9C%8D%E5%8A%A1%E7%AB%AF-sdk) 进行文件上传,具体上传流程请参考[服务端上传](https://www.volcengine.com/docs/508/477196#%E6%9C%8D%E5%8A%A1%E7%AB%AF%E4%B8%8A%E4%BC%A0)。
:::tip
强烈不建议您依赖 [CommitImageUpload](https://www.volcengine.com/docs/508/9398) 返回的图片 meta 信息,有获取 meta 需求推荐在上传完成后拼接`~info`模板获取[图片 meta 信息](https://www.volcengine.com/docs/508/64085)。原因请见[为什么不建议依赖 Commit 阶段返回的图片 meta 信息?](https://www.volcengine.com/docs/508/477196#%E4%B8%BA%E4%BB%80%E4%B9%88%E4%B8%8D%E5%BB%BA%E8%AE%AE%E4%BE%9D%E8%B5%96-commit-%E9%98%B6%E6%AE%B5%E8%BF%94%E5%9B%9E%E7%9A%84%E5%9B%BE%E7%89%87-meta-%E4%BF%A1%E6%81%AF%EF%BC%9F)
:::
query - query argumentsException - error during requestpublic GetImageUploadFileRes getImageUploadFile(GetImageUploadFileQuery query) throws Exception
getImageUploadFile
获取服务下单个上传文件
通过指定服务 ID 以及已上传的文件 Uri,来获取上传文件的详细信息,如:文件修改时间和文件字节数等。
query - query argumentsException - error during requestpublic GetImageUploadFilesRes getImageUploadFiles(GetImageUploadFilesQuery query) throws Exception
getImageUploadFiles
获取服务下的上传文件
通过指定服务 ID,获取当前服务下的上传文件信息。
:::tip
最多可返回 100 条上传文件信息。
:::
query - query argumentsException - error during requestpublic GetImageUpdateFilesRes getImageUpdateFiles(GetImageUpdateFilesQuery query) throws Exception
getImageUpdateFiles
获取服务下的更新文件
本接口支持查询某服务下指定条件(刷新/禁用)的文件 URL 列表详情。
query - query argumentsException - error during requestpublic PreviewImageUploadFileRes previewImageUploadFile(PreviewImageUploadFileQuery query) throws Exception
previewImageUploadFile
预览服务下的文件
本接口支持获取指定服务下存储文件的详细信息。
query - query argumentsException - error during requestpublic GetImageEraseResultRes getImageEraseResult(GetImageEraseResultBody body) throws Exception
getImageEraseResult
使用图像修复获取结果图
本接口支持通过指定服务 ID 、待擦除的图片地址以及擦除模型,得到擦除后的图片 URI。
body - body payloadException - error during requestpublic GetImageServiceRes getImageService(GetImageServiceQuery query) throws Exception
getImageService
获取单个服务信息
本接口支持通过指定服务 ID,获取对应服务的详情,如:服务名称、服务地域和服务类型等信息。
query - query argumentsException - error during requestpublic GetAllImageServicesRes getAllImageServices(GetAllImageServicesQuery query) throws Exception
getAllImageServices
获取所有服务信息
本接口支持获取当前火山账号下创建的所有 veImageX 图片服务信息。
query - query argumentsException - error during requestpublic CreateImageCompressTaskRes createImageCompressTask(CreateImageCompressTaskQuery query, CreateImageCompressTaskBody body) throws Exception
createImageCompressTask
创建多文件压缩异步任务
本接口支持将指定的若干文件进行压缩并打包为 ZIP 包,并将结果上传至指定服务。同时,在打包的过程中,支持对各文件重命名,以及自定义压缩规则与压缩包名称。支持以下两种待压缩文件提交方式:
- 方式 1:[FlieList 方式](https://www.volcengine.com/docs/508/1112504#filelist):需配置公网可访问的待压缩文件 URL 与 Alias,Folder 配置,不得超过 3000。
- 方式 2:[IndexFile 方式](https://www.volcengine.com/docs/508/1112504#indexfile):在 .txt 文件(索引文件)内填写待压缩文件相关配置,每行需填写 `StoreUri/URL,Alias,Folder`相关配置 ,并将该索引文件上传至指定服务,并获取索引文件 StoreUri。
- 如果填写待压缩文件的 URL,则需满足公网可访问。您可下载 Compress\_StoreUri.txt 参考示例,完成 URL 类型索引文件的填写。
- 如果填写带压缩文件的 StoreUri,则需存储至指定服务。您可下载 Compress\_StoreUri.txt 参考示例,完成 StoreUri 类型索引文件的填写。
:::tip
压缩文件类型不支持混用。
:::
query - query argumentsbody - body payloadException - error during requestpublic FetchImageUrlRes fetchImageUrl(FetchImageUrlBody body) throws Exception
fetchImageUrl
数据抓取
本接口通过指定一个公网可访问的待迁移资源 URL 以及上传目标服务 ID 等信息,来对资源进行抓取和上传,并得到迁移后的资源存储 URI 等信息。
:::tip
- 如果您的数据在本地 IDC 或者在本地磁盘中,同时通过本地服务器挂载云存储的资源迁移 veImageX 存储,推荐您使用[本地迁移与上传工具](https://www.volcengine.com/docs/508/67066)进行数据迁移。
- 如果您的数据位于第三方云厂商或有可公网访问的 URL 本地数据,您可以登录 veImageX 使用[数据迁移](https://www.volcengine.com/docs/508/76309)功能迁移您的数据至 veImageX 存储。
:::
body - body payloadException - error during requestpublic UpdateImageStorageTTLRes updateImageStorageTTL(UpdateImageStorageTTLBody body) throws Exception
updateImageStorageTTL
更新服务存储有效期
本接口支持更新指定服务的存储有效期。若资源有效期到期,veImageX 将自动删除指定服务内的资源,减少您的存储成本。
body - body payloadException - error during requestpublic GetCompressTaskInfoRes getCompressTaskInfo(GetCompressTaskInfoQuery query) throws Exception
getCompressTaskInfo
获取异步压缩任务详情
本接口支持通过指定服务 ID 和异步压缩任务 ID 获取压缩任务详情。
query - query argumentsException - error during requestpublic GetUrlFetchTaskRes getUrlFetchTask(GetUrlFetchTaskQuery query) throws Exception
getUrlFetchTask
获取异步抓取任务详情
本接口支持通过异步任务 ID,获取异步任务详情,包括:任务状态、资源地址和任务失败时回调详情。
query - query argumentsException - error during requestpublic GetResourceURLRes getResourceURL(GetResourceURLQuery query) throws Exception
getResourceURL
获取资源URL
本接口支持获取指定服务下单个文件的原文件访问地址,若指定模板,可获取模板处理后结果图访问地址。
query - query argumentsException - error during requestpublic CreateImageFromUriRes createImageFromUri(CreateImageFromUriQuery query, CreateImageFromUriBody body) throws Exception
createImageFromUri
资源迁移
本接口支持将源服务`OriServiceId`内的存储资源,复制到目标服务`ServiceId`。
:::warning
- 源服务与目标服务需所属同一个火山引擎账号,所属地域需保持一致。
- 归档与冷归档文件需[恢复资源](https://www.volcengine.com/docs/508/1205056)后,才能复制。
:::
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageFileKeyRes updateImageFileKey(UpdateImageFileKeyQuery query, UpdateImageFileKeyBody body) throws Exception
updateImageFileKey
重命名文件
本接口支持通过指定源文件的 storekey 来对指定文件进行重命名操作。
query - query argumentsbody - body payloadException - error during requestpublic CreateImageContentTaskRes createImageContentTask(CreateImageContentTaskBody body) throws Exception
createImageContentTask
创建刷新预热禁用解禁任务
本接口支持创建一个内容管理任务(包括刷新 URL、刷新目录(包含根目录)、预热 URL、禁用 URL 以及解禁 URL)。
body - body payloadException - error during requestpublic GetImageContentTaskDetailRes getImageContentTaskDetail(GetImageContentTaskDetailBody body) throws Exception
getImageContentTaskDetail
获取任务详情
本接口支持查询近 30 天内内容管理任务详情列表。
body - body payloadException - error during requestpublic GetImageContentBlockListRes getImageContentBlockList(GetImageContentBlockListBody body) throws Exception
getImageContentBlockList
获取禁用 URL 列表详情
本接口支持获取近 30 天内的已被禁用的 URL 列表详情,若 URL 解禁成功,则无法被查询。
body - body payloadException - error during requestpublic CreateImageTranscodeQueueRes createImageTranscodeQueue(CreateImageTranscodeQueueBody body) throws Exception
createImageTranscodeQueue
创建任务队列
本接口支持在该账号创建离线转码任务队列,并自定义队列配置,如队列名称、队列描述、回调配置等。
body - body payloadException - error during requestpublic DeleteImageTranscodeQueueRes deleteImageTranscodeQueue(DeleteImageTranscodeQueueBody body) throws Exception
deleteImageTranscodeQueue
删除任务队列
该接口支持通过指定待删除的任务队列 ID 在账号内删除该任务队列。
:::warning
每个账号内置的一个默认任务队列不允许被删除。
:::
body - body payloadException - error during requestpublic UpdateImageTranscodeQueueRes updateImageTranscodeQueue(UpdateImageTranscodeQueueBody body) throws Exception
updateImageTranscodeQueue
更新任务队列配置
本接口支持对已创建任务队列更新其离线转码配置,如队列名称、队列描述和回调配置等。
body - body payloadException - error during requestpublic UpdateImageTranscodeQueueStatusRes updateImageTranscodeQueueStatus(UpdateImageTranscodeQueueStatusBody body) throws Exception
updateImageTranscodeQueueStatus
更新任务队列状态
该接口支持通过指定待更新的任务队列 ID 来更新该队列的状态。
body - body payloadException - error during requestpublic GetImageTranscodeQueuesRes getImageTranscodeQueues(GetImageTranscodeQueuesQuery query) throws Exception
getImageTranscodeQueues
获取任务队列
本接口支持获取当前账号下已创建的任务队列详情。
query - query argumentsException - error during requestpublic CreateImageTranscodeTaskRes createImageTranscodeTask(CreateImageTranscodeTaskBody body) throws Exception
createImageTranscodeTask
提交转码任务
本接口支持向状态为运行中的任务队列,提交以一条或多条 URL/URI 资源转码执行任务组成的转码任务。
:::tip
- 仅当队列为运行中时可向该队列提交任务,请您在控制台或调用 [GetImageTranscodeQueues](https://www.volcengine.com/docs/508/1107341) 接口查看任务队列状态是否为运行中。
- 一条任务队列(QueueId)可包含多个转码任务(TaskId),一个转码任务可由一条或多条 URL/URI 转码执行任务(EntryId)组成。
:::
body - body payloadException - error during requestpublic GetImageTranscodeDetailsRes getImageTranscodeDetails(GetImageTranscodeDetailsQuery query) throws Exception
getImageTranscodeDetails
获取任务执行详情
本接口支持您通过指定任务队列 ID 和查询时间段获取当前队列的转码任务详情。
:::tip
仅支持保存并查询任务结束时间在近 7 天的处理任务。
:::
query - query argumentsException - error during requestpublic CreateImageTranscodeCallbackRes createImageTranscodeCallback(CreateImageTranscodeCallbackBody body) throws Exception
createImageTranscodeCallback
手动触发回调
本接口支持通过指定任务条目 ID,手动向该任务队列配置的回调 URL 发送回调信息。回调内容及错误请参考[离线转码说明](https://www.volcengine.com/docs/508/1104726)。
body - body payloadException - error during requestpublic DeleteImageTranscodeDetailRes deleteImageTranscodeDetail(DeleteImageTranscodeDetailBody body) throws Exception
deleteImageTranscodeDetail
删除任务执行详情
本接口支持通过指定任务条目 ID,删除提交任务内对应的该条 URL/URI。
body - body payloadException - error during requestpublic GetImagePSDetectionRes getImagePSDetection(GetImagePSDetectionQuery query, GetImagePSDetectionBody body) throws Exception
getImagePSDetection
使用PS检测获取结果值
本接口支持通过指定服务 ID 以及原图 URI,检测图片是否被人为的 PS 修改,获取图片检测分值以及是否为正常图片。
:::tip
当前仅适用于营业执照类图像检测场景,其他图像检测类型还在持续开发中,敬请期待。
:::
query - query argumentsbody - body payloadException - error during requestpublic GetImageSuperResolutionResultRes getImageSuperResolutionResult(GetImageSuperResolutionResultBody body) throws Exception
getImageSuperResolutionResult
使用图像超分辨率获取结果图
本接口支持通过输入待处理图像地址,经超分处理后得到处理后的图片 URI。
body - body payloadException - error during requestpublic GetDenoisingImageRes getDenoisingImage(GetDenoisingImageQuery query, GetDenoisingImageBody body) throws Exception
getDenoisingImage
使用图像降噪获取结果图
本接口支持通过指定服务 ID 以及降噪配置,获取降噪结果图。
query - query argumentsbody - body payloadException - error during requestpublic GetImageDuplicateDetectionRes getImageDuplicateDetection(GetImageDuplicateDetectionQuery query, GetImageDuplicateDetectionBody body) throws Exception
getImageDuplicateDetection
使用图片去重获取结果值
本接口支持通过对图片的特征提取、特征比较、相似度计算,获取相似度分值和相似图片分组。
:::tip
* 支持同步或异步去重,如果输入两张以上图片推荐您使用异步去重处理。
* 如果使用异步去重,则最终去重的图片评分以及图片分组结果请调用 [GetDedupTaskStatus](https://www.volcengine.com/docs/508/138909)接口查看。
:::
query - query argumentsbody - body payloadException - error during requestpublic GetImageOCRV2Res getImageOCRV2(GetImageOCRV2Query query, GetImageOCRV2Body body) throws Exception
getImageOCRV2
使用文字识别 OCR 获取识别信息
本接口支持通过指定服务 ID 以及图片识别场景,获取该场景下图片的识别结果等信息。
query - query argumentsbody - body payloadException - error during requestpublic GetImageBgFillResultRes getImageBgFillResult(GetImageBgFillResultBody body) throws Exception
getImageBgFillResult
使用智能图像扩展获取结果图
本接口支持通过指定服务 ID、原图地址以及智能图像扩展模型,得到处理后的结果图 URI。
body - body payloadException - error during requestpublic GetSegmentImageRes getSegmentImage(GetSegmentImageQuery query, GetSegmentImageBody body) throws Exception
getSegmentImage
使用智能背景移除获取结果图
针对上传的静图,支持去除上传图像背景,获取图像主体并设置主体轮廓描边的相关配置,如描边颜色、描边宽度。
query - query argumentsbody - body payloadException - error during requestpublic GetImageSmartCropResultRes getImageSmartCropResult(GetImageSmartCropResultBody body) throws Exception
getImageSmartCropResult
使用智能裁剪获取结果图
本接口支持指定服务 ID 以及原图地址,经智能裁剪后得到处理后的图片 URI。
body - body payloadException - error during requestpublic GetImageComicResultRes getImageComicResult(GetImageComicResultBody body) throws Exception
getImageComicResult
使用漫画风获取结果图
通过指定服务 ID 以及待处理图片,获取漫画风处理后结果图地址。
body - body payloadException - error during requestpublic GetImageEnhanceResultRes getImageEnhanceResult(GetImageEnhanceResultBody body) throws Exception
getImageEnhanceResult
使用画质增强获取结果图
本接口支持指定服务 ID、原图地址和画质增强模型,提升原图画质后获取结果图 URI。
:::tip
您也可以通过调用 [GetImageEnhanceResultWithData](https://www.volcengine.com/docs/508/475346) 输入图片二进制数据,来获取经画质增强能力编码后的图片二进制数据。
:::
body - body payloadException - error during requestpublic GetImageQualityRes getImageQuality(GetImageQualityQuery query, GetImageQualityBody body) throws Exception
getImageQuality
使用画质评估获取分值
本接口支持指定服务 ID 和原图地址后对该图像的主客观画质和美学维度进行评分,并获取该图片各维度评分结果。具体图片维度说明以及分值含义请参考下方参数说明。
query - query argumentsbody - body payloadException - error during requestpublic GetLicensePlateDetectionRes getLicensePlateDetection(GetLicensePlateDetectionQuery query, GetLicensePlateDetectionBody body) throws Exception
getLicensePlateDetection
使用车牌检测获取车牌位置
本接口支持通过指定服务 ID 和原图 URI,获取该图片上所有检测到的车牌位置坐标。
query - query argumentsbody - body payloadException - error during requestpublic GetPrivateImageTypeRes getPrivateImageType(GetPrivateImageTypeQuery query, GetPrivateImageTypeBody body) throws Exception
getPrivateImageType
使用隐私分类获取分类信息
本接口支持通过指定服务 ID 以及原图 URI,获取该图片的隐私分类结果信息。
query - query argumentsbody - body payloadException - error during requestpublic CreateCVImageGenerateTaskRes createCVImageGenerateTask(CreateCVImageGenerateTaskQuery query, CreateCVImageGenerateTaskBody body) throws Exception
createCVImageGenerateTask
创建文生图异步任务
该接口支持调用豆包大模型中的智能生图 API 能力,并根据豆包模型请求信息生成相应图片。同时您可指定 veIamgeX 的图片处理模板,对文生图进行定制化的图片处理。
query - query argumentsbody - body payloadException - error during requestpublic CreateHiddenWatermarkImageRes createHiddenWatermarkImage(CreateHiddenWatermarkImageQuery query, CreateHiddenWatermarkImageBody body) throws Exception
createHiddenWatermarkImage
创建盲水印前背景图层
本接口支持生成含有盲水印的 png 格式透明图(前景水印图层)。在实际使用中,您需要将该图层无缩放且平铺至您的网页顶层,从而实现给网页添加盲水印的目的。适用于纯色或彩色背景网页被截图外发后,对截图者进行身份溯源的场景。
:::warning
- 提取水印时,若直接提供本接口返回的 PNG 前景水印图层,将无法提取出水印内容。请**务必**提供已融合盲水印透明图的背景网页的**截图**。
- 为了确保能够正常提取截图中的水印,请**不要**对生成的盲水印 PNG 背景图层执行其他图片处理操作。
:::
query - query argumentsbody - body payloadException - error during requestpublic CreateHmExtractTaskRes createHmExtractTask(CreateHmExtractTaskQuery query, CreateHmExtractTaskBody body) throws Exception
createHmExtractTask
创建盲水印异步提取任务
本接口支持指定服务以及提取源图片,获取该图片中的盲水印信息。
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageExifDataRes updateImageExifData(UpdateImageExifDataQuery query, UpdateImageExifDataBody body) throws Exception
updateImageExifData
图片EXIF数据修改
本接口支持同步新增、删除和修改 JPEG/PNG/WEBP/HEIC/AVIF 格式的静图 EXIF 数据。
:::tip
您可参考[查询图片 meta 信息](https://www.volcengine.com/docs/508/64085),获取图片中存在的 EXIF 信息。
:::
query - query argumentsbody - body payloadException - error during requestpublic GetImageDetectResultRes getImageDetectResult(GetImageDetectResultQuery query, GetImageDetectResultBody body) throws Exception
getImageDetectResult
图片内容检测
本接口支持检测指定服务下的图片中的人脸数据并返回对应坐标值。
query - query argumentsbody - body payloadException - error during requestpublic GetCVImageGenerateResultRes getCVImageGenerateResult(GetCVImageGenerateResultQuery query, GetCVImageGenerateResultBody body) throws Exception
getCVImageGenerateResult
图生图
该接口支持调用豆包大模型中的智能生图 API 能力,并根据豆包模型请求信息生成相应的一张图片。同时您可指定 veIamgeX 的图片处理模板,对智能生成的图片进行进一步的个性化图片处理,获取同步输出的结果图 URI。
query - query argumentsbody - body payloadException - error during requestpublic CreateImageHmExtractRes createImageHmExtract(CreateImageHmExtractQuery query) throws Exception
createImageHmExtract
提取盲水印
本接口支持指定服务以及提取源图片,获取该图片中的盲水印信息。
:::warning
- 对同一张图片,请确保在提取水印时指定的模型,与添加水印时指定的模型为同一种,以免无法正常提取水印。
- 在诸如电子邮件附件、社交媒体平台(如 Facebook、Instagram)、实时通讯应用(如微信)等传输媒介中传输图片时往往会自动压缩图片的分辨率,此时,图片水印也可能无法正常提取。
- 相比同步提取,异步提取盲水印的成功率更高,优先推荐您使用[异步提取功能](https://www.volcengine.com/docs/508/1554729)。
:::
query - query argumentsException - error during requestpublic GetCVTextGenerateImageRes getCVTextGenerateImage(GetCVTextGenerateImageQuery query, GetCVTextGenerateImageBody body) throws Exception
getCVTextGenerateImage
文生图
该接口支持调用豆包大模型中的智能生图 API 能力,并根据豆包模型请求信息生成相应的一张图片。同时您可指定 veImageX 的图片处理模板,对智能生成的图片进行进一步的个性化图片处理,并同步输出结果图。
query - query argumentsbody - body payloadException - error during requestpublic GetCVImageGenerateTaskRes getCVImageGenerateTask(GetCVImageGenerateTaskQuery query, GetCVImageGenerateTaskBody body) throws Exception
getCVImageGenerateTask
查询文生图任务
本接口支持获取文生图异步任务生成的结果图 Url。
query - query argumentsbody - body payloadException - error during requestpublic CreateImageHmEmbedRes createImageHmEmbed(CreateImageHmEmbedBody body) throws Exception
createImageHmEmbed
添加盲水印
本接口支持指定服务以及原图后,将自定义的文字盲水印等信息嵌入原图并获取结果图 Uri。
body - body payloadException - error during requestpublic GetCVAnimeGenerateImageRes getCVAnimeGenerateImage(GetCVAnimeGenerateImageQuery query, GetCVAnimeGenerateImageBody body) throws Exception
getCVAnimeGenerateImage
漫画文/图生图
该接口支持调用豆包大模型中的智能生图 API 能力,并根据豆包模型请求信息生成相应的一张图片。同时您可指定 veIamgeX 的图片处理模板,对智能生成的图片进行进一步的个性化图片处理,获取同步输出的结果图 URI。
query - query argumentsbody - body payloadException - error during requestpublic GetComprehensiveEnhanceImageRes getComprehensiveEnhanceImage(GetComprehensiveEnhanceImageBody body) throws Exception
getComprehensiveEnhanceImage
综合增强
本接口支持通过指定服务 ID 、原图地址和综合增强配置,获取处理后结果图 URI。
body - body payloadException - error during requestpublic GetImageAiGenerateTaskRes getImageAiGenerateTask(GetImageAiGenerateTaskQuery query) throws Exception
getImageAiGenerateTask
获取 AIGC 异步任务详情
本接口支持通过任务 ID 获取 AIGC 任务详情。
query - query argumentsException - error during requestpublic GetProductAIGCResultRes getProductAIGCResult(GetProductAIGCResultQuery query, GetProductAIGCResultBody body) throws Exception
getProductAIGCResult
获取AIGC图片
通过文本描述或场景图引导的方式,使用 AIGC 智能算法对输入的商品主体图进行智能场景扩展,助力商家和电商平台批量产出媲美专业设计师的高质素材,单图产出时间 < 1 分钟,能有效提升商品图的素材生产效率。
- **商品场景图**:支持通过预设场景或文字描述等多种方式,为商品添加丰富背景,自然的光影融合效果结合细腻的写实画面,还原真实使用场景。
- **商品卖点图**:支持输入商品简述、评论和商品详情页图像等信息,AI 提取商品核心卖点并合成商品卖点图。
示例:
| 原图 | 商品图 |
| --- | --- |
|
|
|
query - query argumentsbody - body payloadException - error during requestpublic GetImageEraseModelsRes getImageEraseModels(GetImageEraseModelsQuery query) throws Exception
getImageEraseModels
获取图像修复列表详情
本接口支持获取图像修复模型列表信息。
query - query argumentsException - error during requestpublic GetDedupTaskStatusRes getDedupTaskStatus(GetDedupTaskStatusQuery query) throws Exception
getDedupTaskStatus
获取异步去重任务详情
本接口支持通过指定异步去重任务 ID 获取对应异步去重任务执行详细情况。
query - query argumentsException - error during requestpublic GetImageHmExtractTaskInfoRes getImageHmExtractTaskInfo(GetImageHmExtractTaskInfoQuery query, GetImageHmExtractTaskInfoBody body) throws Exception
getImageHmExtractTaskInfo
获取异步提取任务的信息
指定任务 ID,获取提交盲水印异步提取任务的执行信息。
query - query argumentsbody - body payloadException - error during requestpublic CreateImageServiceRes createImageService(CreateImageServiceBody body) throws Exception
createImageService
创建服务
通过指定服务名称、服务区域以及域名来创建一个图片服务,并得到返回的服务名称和服务 ID。
body - body payloadException - error during requestpublic DeleteImageServiceRes deleteImageService(DeleteImageServiceQuery query) throws Exception
deleteImageService
删除服务
通过输入服务 ID 来删除对应的图片服务。
query - query argumentsException - error during requestpublic UpdateImageAuthKeyRes updateImageAuthKey(UpdateImageAuthKeyQuery query, UpdateImageAuthKeyBody body) throws Exception
updateImageAuthKey
更新主备鉴权Key
本接口支持更新指定服务 ID 下的主备鉴权 Key,来修改鉴权信息。
query - query argumentsbody - body payloadException - error during requestpublic UpdateResEventRuleRes updateResEventRule(UpdateResEventRuleQuery query, UpdateResEventRuleBody body) throws Exception
updateResEventRule
更新事件通知规则
本接口支持指定服务 ID 更新该服务的事件通知规则。
query - query argumentsbody - body payloadException - error during requestpublic UpdateServiceNameRes updateServiceName(UpdateServiceNameQuery query, UpdateServiceNameBody body) throws Exception
updateServiceName
更新服务名称
本接口支持修改指定服务 ID 的服务名称。
query - query argumentsbody - body payloadException - error during requestpublic UpdateStorageRulesRes updateStorageRules(UpdateStorageRulesQuery query, UpdateStorageRulesBody body) throws Exception
updateStorageRules
更新服务存储策略
本接口支持更新指定服务的存储策略。
query - query argumentsbody - body payloadException - error during requestpublic UpdateStorageRulesV2Res updateStorageRulesV2(UpdateStorageRulesV2Query query, UpdateStorageRulesV2Body body) throws Exception
updateStorageRulesV2
更新服务存储策略V2
更新服务存储策略V2
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageObjectAccessRes updateImageObjectAccess(UpdateImageObjectAccessQuery query, UpdateImageObjectAccessBody body) throws Exception
updateImageObjectAccess
更新源地址访问配置
本接口更新指定服务 ID 下的源地址访问配置。
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageUploadOverwriteRes updateImageUploadOverwrite(UpdateImageUploadOverwriteQuery query, UpdateImageUploadOverwriteBody body) throws Exception
updateImageUploadOverwrite
更新重名覆盖上传配置
本接口支持更新指定服务的重名覆盖上传配置。
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageMirrorConfRes updateImageMirrorConf(UpdateImageMirrorConfQuery query, UpdateImageMirrorConfBody body) throws Exception
updateImageMirrorConf
更新镜像回源配置
根据服务 ID 以及输入的待更新的镜像回源配置详情,更新该服务的镜像回源配置。
:::tip
本接口全量更新配置,如果某个配置项为空,比如 Host 为空,接口会将对应的配置设为空。
:::
query - query argumentsbody - body payloadException - error during requestpublic GetImageServiceSubscriptionRes getImageServiceSubscription(GetImageServiceSubscriptionQuery query) throws Exception
getImageServiceSubscription
查询服务开通状态
本接口支持查询图片服务的开通状态详情,支持返回账号 ID、已购商品和已购商品配置等信息。
query - query argumentsException - error during requestpublic GetImageAuthKeyRes getImageAuthKey(GetImageAuthKeyQuery query) throws Exception
getImageAuthKey
获取主备鉴权Key
本接口支持获取指定服务 ID 配置的主备鉴权信息。
query - query argumentsException - error during requestpublic CreateImageAnalyzeTaskRes createImageAnalyzeTask(CreateImageAnalyzeTaskBody body) throws Exception
createImageAnalyzeTask
创建离线评估任务
本接口支持在指定服务下创建离线评估任务。
body - body payloadException - error during requestpublic DeleteImageAnalyzeTaskRunRes deleteImageAnalyzeTaskRun(DeleteImageAnalyzeTaskRunBody body) throws Exception
deleteImageAnalyzeTaskRun
删除任务执行记录
本接口支持对状态为**已结束**的离线画质评估任务删除指定的执行记录。
body - body payloadException - error during requestpublic DeleteImageAnalyzeTaskRes deleteImageAnalyzeTask(DeleteImageAnalyzeTaskBody body) throws Exception
deleteImageAnalyzeTask
删除离线评估任务
本接口支持删除一个指定的离线评估任务。
body - body payloadException - error during requestpublic UpdateImageAnalyzeTaskStatusRes updateImageAnalyzeTaskStatus(UpdateImageAnalyzeTaskStatusBody body) throws Exception
updateImageAnalyzeTaskStatus
更新离线画质任务状态
本接口支持更新指定的离线画质任务状态。
body - body payloadException - error during requestpublic UpdateImageAnalyzeTaskRes updateImageAnalyzeTask(UpdateImageAnalyzeTaskBody body) throws Exception
updateImageAnalyzeTask
更新离线评估任务配置
本接口支持通过指定任务 ID 更新配置。
body - body payloadException - error during requestpublic GetImageAnalyzeTasksRes getImageAnalyzeTasks(GetImageAnalyzeTasksQuery query) throws Exception
getImageAnalyzeTasks
获取离线评估任务列表
本接口支持查询全部的离线评估任务列表。
query - query argumentsException - error during requestpublic GetImageAnalyzeResultRes getImageAnalyzeResult(GetImageAnalyzeResultQuery query) throws Exception
getImageAnalyzeResult
获取离线评估任务结果
本接口支持获取指定离线评估任务结果。
query - query argumentsException - error during requestpublic DeleteImageElementsRes deleteImageElements(DeleteImageElementsBody body) throws Exception
deleteImageElements
删除常用图片/背景/蒙版要素
在样式的要素列表删除常用的图片、背景或蒙版等要素记录,如果删除失败将返回失败的要素 URI。
body - body payloadException - error during requestpublic DeleteImageBackgroundColorsRes deleteImageBackgroundColors(DeleteImageBackgroundColorsBody body) throws Exception
deleteImageBackgroundColors
删除常用颜色
通过输入待删除的颜色(RGB/RGBA 值),删除颜色列表内对应的颜色。
body - body payloadException - error during requestpublic DeleteImageStyleRes deleteImageStyle(DeleteImageStyleBody body) throws Exception
deleteImageStyle
删除样式
通过输入样式 ID 来删除该 ID 对应的创意魔方样式。
body - body payloadException - error during requestpublic CreateImageStyleRes createImageStyle(CreateImageStyleBody body) throws Exception
createImageStyle
新建样式
使用本接口来创建创意魔方样式,您可以自定义样式名称、样式画布高度/宽度等参数,并得到返回的样式 ID。
body - body payloadException - error during requestpublic UpdateImageStyleMetaRes updateImageStyleMeta(UpdateImageStyleMetaBody body) throws Exception
updateImageStyleMeta
更新样式元数据
通过输入样式 ID 以及更新的样式名称来修改已创建完成的创意魔方样式名称。
body - body payloadException - error during requestpublic AddImageElementsRes addImageElements(AddImageElementsBody body) throws Exception
addImageElements
添加常用图片/背景/蒙版要素
在要素列表添加常用的图片、背景或蒙版等要素,如果添加失败将返回失败的要素 URI。
body - body payloadException - error during requestpublic AddImageBackgroundColorsRes addImageBackgroundColors(AddImageBackgroundColorsBody body) throws Exception
addImageBackgroundColors
添加常用颜色
通过输入待添加的常用颜色(RGB/RGBA 值),在颜色列表内添加对应的颜色。
body - body payloadException - error during requestpublic UpdateImageStyleRes updateImageStyle(UpdateImageStyleBody body) throws Exception
updateImageStyle
编辑样式
对当前已创建的创意魔方样式的各元素(如图片、文字等)进行新的编辑操作,并选择是否对上传图片按照当前样式数据进行样式渲染以及渲染结果图的存储。
body - body payloadException - error during requestpublic GetImageFontsRes getImageFonts() throws Exception
getImageFonts
获取可用字体
获取创意魔方内当前可用的字体中文名称、字体资源 Uri 等可用字体详情。
Exception - error during requestpublic GetImageElementsRes getImageElements(GetImageElementsQuery query) throws Exception
getImageElements
获取常用图片/背景/蒙版要素
在要素列表通过指定要查询的要素类型(图片/背景/蒙版),获取当前已添加为常用的该类型要素详情(如 URI 和添加时间等)。
query - query argumentsException - error during requestpublic GetImageBackgroundColorsRes getImageBackgroundColors() throws Exception
getImageBackgroundColors
获取常用颜色
获取当前颜色列表内的所有颜色。
Exception - error during requestpublic GetImageStylesRes getImageStyles(GetImageStylesQuery query) throws Exception
getImageStyles
获取样式列表
通过输入样式类型等数据,获取分页返回的样式数据信息,如:样式 ID、样式名称和结果图 Uri等参数。
query - query argumentsException - error during requestpublic GetImageStyleDetailRes getImageStyleDetail(GetImageStyleDetailQuery query) throws Exception
getImageStyleDetail
获取样式详情
本接口支持通过输入样式 ID,获取该样式各要素(图片、文字、二维码、背景等)的配置项详情。
query - query argumentsException - error during requestpublic GetImageStyleResultRes getImageStyleResult(GetImageStyleResultQuery query, GetImageStyleResultBody body) throws Exception
getImageStyleResult
获取结果图 URI
使用创意魔方中预先创建好的样式 `StyleId`,定义需要设置的要素与要素的取值 `Params`,生成结果图,并获取结果图 URI。
- 调用前,请先在控制台中完成创意魔方样式的创建,并获取图片样式 ID `StyleId` 、样式中要素 ID `Key` 与样式所在服务的 ID `ServiceId`。
- 调用时,动态传入图片、文字、二维码等要素以及 Header 中的信息,实时渲染合成一张图片,并返回结果图片的 URI。
- 调用后,请务必在图片服务的基础配置中开启**源地址访问**后,再使用 [veImageX 地址拼接规则](https://www.volcengine.com/docs/508/105405)。
query - query argumentsbody - body payloadException - error during requestpublic DownloadCertRes downloadCert(DownloadCertQuery query) throws Exception
downloadCert
下载证书
本接口支持通过指定证书 ID 下载该证书,并获取返回的证书文件压缩名等信息。
query - query argumentsException - error during requestpublic GetImageAllDomainCertRes getImageAllDomainCert() throws Exception
getImageAllDomainCert
获取所有域名及证书信息
本接口支持获取所有域名以及证书信息。
Exception - error during requestpublic GetCertInfoRes getCertInfo(GetCertInfoQuery query) throws Exception
getCertInfo
获取证书详情
本接口支持通过指定证书 ID 获取该证书的详细信息。
query - query argumentsException - error during requestpublic GetAllCertsRes getAllCerts() throws Exception
getAllCerts
获取账号下全部证书
本接口支持获取当前账号下所有证书信息。
Exception - error during requestpublic CreateImageTemplateRes createImageTemplate(CreateImageTemplateQuery query, CreateImageTemplateBody body) throws Exception
createImageTemplate
创建图片模版
本接口支持指定服务 ID,在该服务下创建图片模板并自定义模板配置。
query - query argumentsbody - body payloadException - error during requestpublic DeleteTemplatesFromBinRes deleteTemplatesFromBin(DeleteTemplatesFromBinQuery query, DeleteTemplatesFromBinBody body) throws Exception
deleteTemplatesFromBin
删除回收站模板
本接口支持删除指定服务下回收站内的模板。删除后,该模板不可恢复。
query - query argumentsbody - body payloadException - error during requestpublic DeleteImageTemplateRes deleteImageTemplate(DeleteImageTemplateQuery query, DeleteImageTemplateBody body) throws Exception
deleteImageTemplate
删除图片模版
本接口支持通过指定服务 ID 以及模板名称删除对应的图片模板。
query - query argumentsbody - body payloadException - error during requestpublic CreateImageTemplatesByImportRes createImageTemplatesByImport(CreateImageTemplatesByImportBody body) throws Exception
createImageTemplatesByImport
导入模板
本接口支持通过指定服务 ID 以及模板的 JSON 内容,来向该服务导入图片模板。
* 如果导入成功,则返回模板名称。
* 如果导入失败,则返回失败原因。
:::tip
* 包含附加组件的模板不做导入,直接忽略。
* 包含图文水印的模板,需上传水印文件到目标服务,并替换模板内容中的水印 URI。
:::
body - body payloadException - error during requestpublic CreateTemplatesFromBinRes createTemplatesFromBin(CreateTemplatesFromBinQuery query, CreateTemplatesFromBinBody body) throws Exception
createTemplatesFromBin
恢复回收站模板
本接口支持恢复指定服务回收站内的模板。
:::tip
当已经有同名模板的时候,此时恢复模板会递增版本号。
:::
query - query argumentsbody - body payloadException - error during requestpublic GetImageTemplateRes getImageTemplate(GetImageTemplateQuery query) throws Exception
getImageTemplate
获取单个图片模板
本接口支持通过指定服务 ID 以及模板名称,获取单个图片模板的配置详情。
query - query argumentsException - error during requestpublic GetTemplatesFromBinRes getTemplatesFromBin(GetTemplatesFromBinQuery query) throws Exception
getTemplatesFromBin
获取回收站中所有模板
本接口支持通过指定服务 ID,获取该服务下回收站内所有模板信息。
query - query argumentsException - error during requestpublic GetAllImageTemplatesRes getAllImageTemplates(GetAllImageTemplatesQuery query) throws Exception
getAllImageTemplates
获取服务下所有图片模版
本接口支持通过其指定服务 ID 获取该服务下所有的图片模板信息。
query - query argumentsException - error during requestpublic CreateImageAuditTaskRes createImageAuditTask(CreateImageAuditTaskBody body) throws Exception
createImageAuditTask
创建审核任务
本接口支持在指定服务下创建审核任务。
body - body payloadException - error during requestpublic DeleteImageAuditResultRes deleteImageAuditResult(DeleteImageAuditResultBody body) throws Exception
deleteImageAuditResult
删除审核结果
本接口支持删除指定任务的某条审核结果。
body - body payloadException - error during requestpublic GetSyncAuditResultRes getSyncAuditResult(GetSyncAuditResultQuery query, GetSyncAuditResultBody body) throws Exception
getSyncAuditResult
同步单条审核
同步审核单条
query - query argumentsbody - body payloadException - error during requestpublic UpdateImageAuditTaskStatusRes updateImageAuditTaskStatus(UpdateImageAuditTaskStatusBody body) throws Exception
updateImageAuditTaskStatus
更新审核任务状态
本接口支持任务状态为已取消的审核任务,更新其任务状态。
body - body payloadException - error during requestpublic UpdateImageAuditTaskRes updateImageAuditTask(UpdateImageAuditTaskBody body) throws Exception
updateImageAuditTask
更新审核任务配置
本接口支持对任务状态为已取消的审核任务,通过指定服务 ID 和任务 ID 来更新该条审核任务的各项配置。
:::tip
您可通过调用[查询所有审核任务](https://www.volcengine.com/docs/508/1158717)查看所有审核任务的状态。
:::
body - body payloadException - error during requestpublic UpdateAuditImageStatusRes updateAuditImageStatus(UpdateAuditImageStatusBody body) throws Exception
updateAuditImageStatus
更新审核图片状态
本接口支持对审核异常(审核失败、审核不通过、建议复审)的图片更新图片状态。
body - body payloadException - error during requestpublic GetImageAuditTasksRes getImageAuditTasks(GetImageAuditTasksQuery query) throws Exception
getImageAuditTasks
查询所有审核任务
本接口支持通过指定审核类型,查询该类型下所有审核任务。
query - query argumentsException - error during requestpublic GetImageAuditResultRes getImageAuditResult(GetImageAuditResultQuery query) throws Exception
getImageAuditResult
获取审核任务结果
本接口支持您通过指定任务 ID 获取该任务的审核结果。
query - query argumentsException - error during requestpublic GetAuditEntrysCountRes getAuditEntrysCount(GetAuditEntrysCountQuery query) throws Exception
getAuditEntrysCount
获取审核图片计数
本接口支持获取指定审核任务的各类审核图片计量数据。
query - query argumentsException - error during requestpublic CreateImageRetryAuditTaskRes createImageRetryAuditTask(CreateImageRetryAuditTaskBody body) throws Exception
createImageRetryAuditTask
重试审核失败图片
本接口支持重试失败图片。
body - body payloadException - error during requestCopyright © 2025. All rights reserved.