请求说明

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

调试

API Explorer

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

去调试

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Domains	String[]	否	待查询的加速域名列表。匹配规则为模糊匹配。当域名匹配到其中任一个关键字时，就会返回对应数据。如域名列表`["abc.com","abc.cn"]`，关键词为abc，由于dabc.com 包含 abc.com，dabc.cn 包含 abc.cn，所以 dabc.com、dabc.cn会匹配到，返回对应数据。但是 abcd.com、abcd.cn不会匹配到。	`["www.test.com","www.test2.com"]`
HTTPs	Boolean	否	过滤参数，查询的域名是否开启了 HTTPS 功能	`true`
Keyword	String	否	过滤参数，查询的域名是否包含该关键字，可以用来模糊匹配加速域名。	`test.com`
OriginType	String[]	否	过滤参数，查询的域名的源站所属类型，支持参数范围： `IP`：IP 源站 `Domain`：域名源站 `IP_Domain`：同时包含 IP 和域名源站 `TOS`：TOS 源站 `ALB`：ALB 源站 `GA`：GA 源站	`["Domain"]`
PageNumber	Integer	否	分页参数，页码，大于0小于100000，不输入时默认为1。	`2`
PageSize	Integer	否	分页参数，页大小，大于0小于10000，不输入或输入为0时默认为查询所有域名。	`10`
ProjectName	String[]	否	过滤参数，查询的域名所在的项目列表范围	`["default"]`
Scope	String[]	否	过滤参数，加速区域。取值： `domestic`：中国大陆。 `overseas`：中国大陆以外区域。 `global`：全球。	`["domestic"]`
Status	String[]	否	过滤参数，查询的域名当前所处的范围，取值范围如下： `Stop`：已停止 `Deploy`：部署中 `Started`：运行中	`["Started"]`
TimeSortOrder	String	否	设置返回的域名列表按照创建时间排序规则，默认后创建的域名排序靠前（降序），支持参数范围： `descending`：创建时间降序 `ascending`：创建时间升序	`descending`

返回参数

参数名称	数据类型	参数说明	示例
DomainConfigs	Object[]	返回的域名详细信息。
Total	Integer	对应筛选条件下的域名总数。	`10`

请求示例

POST https://open.volcengineapi.com?Action=ListDomainConfig&Version=2021-04-01
{
    "Domains": [
        "www.test.com"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220105******0102252431250711DE66",
        "Action": "ListDomainConfig",
        "Version": "2021-04-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "DomainConfigs": [
            {
        "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,
                "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": []
        }
    }
        ],
        "Total": 1
    }
}

错误码

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

最近更新时间：2026.08.19 16:43:17

这个页面对您有帮助吗？

有用

无用

全站加速

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求说明

调试

请求参数

Query

Body

返回参数

请求示例

返回示例

错误码