调用 ListVodDomains 接口获取指定空间内不同域名类型和源站类型的域名信息。
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListVodDomains | 接口名称。当前 API 的名称为 ListVodDomains。 |
Version | String | 是 | 2026-01-01 | 接口版本。当前 API 的版本为 2026-01-01。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
SpaceName | String | 是 | | |
DomainType | String | 否 | | 域名源站类型。多个用英文逗号
|
ListCdnDomainsParam | Object | 否 | - | CDN 接口参数。 |
Domain | String | 否 | | 表示要查询的域名。多个域名用分号 ; 隔开。 |
PageNum | Long | 否 | | 表示页码,用以获取该页面上域名列表。该参数默认值为 1。CDN 对符合过滤条件的域名进行分页。 |
PageSize | Long | 否 | | 表示每页包含的域名数量。该参数的取值范围是1-100,默认值为 10。 |
ExactMatch | Boolean | 否 | | 表示是否对 Domain 使用精确搜索。该参数支持以下取值:
说明 单个 ExactMatch = false 时, |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
VodInfo | Object | - | VOD 相关信息。 |
Total | Long | 1 | 表示符合过滤条件的域名数量。该参数值不受请求参数 PageSize 和 PageNum 的影响。 |
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 | 回源存储源类型。支持的取值如下:
|
CreateTime | String | 1625587200 | 表示该域名添加到 CDN 中的时间,格式为 Unix 时间戳。 |
DomainType | String | vod_play | 域名源站类型。支持以下取值:
|
CnameStatus | String | enable | CNAME 解析状态。取值如下:
|
BusinessType | String | video | 表示该域名的业务类型。该参数有以下取值:
|
PreviewStatus | String | enable | 表示该点播加速域名的试看功能开关状态。支持的取值如下所示:
|
SchedulerStatus | String | enable | 点播调度状态。取值如下:
|
RealTimeProcessSwitch | String | enable | 是否开启视频实时处理。开启后,支持基于 URL Path 发起实时转码任务。详细信息,请见实时转码。
|
PageNum | Long | 1 | 表示请求参数中的 PageNum。 |
PageSize | Long | 10 | 表示请求参数中的 PageSize。 |
SpaceName | String | spacename | 点播空间名。 |
DefaultPlayDomain | String | www.example.com | 默认播放域名。 |
DomainInfo | Object | - | CDN 返回的域名信息。 |
Data | Object[] | - | 表示符合过滤条件的域名列表。 |
IPv6 | Boolean | | 表示该域名是否启用了 IPv6 特性。该参数有以下取值:
|
Cname | String | | 表示 CDN 分配给该域名的 CNAME。 |
HTTPS | Boolean | | 表示该域名是否启用了 HTTPS 特性。该参数有以下取值:
|
Domain | String | | 表示列表中的一个域名。 |
Status | String | | 表示该域名的状态。该参数有以下取值:
|
Project | String | | 表示该域名所属的项目。 |
CreateTime | Long | | 表示该域名的创建时间,格式为 Unix 时间戳。 |
DomainLock | Object | - | 表示该域名的锁定状态。 |
Remark | String | |
|
Status | String | | 表示该域名是否被锁定。该参数支持以下取值:
|
UpdateTime | Long | | 表示该域名更新时间,格式是 Unix 时间戳。更新操作包括启用域名、停用域名、修改域名配置等。 |
BackupCname | String | | 备用 CNAME。如果该域名没有配置任何备用 CNAME,该参数值是 null。 |
CacheShared | String | | 表示该加速域名在共享缓存配置中的角色。该参数有以下取值:
|
ServiceType | String | | 表示该域名的业务类型。该参数有以下取值:
|
BackupOrigin | String[] | | 表示该域名配置的备源站列表。如果该域名没有配置任何备源站,该参数值是 null。 |
ConfigStatus | String | 表示配置下发状态 | |
ResourceTags | Object[] | - | 表示该域名带的标签列表。如果该域名没有任何标签,该参数值是 null。 |
Key | String | userKey | 表示一个标签的名称,可以包含字母和数字,长度不超过 128 个字符。 |
Value | String | userValue | 表示该标签的值,可以包含字母和数字,长度不超过 128 个字符。 |
PrimaryOrigin | String[] | helloworld.example.com | 表示一个主源站,以获取主源站配置中包含该主源站的那些域名。该参数值可以是一个 IP 地址,也可以是一个域名。 |
ServiceRegion | String | chinese_mainland | 表示该域名的加速区域。该参数有以下取值:
|
OriginProtocol | String | http | 表示一个协议,获取回源请求使用该协议的域名。该参数有以下取值:
|
IsConflictDomain | Boolean | true | 表示该域名是否是一个冲突域名。在 CDN 中,每个域名都是唯一的。如果您需要添加一个已存在于其他火山引擎主账号下的域名,您需要提交工单。如果您成功在您的主账号下添加了该域名,则该域名就是一个冲突域名。该参数有以下取值:
|
CacheSharedTargetHost | String | www.test.com | 如果 CacheShared 是 cache_shared_on,表示与该加速域名共享缓存的目标域名。如果CacheShared 是 target_host 或者是空值(""),该参数值是空("")。 |
Total | Long | | 表示符合过滤条件的域名总数量。该参数不受请求参数 PageSize 和 PageNum 的影响。 |
PageNum | Long | | 表示请求参数中的 PageNum。 |
PageSize | Long | | 表示请求参数中的 PageSize。 |
本接口无特有的错误码。更多信息请见公共错误码。