You need to enable JavaScript to run this app.
文档中心
全站加速

全站加速

请输入
  • 文档首页
    • 全站加速开发指南API参考域名管理接口 查询单个域名详细配置
复制全文
下载 pdf
我的收藏
域名管理接口
查询单个域名详细配置
复制全文
下载 pdf
我的收藏
查询单个域名详细配置

查询单个全站加速域名的详细配置。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=DescribeDomainDetail&Version=2021-04-01

调试

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

请求参数

Query

参数名称
数据类型
是否必选
参数说明
Action
String
是
接口名称。当前 API 的名称为 DescribeDomainDetail。
Version
String
是
接口版本。当前 API 的版本为 2021-04-01。

Body

参数名称
数据类型
是否必选
参数说明
示例
Domain
String
是
待查询的加速域名的名称。
www.test.com

返回参数

参数名称
数据类型
参数说明
示例
Domain
String
您需要查询的域名名称。
www.test.com
ProjectName
String
当前域名所归属的项目。
default
StrategyType
String

回源策略，支持取值：

  • wrr：加权轮询。
  • optimum：按照健康度选择最优源站。
wrr
Scope
String

加速区域（访问用户所在的区域），当前仅对白名单用户开放。详细信息，请见修改基础配置。取值：

  • domestic（默认值）：中国大陆。
  • overseas：中国大陆以外区域。
  • global：全球。
domestic
Cname
String
全站加速为加速域名生成的 CNAME。
xxxxxx.test.com.c.vedcdnlb.com
IsCNAMEResolved
Boolean

加速域名是否被成功解析到全站加速提供的 CNAME，取值：

  • true：已解析。
  • false：未解析。

说明

对于每个加速域名，您需要在您对应的 DNS 服务提供商处添加一条与加速域名同名的 CNAME 记录，将其值指向全站加速为您创建的 CNAME。具体操作请参考配置CNAME解析。全站加速如果能够将您的加速域名解析到对应的 CNAME 时，此选项会被设为 true。

true
RecordFiling
String

当前域名备案状态，取值：

  • success：域名备案状态有效。
  • fail：域名备案状态失效。
  • recovery：域名备案状态从有效转为失效。
success
UserName
String
加速域名所属的用户 ID 。
2000000191
Status
String

加速域名的状态，取值：

  • Started：运行中。
  • Deploy：部署中。
  • Stop：已停止。
Stop
CreateTime
String
创建加速域名的时间。时间格式遵循 RFC 3339 规范。
2023-01-04 16:55:55
UpdateTime
String
最近更新加速域名的时间。时间格式遵循 RFC 3339 规范。
2023-01-04 16:55:55
Origin
Object
回源配置。
Https
Object
HTTPS 加速配置。
EnableFailOver
Boolean

是否开启主备容灾功能，默认不启用，支持取值：

  • true：启用。
  • false：不启用。
true
IPv6Switch
Boolean

是否开启 IPv6 功能，客户端和边缘节点通过 IPv6 协议通信。默认不启用，支持取值：

  • true：启用。
  • false：不启用。
false
Cache
Object
缓存配置。
UrlRedirect
Object
URL 重定向相关配置。当客户端请求资源的 URL 和全站加速节点上缓存的 URL 不一致时，您可以进行 URL 重定向。
IpAccess
Object
基于客户端源 IP 地址的访问黑/白名单。为了解决来自某些特定 IP 的恶意盗刷、攻击等问题，需要对访问来源进行限制，您可以配置 IP 黑白名单。
UserAgentAccess
Object
基于客户端 UserAgent 的访问黑/白名单。如果您希望通过对用户 HTTP 请求头中的 User-Agent 字段进行规则判断，从而基于客户端类型进行过滤，您可以配置 User-Agent 黑白名单。
RefererAccess
Object
基于 Referer 访问黑/白名单。为了防止网站资源被盗用，您可以配置 Referer 防盗链。
UrlAccess
Object
URL 鉴权。为了保护站点资源，避免资源被恶意下载盗用，您还可以通过配置 URL 鉴权，达到防止资源被非法下载盗用、提升内容安全性的目的。
WebSocket
Object
WebSocket 相关配置。当您处于服务端主动推送数据信息到客户端、实时通讯性要求高的业务场景时，可以选择开启 WebSocket 服务。
GzipCompress
Object
Gzip 压缩。开启 Gzip 压缩后，全站加速在返回内容时会对资源进行 Gzip 压缩，缩减静态内容尺寸，从而缩短传输时间。
BrCompress
Object
Brotli 压缩。开启 Brotli 压缩后，全站加速在返回内容时会对资源进行 Brotli，缩减静态内容尺寸，从而缩短传输时间。当客户端和全站加速同时都支持 Gzip 压缩和 Brotli 压缩时，Brotli 压缩会被优先采用。
StaticOptimization
Object
页面性能优化。HTTP/2 协议多路复用场景下，通过调整缓冲区策略，控制静态资源请求优先级，实现静态页面加载性能优化。
UploadOptimize
Object
上传协议优化。开启上传协议优化后，全站加速通过自研协议栈优化策略，提升文件接收和传输性能。
ResourceTags
Object[]
绑定在该域名上的资源标签（Tag）信息。
ServiceType
String

该加速域名关联的加速场景，取值：

  • ai：AI 加速
  • upload：上传加速
  • page：页面加速
  • api：API 加速
  • other：其他
api
RTTOptimize
Object
回源链路择优。开启回源链路择优后，DCDN服务会选择最优的RTT链路回源，缩短访问链路耗时。
PreConnect
Object

预连接。开启后预连接后，DCDN服务主动与源站建立连接，维护连接池，提高回源连接复用率，缩短访问链路耗时。

注意

预连接不会向源站发送 HTTP 请求，不会引起额外的请求数费用。开启后可能对源站造成 5～20Mbps 带宽增长，建议评估源站带宽容量后再开启。

EnableCRB
Boolean

加速域名是否绑定跨境带宽包：

  • true：已绑定。
  • false：未绑定。
PremiumBGPPackage
Object
跨境链路优化相关配置.

请求示例 

POST https://open.volcengineapi.com?Action=DescribeDomainDetail&Version=2021-04-01
{
    "Domain": "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": "203.0.113.9",
                    "Weight": 1
                },
                {
                    "Name": "203.0.113.10",
                    "Weight": 1
                }
            ],
            "OriginType": "IP",
            "OriginProtocolType": "http",
            "BackupOrigins": [
                {
                    "Name": "198.51.100.8",
                    "Weight": 1
                }
            ],
            "BackupOriginType": "IP",
            "ResponseTimeout": 10,
            "ResponseHeader": {
                "Enable": false,
                "HeaderInfo": []
            },
            "OriginHost": {
                "Enable": false,
                "HostInfo": ""
            },
            "OriginSni": {
                "Enable": false,
                "SniInfo": ""
            },
            "OriginRange": {
                "Enable": false
            }
        },
        "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": []
        }
    }
}

错误码

如果接口调用失败并返回错误信息，您可以查看公共错误码了解错误码相关信息。

最近更新时间：2026.08.19 21:09:00
这个页面对您有帮助吗？
有用
有用
无用
无用