You need to enable JavaScript to run this app.
文档中心
视频点播

视频点播

复制全文
下载 pdf
点播 CDN
ListVodDomains - 获取域名列表
复制全文
下载 pdf
ListVodDomains - 获取域名列表

调用 ListVodDomains 接口获取指定空间内不同域名类型和源站类型的域名信息。

注意事项

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

请求说明

  • 请求方式:POST
  • 请求地址:https://vod.volcengineapi.com?Action=ListVodDomains&Version=2026-01-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

Query

参数
类型
是否必选
示例值
描述
Action
String
ListVodDomains
接口名称。当前 API 的名称为 ListVodDomains
Version
String
2026-01-01
接口版本。当前 API 的版本为 2026-01-01

Body

参数
类型
是否必选
示例值
描述
SpaceName
String
test

点播空间名称。您可通过以下方式获取空间名称:

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
DomainType
String
vod_play

域名源站类型。多个用英文逗号 , 隔开。如该参数为空,则默认获取全部。支持以下取值:

  • vod_play:点播加速域名。
  • vod_image:封面加速域名。
  • third:自定义加速域名。
ListCdnDomainsParam
Object
-
CDN 接口参数。
Domain
String
example;test
表示要查询的域名。多个域名用分号 ; 隔开。
PageNum
Long
1
表示页码,用以获取该页面上域名列表。该参数默认值为1。CDN 对符合过滤条件的域名进行分页。
PageSize
Long
10
表示每页包含的域名数量。该参数的取值范围是1-100,默认值为10
ExactMatch
Boolean
true

表示是否对 Domain 使用精确搜索。该参数支持以下取值:

  • true:(默认)表示对 Domain 使用精确匹配。
  • false:表示对 Domain 使用模糊匹配。

说明

单个 ExactMatch = false 时,Domain字段只能传入一个域名。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数
类型
示例值
描述
VodInfo
Object
-
VOD 相关信息。
Total
Long
1
表示符合过滤条件的域名数量。该参数值不受请求参数 PageSizePageNum 的影响。
Domains
Object[]
-
表示符合过滤条件的域名列表。
Cname
String
www.example.com.volcgslb.com
表示 CDN 分配给该域名的 CNAME。
Domain
String
www.example.com
域名。
Sources
Object[]
-
回源存储桶信息
BucketName
String
example
回源桶名称。
BucketRegion
String
**
回源桶区域。
BucketSourceType
String
vod

回源存储源类型。支持的取值如下:

  • vod:点播存储。
  • tos:挂载对象存储。
CreateTime
String
1625587200
表示该域名添加到 CDN 中的时间,格式为 Unix 时间戳。
DomainType
String
vod_play

域名源站类型。支持以下取值:

  • vod_play:点播加速域名。
  • vod_image:封面加速域名。
  • third:自定义加速域名。
CnameStatus
String
enable

CNAME 解析状态。取值如下:

  • enable:成功。
  • disable:失败。
BusinessType
String
video

表示该域名的业务类型。该参数有以下取值:

  • download:表示文件下载。
  • web:表示网页。
  • video:表示音视频点播。
PreviewStatus
String
enable

表示该点播加速域名的试看功能开关状态。支持的取值如下所示:

  • enable:试看功能已开启;
  • disable:试看功能已关闭。
SchedulerStatus
String
enable

点播调度状态。取值如下:

  • enable:已开启。
  • disable:已关闭。
RealTimeProcessSwitch
String
enable

是否开启视频实时处理。开启后,支持基于 URL Path 发起实时转码任务。详细信息,请见实时转码

  • enable:开启
  • disable:关闭
PageNum
Long
1
表示请求参数中的 PageNum
PageSize
Long
10
表示请求参数中的 PageSize
SpaceName
String
spacename
点播空间名。
DefaultPlayDomain
String
www.example.com
默认播放域名。
DomainInfo
Object
-
CDN 返回的域名信息。
Data
Object[]
-
表示符合过滤条件的域名列表。
IPv6
Boolean
true

表示该域名是否启用了 IPv6 特性。该参数有以下取值:

  • true: 表示 IPv6 已启用。
  • false: 表示 IPv6 未启用。
Cname
String
www.example.com.volcgslb.com
表示 CDN 分配给该域名的 CNAME。
HTTPS
Boolean
true

表示该域名是否启用了 HTTPS 特性。该参数有以下取值:

  • true: 表示 HTTPS 已启用。
  • false: 表示 HTTPS 未启用。
Domain
String
www.example.com
表示列表中的一个域名。
Status
String
online

表示该域名的状态。该参数有以下取值:

  • online:表示状态是 "正常运行"。
  • configuring:表示状态是 "配置中"。
  • offline:表示状态是 "已下线"。
Project
String
default
表示该域名所属的项目。
CreateTime
Long
1625587200
表示该域名的创建时间,格式为 Unix 时间戳。
DomainLock
Object
-
表示该域名的锁定状态。
Remark
String
域名锁定,不允许自助配置操作,域名下线
  • 如果 Statuson,该参数表示锁定的原因。
  • 如果 Statusoff,该参数值是空("")。
Status
String
on

表示该域名是否被锁定。该参数支持以下取值:

  • on:表示该域名已被锁定。
  • off:表示该域名未被锁定。
UpdateTime
Long
1601371409
表示该域名更新时间,格式是 Unix 时间戳。更新操作包括启用域名、停用域名、修改域名配置等。
BackupCname
String
www.backup.com.volcgslb.com
备用 CNAME。如果该域名没有配置任何备用 CNAME,该参数值是null
CacheShared
String
target_host

表示该加速域名在共享缓存配置中的角色。该参数有以下取值:

  • target_host:表示存在一个共享缓存配置,在该配置中该加速域名的角色是目标域名。
  • cache_shared_on:表示存在一个共享缓存配置,在该配置中该加速域名的角色是被配置的域名。
  • "":该参数值为空,表示该加速域名不存在于任何共享缓存配置中。
ServiceType
String
web

表示该域名的业务类型。该参数有以下取值:

  • download:表示文件下载。
  • web:表示网页。
  • video:表示音视频点播。
BackupOrigin
String[]
null
表示该域名配置的备源站列表。如果该域名没有配置任何备源站,该参数值是null
ConfigStatus
String
表示配置下发状态
ResourceTags
Object[]
-
表示该域名带的标签列表。如果该域名没有任何标签,该参数值是null
Key
String
userKey
表示一个标签的名称,可以包含字母和数字,长度不超过 128 个字符。
Value
String
userValue
表示该标签的值,可以包含字母和数字,长度不超过 128 个字符。
PrimaryOrigin
String[]
helloworld.example.com
表示一个主源站,以获取主源站配置中包含该主源站的那些域名。该参数值可以是一个 IP 地址,也可以是一个域名。
ServiceRegion
String
chinese_mainland

表示该域名的加速区域。该参数有以下取值:

  • chinese_mainland:表示中国内地。
  • global:表示全球。
  • outside_chinese_mainland:表示全球(不含中国内地)。
OriginProtocol
String
http

表示一个协议,获取回源请求使用该协议的域名。该参数有以下取值:

  • http:表示 HTTP 协议。
  • https:表示 HTTPS 协议。
  • followclient:表示用户请求使用的协议。
IsConflictDomain
Boolean
true

表示该域名是否是一个冲突域名。在 CDN 中,每个域名都是唯一的。如果您需要添加一个已存在于其他火山引擎主账号下的域名,您需要提交工单。如果您成功在您的主账号下添加了该域名,则该域名就是一个冲突域名。该参数有以下取值:

  • true:表示该域名是冲突域名。
  • false:表示该域名不是冲突域名。
CacheSharedTargetHost
String
www.test.com
如果CacheSharedcache_shared_on,表示与该加速域名共享缓存的目标域名。如果CacheSharedtarget_host 或者是空值(""),该参数值是空("")。
Total
Long
100
表示符合过滤条件的域名总数量。该参数不受请求参数 PageSizePageNum 的影响。
PageNum
Long
1
表示请求参数中的 PageNum
PageSize
Long
10
表示请求参数中的 PageSize

错误码

本接口无特有的错误码。更多信息请见公共错误码

最近更新时间:2026.06.10 15:50:40
这个页面对您有帮助吗?
有用
有用
无用
无用