更新域名配置--veImageX-火山引擎

文档中心

立即注册

导航

更新域名配置

最近更新时间：2024.01.31 15:04:48首次发布时间：2023.12.05 15:21:17

本接口支持服务的多个域名批量更新域名各配置。

注意事项

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

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=UpdateImageDomainConfig&Version=2018-08-01

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

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

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

Version String 是 2018-08-01 接口版本。当前 API 的版本为 2018-08-01。

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

ServiceId

String

是

uh****7d

服务 ID。

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

Body

参数	类型	是否必选	示例值	描述
domains	Array of String	是	`["a.imagex.cn"]`	域名列表，您可以通过获取服务下全部域名获取服务下域名信息。
https	Object of Https	否	`-`	HTTPS 配置
referer_link	Object of Referer_link	否	`-`	Referer 防盗链配置
url_auth	Object of Url_auth	否	`-`	URL 鉴权配置
ip_auth	Object of Ip_auth	否	`-`	IP 黑白名单配置
user_agent_acl	Object of User_agent_acl	否	`-`	UA 访问限制配置
area_acl	Object of Area_acl	否	`-`	区域访问限制，不传不更新
advanced	Object of Advanced	否	`-`	高级配置
resp_hdrs	Array of Resp_hdrs	否	`-`	HTTP 响应头配置
adaptfmt	Object of Adaptfmt	否	`-`	自适应格式配置
do_slim	Object of Do_slim	否	`-`	集智瘦身配置
global_acceleration	Object of Global_acceleration	否	`-`	全球加速配置
remote_auth	Object of Remote_auth	否	`-`	远程鉴权设置

Https

参数	类型	是否必选	示例值	描述
enable_http2	Boolean	是	`true`	是否开启 http2，取值如下所示： `true`：开启 `false`：关闭
enable_https	Boolean	是	`true`	是否开启 https，取值如下所示： `true`：开启 `false`：关闭
tls_versions	Array of String	是	`["tlsv1.1"]`	支持的 tls 版本。取值如下所示： `tlsv1.0` `tlsv1.1` `tlsv1.2` `tlsv1.3`
cert_id	String	否	`iuhs2928jdh`	需要关联的证书 ID，若`enable_https`为`true`，则为必填。
enable_force_redirect	Boolean	否	`true`	是否开启强制跳转，取值如下所示： `true`：开启 `false`：关闭
force_redirect_type	String	否	`http2https`	仅当`enable_force_redirect`取值为`true`时需要配置，强制跳转类型。取值如下所示： `http2https`：HTTP 到 HTTPS `https2http`：HTTPS 到 HTTP
force_redirect_code	String	否	`301`	仅当`enable_force_redirect`取值为`true`时需要配置，强制跳转状态码。取值如下所示： `301`：返回给用户 301 状态码进行重定向。 `302`：返回给用户 302 状态码进行重定向。

Referer_link

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启 Referer 防盗链，取值如下所示： `true`：开启 `false`：关闭
is_white_mode	Boolean	是	`true`	是否选择白名单，取值如下所示： `true`：选择白名单 `false`：不选择白名单
values	Array of String	是	`["s.com", "y.com", "q.com"]`	根据是否为白名单，为对应的白/黑名单的值。
allow_empty_refer	Boolean	是	`false`	是否允许空 Refer，取值如下所示： `true`：允许空 Refer `false`：不允许空 Refer
regex_values	Array of String	是	`\192\.23\.1\.8\b`	正则表达式规则列表

Url_auth

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启 URL 鉴权配置，取值如下所示： `true`：是 `false`：否
type_a	Object of Type_a	是	`-`	A 鉴权配置
type_b	Object of Type_b	是	`-`	B 鉴权配置
type_c	Object of Type_c	是	`-`	C 鉴权配置
type_d	Object of Type_d	是	`-`	D 鉴权配置

Ip_auth

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

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启黑白名单配置，取值如下所示： `true`：开启黑白名单配置 `false`：关闭黑白名单配置
is_white_mode	Boolean	是	`false`	是否是 IP 白名单，取值如下所示： `true`：配置白名单 `false`：配置黑名单
values	Array of String	是	`["10.100.8.1"]`	黑白名单 IP 地址，最大限制为 100。

enabled

Boolean

是

true

是否开启黑白名单配置，取值如下所示：

true：开启黑白名单配置
false：关闭黑白名单配置

is_white_mode

Boolean

是

false

是否是 IP 白名单，取值如下所示：

true：配置白名单
false：配置黑名单

values Array of String 是 ["10.100.8.1"] 黑白名单 IP 地址，最大限制为 100。

User_agent_acl

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启 UA 访问限制，取值如下所示： `true`：开启 `false`：未开启
rule_type	String	是	`deny`	黑白名单设置类型，取值如下所示： `deny`：黑名单 `allow`：白名单
user_agents	Array of String	是	`["IE\|safari"]`	Agent 列表，最多可支持输入100个，支持通配符`*`匹配任意字符串。
allow_empty	Boolean	是	`true`	表示是否允许 UA 为空或者不包含 UA 字段的请求访问加速域名。取值如下所示： `true`：允许 `false`：不允许

Area_acl

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

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启区域限制，取值如下所示： `true`：开启 `false`：未开启
rule_type	String	是	`deny`	黑白名单设置类型，取值如下所示： `deny`：黑名单 `allow`：白名单
areas	Array of String	是	`["Cambodia"]`	地区列表。取值请见国家名称对照表表格中国家简写该列内容。

enabled

Boolean

是

true

是否开启区域限制，取值如下所示：

true：开启
false：未开启

rule_type

String

是

deny

黑白名单设置类型，取值如下所示：

deny：黑名单
allow：白名单

areas Array of String 是 ["Cambodia"] 地区列表。取值请见国家名称对照表表格中国家简写该列内容。

Advanced

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

参数	类型	是否必选	示例值	描述
enable_ipv6	Boolean	否	`true`	是否开启 IPV6，取值如下所示： `true`：开启 `false`：关闭
enable_gzip	Boolean	否	`true`	是否开启 Gzip 压缩，取值如下所示： `true`：开启 `false`：关闭
enable_br	Boolean	否	`true`	是否开启 Brotli 压缩，取值如下所示： `true`：开启 `false`：关闭说明支持同时配置 Gzip 压缩和 Brotli 压缩，详细内容请参考智能压缩。

enable_ipv6

Boolean

否

true

是否开启 IPV6，取值如下所示：

true：开启
false：关闭

enable_gzip

Boolean

否

true

是否开启 Gzip 压缩，取值如下所示：

true：开启
false：关闭

enable_br

Boolean

否

true

是否开启 Brotli 压缩，取值如下所示：

true：开启
false：关闭

说明

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

Resp_hdrs

参数	类型	是否必选	示例值	描述
key	String	否	`Access-Control-Allow-Origin`	Header Key，请见支持配置的响应头。
value	String	否	`*`	Header Value，设置该响应头字段的值。字段值不能超过 1,024 个字符，可以包含除`美元符号（$），Delete（ASCII code 127）`外的可打印 ASCII 字符。

Adaptfmt

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

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启自适应，取值如下所示： `true`：开启自适应 `false`：关闭自适应
adapt_formats	Array of String	是	`["heic","avif"]`	自适应格式列表，支持以下取值： `webp`：WEBP 自适应 `heic`：HEIC 自适应 `avif`：AVIF 自适应
check_adapt_fsize	Boolean	是	`true`	是否开启体积校验，取值如下所示： `true`：开启 `false`：关闭

enabled

Boolean

是

true

是否开启自适应，取值如下所示：

true：开启自适应
false：关闭自适应

adapt_formats

Array of String

是

["heic","avif"]

自适应格式列表，支持以下取值：

webp：WEBP 自适应
heic：HEIC 自适应
avif：AVIF 自适应

check_adapt_fsize

Boolean

是

true

是否开启体积校验，取值如下所示：

true：开启
false：关闭

Do_slim

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

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启集智瘦身，取值如下所示： `true`：开启集智瘦身 `false`：关闭集智瘦身
discard_slimed_file	Boolean	是	`true`	是否关闭持久化。取值如下所示： `true`：关闭 `false`：开启

enabled

Boolean

是

true

是否开启集智瘦身，取值如下所示：

true：开启集智瘦身
false：关闭集智瘦身

discard_slimed_file

Boolean

是

true

是否关闭持久化。取值如下所示：

true：关闭
false：开启

Global_acceleration

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

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启全球加速，取值如下所示： `true`：开启 `false`：关闭

enabled

Boolean

是

true

是否开启全球加速，取值如下所示：

true：开启
false：关闭

Remote_auth

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启远程鉴权，取值如下所示： `true`：是 `false`：否
match_rule	Array of Match_rule	是	`-`	生效对象
auth_server	Object of Auth_server	是	`-`	鉴权服务器设置
auth_request_query	Object of Auth_request_query	是	`-`	鉴权请求参数设置
auth_request_header	Object of Auth_request_header	是	`-`	鉴权请求头设置
auth_response	Object of Auth_response	是	`-`	鉴权响应设置

Type_a

参数	类型	是否必选	示例值	描述
main_sk	String	是	`SKSKSKSK`	主鉴权密钥
backup_sk	String	是	`test`	备用鉴权密钥
sign_param	String	是	`sign`	md5hash 参数名
expire_time	Integer	是	`1800`	有效时间，单位为秒。取值范围为[1, 630720000]内的正整数，默认为 1800 秒。

Type_b

参数	类型	是否必选	示例值	描述
main_sk	String	是	`01h9dh**01h9k`	主鉴权密钥
backup_sk	String	是	`test`	备用鉴权密钥
expire_time	Integer	是	`1800`	有效时间，单位为秒。取值范围为[1, 630720000]内的正整数，默认为 1800 秒。

Type_c

参数	类型	是否必选	示例值	描述
main_sk	String	是	`01h9dh**01h9k`	主鉴权密钥
backup_sk	String	是	`test`	备用鉴权密钥
expire_time	Integer	是	`1800`	有效时间，单位为秒。取值范围为[1, 630720000]内的正整数，默认为 1800 秒。

Type_d

参数	类型	是否必选	示例值	描述
main_sk	String	是	`01h9dh**01h9k`	主鉴权密钥
backup_sk	String	是	`test`	备用鉴权密钥
sign_param	String	是	`sign`	md5hash 参数名
expire_time	Integer	是	`1800`	有效时间，单位为秒。取值范围为[1, 630720000]内的正整数，默认为 1800 秒。
time_param	String	是	`t`	TimeStamp 参数名
time_format	String	是	`decimal`	时间戳格式，取值如下所示： `decimal`：十进制（Unix 时间戳） `heximal`：十六进制（Unix 时间戳）

Match_rule

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

参数	类型	是否必选	示例值	描述
match_operator	String	是	`match`	匹配方式，取值如下所示： `match`：（默认）表示 object 匹配 Value。 `not_match`：表示 object 不匹配 Value。说明如果您创建了多个生效对象配置，每个配置中该参数的值必须相同。
object	String	是	`directory`	表示 veImageX 对哪些对象类型进行规则匹配。取值如下所示： `filetype`：表示特定后缀的文件。 `directory`：表示特定文件目录下的所有文件。 `path`：表示特定的文件。
value	String	是	`/www/img/volc/`	表示 Object 对应的具体对象，并且是大小写敏感的。参数值的长度不能超过 1,024 个字符。您可以指定一个或者多个对象。多个对象之间使用英文分号（;）分隔。该参数的说明如下：如果 `Object` 是 `filetype`，您需要指定一个或者多个文件后缀。文件后缀可以包含英文字母和数字。多个文件后缀使用分号（;）分隔。例如 xlsx 或者 png;txt。如果 `Object` 是 `directory`，您需要指定一个或者多个目录路径。多个目录路径使用分号（;）分隔。每个目录路径必须以斜杠（/）开头和结尾，说明例如 /www/img/volc/;/www/doc/。您可以使用 / 表示域名下的所有目录。同时，目录路径可以包含除了以下字符的可打印 ASCII 字符：连续斜杠（//）、百分号（%）、美元符号（$）、空格、问号（?）、Delete（ASCII code 127）如果 `Object` 是 `path`，您需要指定一个或者多个文件路径。文件路径支持使用通配符（*）表示一个或者多个字符。多个文件路径使用分号（;）分隔。说明例如 /www/img/volcano.png;/doc/study.docx。文件路径必须以 / 开头。同时，文件路径可以包含除了以下字符的可打印 ASCII 字符：连续斜杠（//）、百分号（%）、美元符号（$）、空格、问号（?）、Delete（ASCII code 127）

match_operator

String

是

match

匹配方式，取值如下所示：

match：（默认）表示 object 匹配 Value。
not_match：表示 object 不匹配 Value。

说明

如果您创建了多个生效对象配置，每个配置中该参数的值必须相同。

object

String

是

directory

表示 veImageX 对哪些对象类型进行规则匹配。取值如下所示：

filetype：表示特定后缀的文件。
directory：表示特定文件目录下的所有文件。
path：表示特定的文件。

value

String

是

/www/img/volc/

表示 Object 对应的具体对象，并且是大小写敏感的。参数值的长度不能超过 1,024 个字符。您可以指定一个或者多个对象。多个对象之间使用英文分号（;）分隔。该参数的说明如下：

如果 Object 是 filetype，您需要指定一个或者多个文件后缀。文件后缀可以包含英文字母和数字。多个文件后缀使用分号（;）分隔。例如 xlsx 或者 png;txt。
如果 Object 是 directory，您需要指定一个或者多个目录路径。多个目录路径使用分号（;）分隔。每个目录路径必须以斜杠（/）开头和结尾，

说明

例如 /www/img/volc/;/www/doc/。您可以使用 / 表示域名下的所有目录。同时，目录路径可以包含除了以下字符的可打印 ASCII 字符：连续斜杠（//）、百分号（%）、美元符号（$）、空格、问号（?）、Delete（ASCII code 127）

如果 Object 是 path，您需要指定一个或者多个文件路径。文件路径支持使用通配符（*）表示一个或者多个字符。多个文件路径使用分号（;）分隔。

说明

例如 /www/img/volcano.png;/doc/study.docx。文件路径必须以 / 开头。同时，文件路径可以包含除了以下字符的可打印 ASCII 字符：连续斜杠（//）、百分号（%）、美元符号（$）、空格、问号（?）、Delete（ASCII code 127）

Auth_server

参数	类型	是否必选	示例值	描述
address	String	是	`http://www.testa.com`	鉴权服务器的主地址。主地址的格式是 <scheme>://<domain> 或 <scheme>://<ip>。该参数值的长度不能超过 100 个字符。 <scheme> 的值是 http 或者 https。 <domain> 的值不能是 localhost。 <ip> 的值不能是 127.0.0.1。
backup_address	String	是	`http://www.testb.com`	鉴权服务器的备地址。地址格式和要求与主地址 `address` 相同。
path_type	String	是	`constant`	鉴权请求的路径。鉴权地址和请求路径组成了完整的鉴权 URL。veImageX 会把用户的请求转发到该鉴权 URL。取值如下所示： `constant`：表示鉴权请求中的路径与用户请求中的路径相同。 `variable`：表示您需要在 pathValue 参数中指定一个鉴权请求中的路径。
path_value	String	是	`/sig`	表示一个鉴权请求的路径，长度不能超过 100 个字符。路径必须以斜杠（/）开头，可以包含除了以下字符的可打印 ASCII 字符：连续斜杠（//）、百分号（%）、美元符号（$）、空格、问号（?）、Delete（ASCII code 127）
request_method	String	是	`default`	在发送鉴权请求时，veImageX 所使用的请求方法。取值如下所示： `default`：鉴权请求所使用的方法与用户的请求相同。 `get`：鉴权请求使用 GET 方法。 `post`：鉴权请求使用 POST 方法。 `head`：鉴权请求使用 HEAD 方法。

Auth_request_query

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

参数	类型	是否必选	示例值	描述
action	String	是	`includePart`	表示鉴权请求是否包含用户请求 URL 中的查询参数。取值如下所示： `exclude`：表示鉴权请求不包含任何查询参数。 `include`：表示鉴权请求包含所有查询参数。 `includePart`：表示鉴权请求包含指定的查询参数。
value	String	是	`header1;header2`	表示 Action 参数所对应的参数值，长度不能超过1,024 个字符。取值如下所示：如果 `Action` 是 `exclude` 或 `include`，`Value` 必须是 ``。如果 `Action` 是 `includePart`，您需要在 Value 参数中指定用户请求 URL 中的一个或者多个查询参数，多个查询参数使用英文分号（;）分隔。您不能指定。查询参数是区分大小写的，可以包含除了以下字符的可打印 ASCII 字符：双引号（"）、空格、Delete（ASCII code 127）该参数的默认值是 *。
query	Array of Query	是	`-`	表示鉴权请求中额外的参数设置。您最多可以设置 50 个参数。

action

String

是

includePart

表示鉴权请求是否包含用户请求 URL 中的查询参数。取值如下所示：

exclude：表示鉴权请求不包含任何查询参数。
include：表示鉴权请求包含所有查询参数。
includePart：表示鉴权请求包含指定的查询参数。

value

String

是

header1;header2

表示 Action 参数所对应的参数值，长度不能超过1,024 个字符。取值如下所示：

如果 Action 是 exclude 或 include，Value 必须是 *。
如果 Action 是 includePart，您需要在 Value 参数中指定用户请求 URL 中的一个或者多个查询参数，多个查询参数使用英文分号（;）分隔。您不能指定 *。查询参数是区分大小写的，可以包含除了以下字符的可打印 ASCII 字符：双引号（"）、空格、Delete（ASCII code 127）该参数的默认值是 *。

query Array of Query 是 - 表示鉴权请求中额外的参数设置。您最多可以设置 50 个参数。

Auth_request_header

参数	类型	是否必选	示例值	描述
host	String	是	`default`	鉴权请求中 HOST 头部的值。该参数的默认值是 `default`，表示 HOST 头部的值与您的加速域名相同。
action	String	是	`exclude`	鉴权请求头是否包含用户请求头。取值如下所示： `exclude`：表示鉴权请求头中不包含任何用户请求头。 `include`：表示鉴权请求头中包含所有用户请求头。 `includePart`：表示鉴权请求头包含指定的用户请求头。
value	String	是	`*`	表示 Action 参数所对应的参数值，长度不能超过 1,024 个字符。该参数有以下说明：如果 `Action` 是 `exclude` 或 `include`，`Value` 必须是 ``。如果 `Action` 是 `includePart`，`Value` 参数的取值是用户请求中的一个或者多个头部。多个头部使用英文分号（;）分隔。其取值不能只是，可以包含除了以下字符的可打印 ASCII 字符：下划线（_）、空格、双引号（"），Delete（ASCII code 127）该参数的默认值是 *。
header	Array of Header	是	`-`	表示鉴权请求中额外的请求头设置。您最多可以设置 50 个请求头。

Auth_response

参数	类型	是否必选	示例值	描述
auth_server_status_code	Object of Auth_server_status_code	是	`-`	鉴权服务器状态码设置
auth_result_cache	Object of Auth_result_cache	是	`-`	鉴权结果缓存设置
auth_server_timeout	Object of Auth_server_timeout	是	`-`	鉴权服务超时时间
response	Object of Response	是	`-`	响应设置

Query

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

key String 是 new_host 您需要设置的鉴权请求参数，长度不能超过 1,024 个字符。鉴权请求参数可以包含除了以下字符的可打印 ASCII 字符：双引号（"）、空格、Delete（ASCII code 127）

参数	类型	是否必选	示例值	描述
key	String	是	`new_host`	您需要设置的鉴权请求参数，长度不能超过 1,024 个字符。鉴权请求参数可以包含除了以下字符的可打印 ASCII 字符：双引号（"）、空格、Delete（ASCII code 127）
value_type	String	是	`variable`	您在 Key 中设置的鉴权请求参数的类型。ValueType 有以下取值： `constant`：表示鉴权请求参数是一个常量。此时，您需要在 `Value` 中指定该常量的值。 `variable`：表示鉴权请求参数的值来自一个变量。参见 `Value` 的说明。
value	String	是	`host`	鉴权请求参数的值，长度不能超过 1,024 个字符，并且区分大小写。Value 有以下取值：当 `ValueType` 是 `constant` 时，表示鉴权请求参数的值是一个常量。您需要指定该常量值。常量值不能以美元符号（$）开头，可以包含除了以下字符的可打印 ASCII 字符：双引号（"）、Delete（ASCII code 127）当 `ValueType` 是 `variable` 时，表示鉴权请求参数的值来自一个变量。您可以指定该变量列表中的变量。

value_type

String

是

variable

您在 Key 中设置的鉴权请求参数的类型。ValueType 有以下取值：

constant：表示鉴权请求参数是一个常量。此时，您需要在 Value 中指定该常量的值。
variable：表示鉴权请求参数的值来自一个变量。参见 Value 的说明。

value

String

是

host

鉴权请求参数的值，长度不能超过 1,024 个字符，并且区分大小写。Value 有以下取值：

当 ValueType 是 constant 时，表示鉴权请求参数的值是一个常量。您需要指定该常量值。常量值不能以美元符号（$）开头，可以包含除了以下字符的可打印 ASCII 字符：双引号（"）、Delete（ASCII code 127）
当 ValueType 是 variable 时，表示鉴权请求参数的值来自一个变量。您可以指定该变量列表中的变量。

Header

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

key String 是 header1 您需要设置的请求头。请求头不能是 host，长度不能超过 1,024 个字符，并且不区分大小写。请求头可以包含除了以下字符的可打印 ASCII 字符：下划线（_）、双引号（"）、空格、Delete（ASCII code 127）

参数	类型	是否必选	示例值	描述
key	String	是	`header1`	您需要设置的请求头。请求头不能是 host，长度不能超过 1,024 个字符，并且不区分大小写。请求头可以包含除了以下字符的可打印 ASCII 字符：下划线（_）、双引号（"）、空格、Delete（ASCII code 127）
value_type	String	是	`h`	请求头的类型。取值如下所示： `constant`：表示请求头的值是一个常量。您需要在 `Value` 参数中指定该常量的值。 `variable`：表示请求头的值来自一个变量。参见 `Value` 的说明。
value	String	是	`constant`	表示请求头的值。取值如下所示：当 `ValueType` 是 `constant` 时，您需要指定一个常量值。该常量值的长度不能超过 1,024 个字符，并且区分大小写。同时，该常量值不能以美元符号（$）开头，可以包含除了以下字符的可打印 ASCII 字符：双引号（"）、Delete（ASCII code 127）当 `ValueType` 是 `variable` 时，表示请求头的值来自一个变量。您可以指定该变量列表中的变量。

value_type

String

是

h

请求头的类型。取值如下所示：

constant：表示请求头的值是一个常量。您需要在 Value 参数中指定该常量的值。
variable：表示请求头的值来自一个变量。参见 Value 的说明。

value

String

是

constant

表示请求头的值。取值如下所示：

当 ValueType 是 constant 时，您需要指定一个常量值。该常量值的长度不能超过 1,024 个字符，并且区分大小写。同时，该常量值不能以美元符号（$）开头，可以包含除了以下字符的可打印 ASCII 字符：双引号（"）、Delete（ASCII code 127）
当 ValueType 是 variable 时，表示请求头的值来自一个变量。您可以指定该变量列表中的变量。

Auth_server_status_code

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

参数	类型	是否必选	示例值	描述
fail_code	String	是	`407`	指定鉴权失败时的鉴权状态码。默认值是 401。您可以指定范围在 400-499 中的一个或者多个状态码。多个状态码使用英文分号（;）分隔。您也可以指定 4xx 表示 400-499 中的任意一个状态码。
success_code	String	是	`200`	指定鉴权成功时的鉴权状态码。默认值是 200。您可以指定范围在 200-299 中的一个或者多个状态码。多个状态码使用英文分号（;）分隔。您也可以指定 2xx 表示 200-299 中的任意一个状态码。
default_action	String	是	`reject`	如果鉴权状态码既不是 FailCode，又不是 SuccessCode 时，veImageX 处理鉴权请求的方式。取值如下所示： `reject`：veImageX 认为鉴权失败。 `pass`：veImageX 认为鉴权成功。

fail_code

String

是

407

指定鉴权失败时的鉴权状态码。默认值是 401。

您可以指定范围在 400-499 中的一个或者多个状态码。多个状态码使用英文分号（;）分隔。
您也可以指定 4xx 表示 400-499 中的任意一个状态码。

success_code

String

是

200

指定鉴权成功时的鉴权状态码。默认值是 200。

您可以指定范围在 200-299 中的一个或者多个状态码。多个状态码使用英文分号（;）分隔。
您也可以指定 2xx 表示 200-299 中的任意一个状态码。

default_action

String

是

reject

如果鉴权状态码既不是 FailCode，又不是 SuccessCode 时，veImageX 处理鉴权请求的方式。取值如下所示：

reject：veImageX 认为鉴权失败。
pass：veImageX 认为鉴权成功。

Auth_result_cache

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

参数	类型	是否必选	示例值	描述
action	String	是	`nocache`	veImageX 是否缓存鉴权状态码。取值如下所示： `nocache`：veImageX 不缓存鉴权状态码。 `cache`：veImageX 缓存鉴权状态码。
cache_key	Array of String	是	`[$URI,$host]`	缓存 key 指定了用于区分不同请求 URI 的查询参数。可以指定变量字段说明中的参数, 必须包含 URI。
ttl	Integer	是	`5`	鉴权状态码的缓存时间。单位是秒。取值范围是 [1,86400]。86400 秒表示 24 小时。

action

String

是

nocache

veImageX 是否缓存鉴权状态码。取值如下所示：

nocache：veImageX 不缓存鉴权状态码。
cache：veImageX 缓存鉴权状态码。

cache_key Array of String 是 [$URI,$host] 缓存 key 指定了用于区分不同请求 URI 的查询参数。可以指定变量字段说明中的参数, 必须包含 URI。

ttl Integer 是 5 鉴权状态码的缓存时间。单位是秒。取值范围是 [1,86400]。86400 秒表示 24 小时。

Auth_server_timeout

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

time Integer 是 200 鉴权超时的时间，单位是毫秒。默认值为 200，取值范围是 [200,3600]。

参数	类型	是否必选	示例值	描述
time	Integer	是	`200`	鉴权超时的时间，单位是毫秒。默认值为 200，取值范围是 [200,3600]。
action	String	是	`reject`	鉴权超时后 veImageX 处理鉴权请求的策略。取值如下所示： `reject`：veImageX 认为鉴权失败。 `pass`：veImageX 认为鉴权成功。

action

String

是

reject

鉴权超时后 veImageX 处理鉴权请求的策略。取值如下所示：

reject：veImageX 认为鉴权失败。
pass：veImageX 认为鉴权成功。

Response

参数	类型	是否必选	示例值	描述
fail_code	String	是	`403`	鉴权失败时 veImageX 响应用户的状态码。取值范围为 [400,499] 。默认值是 403。

返回参数

本接口调用成功返回 OK，否则返回错误。更多信息请见公共返回参数。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageDomainConfig&Version=2018-08-01&ServiceId=`uh****7d`

{
   "domain":"test.imagex.com",
   "ip_auth":{
      "enabled":true,
      "is_white_mode":false,
      "values":[
         "10.10.0.8"
      ],
      "regex_values":null
   }
}

返回示例

{
   "ResponseMetadata":{
      "RequestId":"20231017154954B6ACC263AD02E62DDD9D",
      "Action":"UpdateImageDomainIPAuth",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":"ok"
}

错误码

访问公共错误码以及通用错误码获取详细信息。