获取加速域名列表--内容分发网络-火山引擎

文档中心

立即注册

导航

获取加速域名列表

最近更新时间：2025.01.08 11:45:41首次发布时间：2021.09.23 10:58:44

获取 CDN 中的加速域名列表并展示每个域名的基础信息。基础信息包含业务类型、状态、CNAME、加速区域等。要获取一个域名的 CDN 特性配置，请调用 DescribeCdnConfig。

该 API 提供了一系列的过滤类型。您可以根据需要指定一种或多种过滤类型，以获取符合过滤条件的域名列表。

使用限制

节流限制：您每秒最多可以发送 20 个请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=ListCdnDomains&Version=2021-03-01

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	否	表示一个字符串，用来对域名进行过滤，获取包含该字符串的域名。	`example`
ServiceType	String	否	表示一个业务类型，用来对域名进行过滤，获取该业务类型的域名。该参数有以下取值： `download`：表示文件下载。 `web`：表示网页。 `video`：表示音视频点播。	`web`
ResourceTags	String[]	否	表示一个标签列表，用于对域名进行过滤，获取带有列表中任意标签的域名。列表中最多可以包含 10 个标签，每个标签的格式是 `key:value`。参见右边该参数的示例。	`["key1:val1","key2:val2"]`
Status	String	否	表示一个域名状态，用来对域名进行过滤，获取该状态下的域名。该参数有以下取值： `online`：表示 "正常运行"。 `configuring`：表示 "配置中"。 `offline`：表示 "已下线"。	`offline`
Project	String	否	表示一个项目，获取归属该项目的域名。	`default`
OriginProtocol	String	否	表示一个协议，获取回源请求使用该协议的域名。该参数有以下取值： `http`：表示 HTTP 协议。 `https`：表示 HTTPS 协议。 `followclient`：表示用户请求使用的协议。	`http`
IPv6	Boolean	否	表示根据是否启用了 IPv6 特性来过滤域名。该参数有以下取值： `true`: 表示 IPv6 已启用。 `false`: 表示 IPv6 未启用。	`true`
HTTPS	Boolean	否	表示根据是否启用了 HTTPS 特性来过滤域名。该参数有以下取值： `true`: 表示 HTTPS 已启用。 `false`: 表示 HTTPS 未启用。	`true`
PrimaryOrigin	String	否	表示一个主源站，以获取主源站配置中包含该主源站的那些域名。该参数值可以是一个 IP 地址，也可以是一个域名。	`1.2.3.4`
PageNum	Long	否	表示一个页码，用以获取该页面上域名列表。该参数的默认值为 `1`。 CDN 对符合过滤条件的域名进行分页。您可以根据响应参数 `Total` 和请求参数 `PageSize` 计算该 API 返回的页数。	`1`
PageSize	Long	否	表示每页包含的域名数量。该参数的取值范围是 1-100，默认值是 `10`。	`10`

返回参数

参数名称	数据类型	参数说明	示例
PageNum	Long	表示请求参数中的 `PageNum`。	`1`
PageSize	Long	表示请求参数中的 `PageSize`。	`10`
Total	Long	表示符合过滤条件的域名数量。该参数值不受请求参数 `PageSize` 和 `PageNum` 的影响。	`100`
Data	Object[]	表示符合过滤条件的域名列表。

请求示例

POST https://cdn.volcengineapi.com/?Action=ListCdnDomains&Version=2021-03-01
{
  "Domain": "www.example.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241102221914EDC0E332B563353F4456",
        "Action": "ListCdnDomains",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "Data": [
            {
                "BackupOrigin": [
                    "backup.example.com"
                ],
                "CacheShared": "cache_shared_on",
                "CacheSharedTargetHost": "test.example.com",
                "Cname": "www.example.com.volcgslb.com",
                "ConfigStatus": "FullDeployed",
                "CreateTime": 1717419262,
                "Domain": "www.example.com",
                "DomainLock": {
                    "Remark": "",
                    "Status": "off"
                },
                "HTTPS": true,
                "IPv6": false,
                "IsConflictDomain": false,
                "OriginProtocol": "http",
                "PrimaryOrigin": [
                    "primary.example.com",
                    "192.168.1.1"
                ],
                "Project": "default",
                "ResourceTags": [
                    {
                        "Key": "tag1",
                        "Value": "value1"
                    },
                    {
                        "Key": "tag2",
                        "Value": "value2"
                    }
                ],
                "ServiceRegion": "chinese_mainland",
                "ServiceType": "web",
                "Status": "online",
                "UpdateTime": 1730557083
            }
        ],
        "PageNum": 1,
        "PageSize": 10,
        "Total": 1
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。