更新域名自适应格式配置--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新域名自适应格式配置

最近更新时间：2024.08.20 10:11:28首次发布时间：2024.08.20 10:11:28

本接口支持修改指定服务 ID 下域名的自适应格式配置。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：约为 1 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=UpdateDomainAdaptiveFmt&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述

Action String 是 UpdateDomainAdaptiveFmt 接口名称。当前 API 的名称为 UpdateDomainAdaptiveFmt。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateDomainAdaptiveFmt`	接口名称。当前 API 的名称为 `UpdateDomainAdaptiveFmt`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`8ji**as0`	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

8ji**as0

服务 ID。

您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
Domain	String	是	`test.volcimagextest.com`	域名，您可以通过获取服务下全部域名获取服务下域名信息。
AdaptFmt	Boolean	是	`true`	是否开启自适应，取值如下所示： `true`：开启自适应 `false`：关闭自适应
AdaptFormats	Array of String	是	`["heic"]`	自适应格式列表，取值如下所示： `webp`：WEBP 自适应 `heic`：HEIC 自适应 `avif`：AVIF 自适应
CheckAdaptFsize	Boolean	是	`false`	是否开启体积校验，取值如下所示： `true`：开启。开启后会对经自适应编码后的图片体积和编码前原图体积进行对比，若编码后体积更小则输出编码后图片；否则输出原图。 `false`：关闭

返回参数

本接口调用成功后返回 OK。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateDomainAdaptiveFmt&Version=2023-05-01&ServiceId=8ji**as0
{
    "Domain": "test.volcimagextest.com",
    "AdaptFmt": true,
    "AdaptFormats": [
        "heic"
    ],
    "CheckAdaptFsize": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdateDomainAdaptiveFmt",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": "ok"
}

错误码

本接口无特有的错误码。更多信息请见公共错误码以及 veImageX 错误码。

历史版本

2018-08-01 版本 DeleteTemplatesFromBin 接口文档现已停止维护，建议您参考本文档使用最新版本。