You need to enable JavaScript to run this app.
导航
更新域名高级配置
最近更新时间:2024.01.31 15:08:19首次发布时间:2023.03.29 19:00:30

本接口支持更新指定服务和域名下的域名高级配置,如 IPV6,智能压缩。

请求说明

  • 接口名称:UpdateAdvance
  • 请求方式:POST
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=UpdateAdvance&Version=2018-08-01
  • 请求频率限制:10 次/秒
  • 超时时间:5 秒

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

Query

参数类型是否必选描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01

ServiceId

String

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过调用 GetAllImageServices 接口方式获取服务 ID。

Body

参数
类型
是否必选描述
doaminString域名。您可以通过调用 GetServiceDomains接口获取域名。
advanceObject of advance高级配置

advance

参数类型是否必选描述

enable_ipv6

Boolean

是否开启 IPV6,取值如下所示:

  • true:开启
  • false:关闭

enable_gzip

Boolean

是否开启 Gzip 压缩,取值如下所示:

  • true:开启
  • false:关闭

说明

支持同时配置 Gzip 压缩和 Brotli 压缩,详细内容请参考智能压缩

enable_br

Boolean

是否开启 Brotli 压缩,取值如下所示:

  • true:开启
  • false:关闭

说明

支持同时配置 Gzip 压缩和 Brotli 压缩,详细内容请参考智能压缩

返回参数

正确更新返回 ok,否则错误在 Err 中返回。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateAdvance&Version=2018-08-01 
{
    "doamin": "xxxx.com",
    "advance": {
        "enable_ipv6": true,
        "enable_gzip": false,
        "enable_br": false
    },
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateAdvance",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"        
    },
    "Result": "ok"
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateAdvance",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

访问公共错误码域名相关错误码获取详细信息。