获取域名配置--veImageX-火山引擎

文档中心

立即注册

导航

获取域名配置

最近更新时间：2024.05.27 15:01:22首次发布时间：2021.02.23 10:42:23

通过指定服务 ID 以及域名，获取当前域名的配置信息。

注意事项

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
domain	String	`example.volcimagex.cn`	域名
status	String	`配置中`	域名状态
adaptfmt	Boolean	`true`	是否开启自适应格式，取值如下所示： `true`：开启自适应 `false`：关闭自适应
do_slim	Boolean	`false`	是否开启集智瘦身，取值如下所示： `true`：开启集智瘦身 `false`：关闭集智瘦身
global_acceleration	Boolean	`false`	是否开启全球加速，取值如下所示： `true`：开启全球加速 `false`：关闭全球加速
resp_hdrs	Array of Resp_hdrs	`-`	HTTP Header 配置
https_config	Object of Https_config	`-`	HTTPS 配置
access_control	Object of Access_control	`-`	访问控制配置
lock_status	Object of Lock_status	`-`	域名锁定状态

Resp_hdrs

参数	类型	示例值	描述
key	String	`Access-Control-Allow-Origin`	header key
value	String	`*`	header value

Https_config

参数	类型	示例值	描述
enable_https	Boolean	`true`	是否开启 HTTPS，取值如下所示： `true`：开启 HTTPS `false`：关闭 HTTPS
force_https	Boolean	`false`	是否强制使用 HTTPS，取值如下所示： `true`：强制 HTTPS `false`：不强制 HTTPS
cert_id	String	`dd68fe42b4f74231be96a75e7a2f9bc8`	证书 ID，若`enable_https`为`true`，则为必选。
enable_http2	Boolean	`true`	是否开启 HTTP2，取值如下所示： `true`：开启 HTTP2 `false`：关闭 HTTP2

Access_control

参数	类型	示例值	描述
ip_auth	Object of Ip_auth	`-`	IP 访问控制配置
refer_link	Object of Refer_link	`-`	Referer 访问限制配置
ua_list	Object of Ua_list	`-`	UA 访问控制配置
url_auth	Object of Url_auth	`-`	URL 鉴权配置
remote_auth	Object of Remote_auth	`-`	远程鉴权设置

Lock_status

参数	类型	示例值	描述
domain_locked	Boolean	`true`	整个域名是否锁定，取值如下所示： `true`：是 `false`：否
compression_locked	Boolean	`true`	智能压缩是否锁定，取值如下所示： `true`：是 `false`：否
ip_access_rule_locked	Boolean	`true`	IP 访问限制是否锁定，取值如下所示： `true`：是 `false`：否
referer_access_rule_locked	Boolean	`false`	Referer 防盗链配置是否锁定，取值如下所示： `true`：是 `false`：否
response_header_locked	Boolean	`true`	响应头配置是否锁定，取值如下所示： `true`：是 `false`：否
sign_url_auth_locked	Boolean	`false`	URL 鉴权签算配置是否锁定，取值如下所示： `true`：是 `false`：否
ua_access_rule_locked	Boolean	`false`	UA 访问限制配置是否锁定，取值如下所示： `true`：是 `false`：否
reason	String	`域名存在特殊配置`	锁定原因

Ip_auth

参数类型示例值描述

参数	类型	示例值	描述
enabled	Boolean	`false`	是否开启 IP 访问控制，取值如下所示： `true`：开启 IP 访问控制 `false`：关闭 IP 访问控制
is_white_mode	Boolean	`false`	是否是白名单模式，取值如下所示： `true`：白名单模式 `false`：黑名单模式
values	Array of String	`["1.1.1.1"]`	IP 列表

enabled

Boolean

false

是否开启 IP 访问控制，取值如下所示：

true：开启 IP 访问控制
false：关闭 IP 访问控制

is_white_mode

Boolean

false

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

true：白名单模式
false：黑名单模式

values Array of String ["1.1.1.1"] IP 列表

Refer_link

参数	类型	示例值	描述
enabled	Boolean	`true`	是否开启 Referer 访问限制，取值如下所示： `true`：开启 Referer 访问限制 `false`：关闭 Referer 访问限制
is_white_mode	Boolean	`false`	是否是 Referer 白名单模式，取值如下所示： `true`：白名单模式 `false`：黑名单模式说明当`is_white_mode`为`false`时，即选用黑名单时，需确保`allow_empty_refer`为`true`。
allow_empty_refer	Boolean	`true`	是否允许空 Referer，取值如下所示： `true`：允许空 Referer `false`：禁止空 Referer
values	Array of String	`["www.byte.com","www.fdjk.com"]`	Referer 列表
regex_values	Array of String	`\192\.23\.1\.8\b`	正则规则列表

Ua_list

参数类型示例值描述

参数	类型	示例值	描述
enabled	Boolean	`false`	是否开启 UA 访问控制，取值如下所示： `true`：开启 UA 访问控制 `false`：关闭 UA 访问控制
is_white_mode	Boolean	`true`	是否是白名单模式，取值如下所示： `true`：白名单模式 `false`：黑名单模式
values	Array of String	`["chrome\|firefox"]`	UA 列表

enabled

Boolean

false

是否开启 UA 访问控制，取值如下所示：

true：开启 UA 访问控制
false：关闭 UA 访问控制

is_white_mode

Boolean

true

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

true：白名单模式
false：黑名单模式

values Array of String ["*chrome*|*firefox*"] UA 列表

Url_auth

参数	类型	示例值	描述
enabled	Boolean	`true`	是否开启 URL 鉴权，取值如下所示： `true`：开启 URL 鉴权 `false`：关闭 URL 鉴权
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 鉴权配置

Remote_auth

参数	类型	示例值	描述
enabled	Boolean		是否开启远程鉴权，取值如下所示： `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	`sksksksksksk`	主鉴权密钥
backup_sk	String	`test`	备用鉴权密钥
sign_param	String	`sign`	签名参数名
expire_time	Integer	`1800`	有效时间，单位为秒。取值范围为[1, 630720000]内的正整数，默认为 1800 秒。

Type_b

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

Type_c

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

Type_d

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

Match_rule

参数类型示例值描述

参数	类型	示例值	描述
match_operator	String	`match`	匹配方式，取值如下所示： `match`：object 匹配 Value。 `not_match`：object 不匹配 Value。
object	String	`directory`	对哪些对象类型进行规则匹配，取值如下所示： `filetype`：表示特定后缀的文件。 `directory`：表示特定文件目录下的所有文件。 `path`：表示特定的文件。
value	String	`/www/img/volc/`	Object 对应的具体对象

match_operator

String

match

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

match：object 匹配 Value。
not_match：object 不匹配 Value。

object

String

directory

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

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

value String /www/img/volc/ Object 对应的具体对象

Auth_server

参数	类型	示例值	描述
address	String	`http://www.testa.com`	鉴权服务器的主地址
backup_address	String	`http://www.testb.com`	鉴权服务器的备地址
path_type	String	`constant`	鉴权请求的路径，取值如下所示： `constant`：表示鉴权请求中的路径与用户请求中的路径相同。 `variable`：表示您需要在 pathValue 参数中指定一个鉴权请求中的路径。
path_value	String	`/sig`	一个鉴权请求的路径
request_method	String	`default`	在发送鉴权请求时所使用的请求方法，取值如下所示： `default`：鉴权请求所使用的方法与用户的请求相同。 `get`：鉴权请求使用 GET 方法。 `post`：鉴权请求使用 POST 方法。 `head`：鉴权请求使用 HEAD 方法。

Auth_request_query

参数类型示例值描述

参数	类型	示例值	描述
action	String	`includePart`	鉴权请求是否包含用户请求 URL 中的查询参数。取值如下所示： `exclude`：表示鉴权请求不包含任何查询参数。 `include`：表示鉴权请求包含所有查询参数。 `includePart`：表示鉴权请求包含指定的查询参数。
value	String	`*`	Action 参数所对应的参数值
query	Array of Query	`-`	额外参数

action

String

includePart

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

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

value String * Action 参数所对应的参数值

query Array of Query - 额外参数

Auth_request_header

参数	类型	示例值	描述
host	String	`default`	鉴权请求中 HOST 头部的值，固定为 `default`，即 HOST 头部的值与您的加速域名相同。
action	String	`exclude`	鉴权请求头是否包含用户请求头，取值如下所示： `exclude`：表示鉴权请求头中不包含任何用户请求头。 `include`：表示鉴权请求头中包含所有用户请求头。 `includePart`：表示鉴权请求头包含指定的用户请求头。
value	String	`*`	Action 参数所对应的参数值
header	Array of Header	`-`	额外请求头

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`	您设置的鉴权请求参数
value_type	String	`variable`	您在 Key 中设置的鉴权请求参数的类型
value	String	`host`	鉴权请求参数的值

参数	类型	示例值	描述
key	String	`header1`	您设置的请求头
value_type	String	`h`	请求头的类型
value	String	`constant`	请求头的值

Auth_server_status_code

参数	类型	示例值	描述
fail_code	String	`407`	鉴权失败时的鉴权状态码
success_code	String	`200`	鉴权成功时的鉴权状态码
default_action	String	`reject`	如果鉴权状态码既不是 FailCode，又不是 SuccessCode 时，处理鉴权请求的方式

Auth_result_cache

参数类型示例值描述

参数	类型	示例值	描述
action	String	`nocache`	是否缓存鉴权状态码，取值如下所示： `nocache`：veImageX 不缓存鉴权状态码。 `cache`：veImageX 缓存鉴权状态码。
cache_key	Array of String	`[$URI,$host]`	缓存 key 指定了用于区分不同请求 URI 的查询参数
ttl	Integer	`5`	鉴权状态码的缓存时间，单位是秒

action

String

nocache

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

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

cache_key Array of String [$URI,$host] 缓存 key 指定了用于区分不同请求 URI 的查询参数

ttl Integer 5 鉴权状态码的缓存时间，单位是秒

Auth_server_timeout

参数类型示例值描述

time Integer 200 鉴权超时的时间，单位是毫秒。

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

action

String

reject

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

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

Response

参数	类型	示例值	描述
fail_code	String	`403`	鉴权失败时，响应用户的状态码

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetDomainConfig&Version=2018-08-01&DomainName=example.volcimagex.cn&ServiceId=yl***yn

{
    "ServiceId":"yl***yn",
    "DomainName":"example.volcimagex.cn",
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetDomainConfig",
    "Version": "2018-08-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {
    "domain": "21334iryawoieruy.volcimagex.cn",
        "resp_hdrs": [
            {
                "key": "Access-Control-Allow-Origin",
                "value": "*",
                "access_origin_control": false
            }
        ],
        "https_config": {
            "enable_https": true,
            "force_https": false,
            "cert_id": "dd68fe42b4f74231be96a75e7a2f9bc8",
            "enable_http2": true,
            "enable_quic": false,
            "enable_ocsp": false,
            "tls_versions": [
                "tlsv1.0",
                "tlsv1.1",
                "tlsv1.2"
            ],
            "enable_force_redirect": false,
            "force_redirect_type": "",
            "force_redirect_code": ""
        },
        "access_control": {
            "ip_auth": {
                "enabled": false,
                "is_white_mode": false,
                "values": [
                    "1.1.1.1"
                ],
                "regex_values": null
            },
            "refer_link": {
                "enabled": true,
                "is_white_mode": false,
                "values": [
                    "www.bytedance.com",
                    "www.fdjk.com"
                ],
                "regex_values": null,
                "allow_empty_refer": true,
                "regex_values_enabled": false
            },
            "url_auth": {
                "enabled": true,
                "type_a": {
                    "main_sk": "sksksksksksk",
                    "sign_param": "sign",
                    "expire_time": 1800
                }
            },
            "user_agent_acl": {
                "enabled": true,
                "rule_type": "deny",
                "user_agents": [
                    "asdfasfasdfadsf"
                ],
                "allow_empty": true
            },
            "area_acl": {
                "enabled": false,
                "rule_type": "deny",
                "areas": [
                    "CHE"
                ]
            },
            "bandwidth_limit": {
                "enabled": false,
                "threshold": 1000000000,
                "limit_type": "downloadspeedlimit",
                "speed_limit_rate": 1073741824,
                "speed_limit_rate_max": 1077936128
            },
            "download_speed_limit": {
                "enabled": false,
                "rules": null
            }
        },
        "status": "配置中",
        "advanced": {
            "enable_gzip": true,
            "enable_br": true,
            "enable_ipv6": false
        },
        "adaptfmt": true,
        "adapt_formats": [
            "webp",
            "avif",
            "heic"
        ],
        "check_adapt_fsize": true,
        "do_slim": false,
        "discard_slimed_file": false,
        "global_acceleration": false,
        "security_contact": "",
        "volc_cache": {
            "cache_lines": null
        },
        "volc_origin": {
            "use_imagex": false,
            "origins": [
                {
                    "origin_type": "primary",
                    "instance_type": "domain",
                    "address": "https://a.callback.com",
                    "http_port": "80",
                    "https_port": "443",
                    "weight": "1",
                    "origin_host": ""
                }
            ],
            "origin_protocol": "followclient",
            "origin_host": "",
            "origin_range": false
        },
        "origin_args": null,
        "request_headers": null,
        "origin_timeout": null,
        "lock_status": {
            "domain_locked": true,
            "browser_cache_locked": false,
            "cache_key_locked": false,
            "cache_locked": true,
            "compression_locked": true,
            "ip_access_rule_locked": true,
            "negative_cache_locked": false,
            "origin_locked": true,
            "referer_access_rule_locked": false,
            "remote_auth_locked": false,
            "request_header_locked": false,
            "response_header_locked": true,
            "share_cache_locked": false,
            "sign_url_auth_locked": false,
            "ua_access_rule_locked": false,
            "reason": "域名存在特殊配置"
        }
    }
}

错误码

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

veImageX

注意事项

请求说明

调试

请求参数

Query

返回参数

Resp_hdrs

Https_config

Access_control

Lock_status

Ip_auth

Refer_link

Ua_list

Url_auth

Remote_auth

Type_a

Type_b

Type_c

Type_d

Match_rule

Auth_server

Auth_request_query

Auth_request_header

Auth_response

Query

Header

Auth_server_status_code

Auth_result_cache

Auth_server_timeout

Response

示例

请求示例

返回示例

错误码