最近更新时间:2023.05.26 13:11:18
首次发布时间:2021.02.23 10:42:23
通过指定服务 ID 以及域名,获取当前域名的配置信息。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称。 |
Version | String | 是 | 接口版本。veImageX 当前 API 的版本为 2018-08-01 。 |
DomainName | String | 是 | 域名,您可以通过调用 GetServiceDomains 获取当前服务下所有域名。 |
ServiceId | String | 是 | 服务 ID。 |
参数 | 类型 | 描述 |
---|---|---|
domain | String | 域名 |
status | String | 域名状态 |
adaptfmt | Bool | 是否开启自适应格式,取值如下所示:
|
do_slim | Bool | 是否开启集智瘦身,取值如下所示:
|
global_acceleration | Bool | 是否开启全球加速,取值如下所示:
|
discard_slimed_file | Bool | 集智瘦身是否关闭持久化,取值如下所示:
|
adapt_formats | Array of String | 自适应格式列表 |
check_adapt_fsize | Bool | 自适应格式是否开启体积校验,取值如下所示:
|
resp_hdrs | Array of resp_hdrs | HTTP Header 配置 |
https_config | Object of https_config | HTTPS 配置 |
access_control | Object of access_control | 访问控制配置 |
参数 | 类型 | 描述 |
---|---|---|
key | String | header key |
value | String | header value |
参数 | 类型 | 描述 |
---|---|---|
enable_https | Bool | 是否开启 HTTPS,取值如下所示:
|
force_https | Bool | 是否强制使用 HTTPS,取值如下所示:
|
cert_id | String | 证书 ID,若enable_https 为true ,则为必选。 |
enable_http2 | Bool | 是否开启 HTTP2,取值如下所示:
|
参数 | 类型 | 描述 |
---|---|---|
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 鉴权配置 |
参数 | 类型 | 描述 |
---|---|---|
enabled | Bool | 是否开启 IP 访问控制,取值如下所示:
|
is_white_mode | Bool | 是否是白名单模式,取值如下所示:
|
values | Array of String | IP 列表 |
参数 | 类型 | 描述 |
---|---|---|
enabled | Bool | 是否开启 Referer 访问限制,取值如下所示:
|
is_white_mode | Bool | 是否是 Referer 白名单模式,取值如下所示:
说明 当 |
allow_empty_refer | Bool | 是否允许空 Referer,取值如下所示:
|
values | Array of String | Referer 列表 |
参数 | 类型 | 描述 |
---|---|---|
enabled | Bool | 是否开启 UA 访问控制,取值如下所示:
|
is_white_mode | Bool | 是否是白名单模式,取值如下所示:
|
values | Array of String | UA 列表 |
参数 | 类型 | 描述 |
---|---|---|
enabled | Bool | 是否开启 URL 鉴权 ,取值如下所示:
|
GET https://imagex.volcengineapi.com/?Action=GetDomainConfig&Version=2018-08-01 { "ServiceId":"yl***yn", "DomainName":"example.volcimagex.cn", }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "GetDomainConfig", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1" }, "Result":{ "domain":"s.imagex.com", "resp_hdrs":[{"orig":"syq"}], "status":"正常" }"resp_hdrs":[ { "key":"exercitation Lorem in", "value":"sunt" } ], "domain":"non dolore in", "status":"commodo pariatur", "adaptfmt":false, "do_slim":true, "global_acceleration":false, "access_control":{ "ua_list":{ "is_white_mode":true, "enabled":true, "values":null }, "url_auth":{"enabled":true}, "ip_auth":{"values":["irure occaecat aute elit"], "enabled":false, "is_white_mode":true }, "refer_link":{ "allow_empty_refer":true, "values":["aliqua amet adipisicing aliquip velit"], "is_white_mode":true, "enabled":true } }, "https_config":{ "enable_https":false, "cert_id":"amet in", "enable_http2":true, "force_https":false } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "GetDomainConfig", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1", "Error": { "Code": "GetDomainConfig Err", "Message": "backed error" } } }