You need to enable JavaScript to run this app.
导航
查询域名详细配置
最近更新时间:2023.11.14 19:54:37首次发布时间:2022.03.02 11:29:34

API说明

API名称:DescribeDomainConfig。
API域名:open.volcengineapi.com。
API描述:查询全站加速域名的详细配置。

URI参数

公共参数

Action和Version需要放在请求 URL 后方参数中。

参数名称
是否必选
参数类型
参数说明
Action
String
API 名称,该参数的取值是 DescribeDomainConfig 。
Version
String
API 版本,该参数的取值是 2021-04-01 。

请求正文

在使用该 API 提交请求时,请求正文中可以包含的参数如下。

参数名称
是否必选
参数类型
参数说明
示例值
Domains[ ]String待查询域名列表。["www.test.com"]

响应正文

参数名称
参数类型
参数说明
示例
Domain
String
待查询的加速域名列表,匹配规则为模糊匹配,当域名匹配到其中任一个关键字时,就会返回对应数据。如域名列表[abc.com,abc.cn] ,关键词为abc,由于dabc.com 包含 abc.com,dabc.cn 包含 abc.cn,所以 dabc.com、dabc.cn会匹配到,返回对应数据。但是 abcd.com、abcd.cn不会匹配到。
["www.test1.com","www.test2.com"]
ProjectName
String
当前创建域名所归属的项目。
default
StrategyType
String
回源策略,支持取值:
  • wrr:加权轮询。
  • optimum:择优。
wrr
Scope
String
加速范围,当前仅对白名单用户开放。具体取值如下:
  • domestic(默认值):中国大陆。
  • overseas:中国大陆以外区域。
  • global:全球。
domestic
Cname
String
为加速域名生成的 Cname 。
www.test.com.a.b.com
IsCNAMEResolved
Boolean
加速域名是否被解析到CNAME,支持参数:
  • true:已解析。
  • false:未解析。
false
RecordFiling
String
当前域名备案状态,支持参数:
  • success:域名备案状态有效。
  • fail:域名备案状态失效。
  • recovery:域名备案状态从有效转为失效。
success
UserName
String
加速域名所属的用户 ID 。
2000000191
Status
String
加速域名所处的状态,具体包括:
  • Started:运行中。
  • Deploy:部署中。
  • Stop:已停止。
Started
CreateTime
String
创建加速域名的时间。时间格式遵循 RFC 3339 规范。
2023-01-04 16:55:55
UpdateTime
String
最近更新加速域名的时间。时间格式遵循 RFC 3339 规范。
2023-01-04 16:55:55
Origin
Origin
源站配置。
-
Https
Https
Https 加速配置。
-
EnableFailOver
Boolean
是否开启主备容灾功能,默认不启用,支持取值:
  • true:启用。
  • false:不启用。
false
IPv6Switch
Boolean
是否开启 IPv6 功能,通过 IPv6 协议访问全站加速节点和源站。默认不启用,支持取值:
  • true:启用。
  • false:不启用。
false
Cache
Cache
缓存配置。
-
UrlRedirect
UrlRedirect
Url 重写相关配置。当客户端请求资源的 URL 和全站加速节点上缓存的 URL 不一致时,您可以进行 URL 重写。
-
IpAccess
IpAccess
Ip 访问黑/白名单。为了解决恶意 IP 盗刷、攻击等问题,需要对访问来源进行限制,您可以在全站加速控制台配置 IP 黑白名单。
-
UserAgentAccess
UserAgentAccess
UserAgent 访问黑/白名单。如果您希望通过对用户 HTTP 请求头中的 UA 字段进行规则判断,从而进行访问者身份识别及过滤,您可以配置 User-Agent 黑白名单。
-
RefererAccess
RefererAccess
Referer 访问黑/白名单。为了防止网站资源被盗用,您可以配置 Referer 防盗链。
-
UrlAccess
UrlAccess
Url 鉴权。为了保护站点资源,避免资源被恶意下载盗用,您还可以通过配置 URL 鉴权,达到防止资源被非法下载盗用、提升内容安全性的目的。
-
WebSocket
Integer
WebSockect 相关配置。当您处于服务端主动推送数据信息到客户端、实时通讯性要求高的业务场景时,可以选择开启 WebSocket 服务。
-
GzipCompress
CmpTypeConf
Gzip压缩。开启Gzip压缩后,全站加速在返回内容时会对资源进行Gzip压缩,减少静态内容大小,节省开销。
-
BrCompress
CmpTypeConf
Br压缩。开启 Brotli 压缩后,全站加速在返回内容时会对资源进行 Brotli 压缩,减少静态内容大小,节省开销。
-
StaticOptimization
StaticOptimizationInfo
页面性能优化。H2协议多路复用场景下,通过调整缓冲区策略,控制静态资源请求优先级,实现静态页面加载性能优化。
-
BusinessScene
String
加速场景,此字段为空时默认为other。具体取值如下:
  • api:API加速场景。
  • page:页面加速场景。
  • other(默认值):其他加速场景。
other
PreConnect
PreConnect
预连接。开启后预连接后,DCDN服务主动与源站建立连接,维护连接池,提高回源连接复用率,缩短访问链路耗时。
-
RTTOptimize
RTTOptimize
回源链路择优。开启回源链路择优后,DCDN服务会选择最优的RTT链路回源,缩短访问链路耗时。
-

示例

请求示例

POST https://open.volcengineapi.com/?Version=2021-04-01&Action=DescribeDomainConfig&<其他公共请求参数>
{
    "Domains": ["www.test.com"]
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20220105******0102252431250711DE66",
        "Action": "DescribeDomainConfig",
        "Version": "2021-04-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
    "Result": [
        {
            "Domain": "www.test.com",
            "Cname": "www.test.com.a.b.com",
            "Status": "Deploy",
            "UserName": "2000000191",
            "CreateTime": "2021-12-12 19:17:17",
            "UpdateTime": "2022-01-05 18:35:38",
            "Origin": {
                "Origins": [
                    {
                        "Name": "36.150.2.22",
                        "Weight": 1
                    },
                    {
                        "Name": "219.151.146.52",
                        "Weight": 1
                    }
                ],
                "OriginType": "IP",
                "OriginProtocolType": "http",
                "BackupOrigins": [
                    {
                        "Name": "219.151.146.52",
                        "Weight": 1
                    }
                ],
                "BackupOriginType": "IP",
                "ResponseTimeout": 10,
                "ResponseHeader": {
                    "Enable": false,
                    "HeaderInfo": []
                },
                "OriginHost": {
                    "Enable": false,
                    "HostInfo": ""
                },
                "OriginSni": {
                    "Enable": false,
                    "SniInfo": ""
                },
                "OriginRange": {
                    "Enable": false,
                    "Size": ""
                }
            },
            "Https": {
                "Http2": false,
                "Hsts": {
                    "Enable": false,
                    "MaxAge": 0,
                    "IncludeSubDomain": false
                },
                "TlsVersions": {
                    "Enable": true,
                    "TlsVersion": [
                        "TLSv1",
                        "TLSv1.1",
                        "TLSv1.2"
                    ]
                },
                "CertBind": {
                    "CertSource": "self",
                    "CertId": "cert-rvAQS*****3tDseHQ3KGyA",
                    "CertName": "*.qa.com",
                    "DomainName": "www.test1.com",
                    "DomainId": "l7accdomain-u27eF8d*****ZUTBLnSJYA",
                    "DeployStatus": "Waiting",
                    "Expire": "2022-09-22T12:35:41Z"
                },
                "ForceRedirect": {
                    "Enable": false,
                    "RedirectType": "https"
                },
                "QUICSwitch": false
            },
            "StrategyType": "wrr",
            "EnableFailOver": true,
            "IpAccess": {
                "Enable": false,
                "FilterType": "",
                "FilterList": []
            },
            "UserAgentAccess": {
                "Enable": false,
                "FilterType": "",
                "FilterList": []
            },
            "RefererAccess": {
                "Enable": false,
                "AllowNone": false,
                "FilterType": "",
                "FilterList": []
            },
            "UrlAccess": {
                "Enable": false,
                "GenType": "",
                "GenKey": "",
                "GenTTL": 0
            },
            "IPv6Switch": false,
            "Cache": {
                "Enable": false,
                "CacheRules": [],
                "StatusCodeCacheRule": {
                    "Enable": true,
                    "Rules": [
                        {
                            "Status": "404",
                            "CacheTime": 10,
                            "CacheTimeUnit": "second",
                            "RespUrl": "",
                            "RespCode": ""
                        },
                        {
                            "Status": "405",
                            "CacheTime": 10,
                            "CacheTimeUnit": "second",
                            "RespUrl": "",
                            "RespCode": ""
                        },
                        {
                            "Status": "501",
                            "CacheTime": 10,
                            "CacheTimeUnit": "second",
                            "RespUrl": "",
                            "RespCode": ""
                        }
                    ]
                }
            },
            "RecordFiling": "recovery",
            "WebSocket": {
                "Enable": false,
                "Timeout": 0
            },
            "UrlRedirect": {
                "Enable": false,
                "Rules": []
            }
        }
    ]
}