You need to enable JavaScript to run this app.
导航

获取域名配置

最近更新时间2023.05.26 13:11:18

首次发布时间2021.02.23 10:42:23

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

请求说明

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

说明

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

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01
DomainNameString域名,您可以通过调用 GetServiceDomains 获取当前服务下所有域名。

ServiceId

String

服务 ID。

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

返回参数

参数类型描述
domainString域名
statusString域名状态

adaptfmt

Bool

是否开启自适应格式,取值如下所示:

  • true:开启自适应
  • false:关闭自适应

do_slim

Bool

是否开启集智瘦身,取值如下所示:

  • true:开启集智瘦身
  • false:关闭集智瘦身

global_acceleration

Bool

是否开启全球加速,取值如下所示:

  • true:开启全球加速
  • false:关闭全球加速

discard_slimed_file

Bool

集智瘦身是否关闭持久化,取值如下所示:

  • true:关闭
  • false:开启
adapt_formatsArray of String自适应格式列表

check_adapt_fsize

Bool

自适应格式是否开启体积校验,取值如下所示:

  • true:开启
  • false:关闭
resp_hdrsArray of resp_hdrsHTTP Header 配置
https_configObject of https_configHTTPS 配置
access_controlObject of access_control访问控制配置

resp_hdrs

参数类型描述
keyStringheader key
valueStringheader value

https_config

参数类型描述

enable_https

Bool

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

  • true:开启 HTTPS
  • false:关闭 HTTPS

force_https

Bool

是否强制使用 HTTPS,取值如下所示:

  • true:强制 HTTPS
  • false:不强制 HTTPS
cert_idString证书 ID,若enable_httpstrue,则为必选。

enable_http2

Bool

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

  • true:开启 HTTP2
  • false:关闭 HTTP2

access_control

参数类型描述
ip_authObject of ip_authIP 访问控制配置
refer_linkObject of refer_linkReferer 访问限制配置
ua_listObject of ua_listUA 访问控制配置
url_authObject of url_authURL 鉴权配置

ip_auth

参数类型描述

enabled

Bool

是否开启 IP 访问控制,取值如下所示:

  • true:开启 IP 访问控制
  • false:关闭 IP 访问控制

is_white_mode

Bool

是否是白名单模式,取值如下所示:

  • true:白名单模式
  • false:黑名单模式
valuesArray of StringIP 列表
参数类型描述

enabled

Bool

是否开启 Referer 访问限制,取值如下所示:

  • true:开启 Referer 访问限制
  • false:关闭 Referer 访问限制

is_white_mode

Bool

是否是 Referer 白名单模式,取值如下所示:

  • true:白名单模式
  • false:黑名单模式

说明

is_white_modefalse时,即选用黑名单时,需确保allow_empty_refertrue

allow_empty_refer

Bool

是否允许空 Referer,取值如下所示:

  • true:允许空 Referer
  • false:禁止空 Referer
valuesArray of StringReferer 列表

ua_list

参数类型描述

enabled

Bool

是否开启 UA 访问控制,取值如下所示:

  • true:开启 UA 访问控制
  • false:关闭 UA 访问控制

is_white_mode

Bool

是否是白名单模式,取值如下所示:

  • true:白名单模式
  • false:黑名单模式
valuesArray of StringUA 列表

url_auth

参数类型描述

enabled

Bool

是否开启 URL 鉴权 ,取值如下所示:

  • true:开启 URL 鉴权
  • false:关闭 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"
        }
    }
}

错误码

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