You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /
  • 内容分发网络

获取加速域名列表

最近更新时间：2024.01.31 10:43:30

首次发布时间：2021.09.23 10:58:44

我的收藏

通过 API 请求查询已经接入 CDN 服务的全量域名清单及每一个域名的基础信息，包括业务类型、运行状态、CNAME 地址、加速区域等。更详细的域名配置需要调用 DescribeCdnConfig 获取。

使用限制

节流限制：您每秒最多可以发送 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
否
指定一种域名业务类型进行查询：
web：网页/小文件加速；
download：大文件下载加速；
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
否
指定一个主源站对加速域名进行筛选。
1.2.3.4
PageNum
Long
否

请求的页码。 默认值为1。如果页面不存在，则响应正文中不包含任何域名信息。

建议第一次提交查询任务时使用默认值。 根据响应中的 Total 和 PageSize 参数的值计算页数。 然后就可以根据需要在查询任务中指定一个 PageNum 来获取相应页面中的任务信息。
1
PageSize
Long
否
查询结果中每页的任务数量。默认值是 10，最大值是 100。
10

响应正文

参数名称
数据类型
参数说明
示例
PageNum
Long
调用时请求的页码。
1
PageSize
Long
调用时请求的每页的任务数量。
10
Total
Long
符合查询条件的总域名数量，用于分页。
100
Data
Object[]
查询结果清单。

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2023050920020063355B94DB6C32617243",
    "Action": "ListCdnDomains",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "Data": [
      {
        "BackupOrigin": null,
        "CacheShared": "target_host",
        "CacheSharedTargetHost": "",
        "Cname": "www.example.com.volcgslb.com",
        "ConfigStatus": "FullDeployed",
        "CreateTime": 1683222860,
        "Domain": "www.example.com",
        "DomainLock": {
          "Remark": "",
          "Status": "off"
        },
        "HTTPS": false,
        "IPv6": false,
        "IsConflictDomain": false,
        "OriginProtocol": "http",
        "PrimaryOrigin": [
          "test.com"
        ],
        "Project": "default",
        "ResourceTags": [],
        "ServiceRegion": "chinese_mainland",
        "ServiceType": "download",
        "SparrowList": [],
        "Status": "online",
        "UpdateTime": 1683224280
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "Total": 1
  }
}

错误码

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