在火山引擎内容分发网络中添加您的域名。在添加域名时,您可以设置域名的配置。
节流限制:您每秒最多可以发送 20 个请求。
在您调用该 API 时,CDN 会对该域名做一系列检查。如果域名未通过某项检查,您会收到相应的错误消息。参见 域名准入规范。
说明
如果您要添加的域名是一个泛域名,请 提交工单。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
|---|---|---|---|
Action | String | 是 | 接口名称。当前 API 的名称为 AddCdnDomain。 |
Version | String | 是 | 接口版本。当前 API 的版本为 2021-03-01。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Domain | String | 是 | 表示您需要添加的一个域名。主账号下最多能添加 200 个加速域名。如果您需要添加的域名数量超过 200 个,请 提交工单。 您可以添加中文域名。在指定中文名时,您必须将域名中的汉字转化为 punycode 码后再输入。 您添加的域名必须满足以下额外要求:
| www.example.com |
ServiceType | String | 是 | 表示业务类型。该参数有以下取值:
| web |
ServiceRegion | String | 否 | 表示该加速域名的加速区域。该参数有以下取值:
chinese_mainland。要指定另两个值,请 提交工单。 | chinese_mainland |
Project | String | 否 | 表示该域名所归属的项目。您可以在 项目管理 页面查看已有的项目以及项目下的资源。 该参数的默认值是default,表示名称是 default 的项目。 | default |
ResourceTags | Object[] | 否 | 表示您对该域名设置的标签。您最多可以设置 10 个标签。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
IPv6 | Object | 否 | 表示 IPv6 配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Origin | Object[] | 是 | 表示源站配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
ConditionalOrigin | Object | 否 | 表示 "条件源站" 特性的配置。要使用此特性,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginProtocol | String | 是 | 表示回源请求使用的协议。该参数有以下取值:
| http |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginCertCheck | Object | 否 | 表示 "源站证书校验" 特性的配置。要使用此特性,请 提交工单。 该特性启用后,CDN 会校验源站证书的合法性,包括证书是否已被吊销、证书是否由可信 CA 签发、证书与源站域名是否匹配等。CDN 内置了常见可信 CA 的根证书。 该特性还支持双向认证,使源站对 CDN 身份进行校验。您需要在 CDN 中指定相应的客户端证书。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginIPv6 | String | 否 | 表示 "IPv6 回源" 的配置。该参数有以下取值:
该参数的默认值是 | followclient |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginHost | String | 否 | 如果源站服务器上有多个站点,该参数表示回源请求访问的站点域名。该参数对所有源站配置生效,但是优先级低于源站配置中 该参数的默认值与 Address 相同。 | img.example.com |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
ServiceRegion | String | 否 | 表示该加速域名的加速区域。该参数有以下取值:
chinese_mainland。要指定另两个值,请 提交工单。 | chinese_mainland |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
HTTPS | Object | 否 | 表示 HTTPS 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
HttpForcedRedirect | Object | 否 | 表示 "HTTPS 强制跳转到 HTTP" 特性的配置。 说明 关于 HTTP 重定向至 HTTPS 的配置,参见 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Quic | Object | 否 | 表示 QUIC 配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
UrlNormalize | Object | 否 | 表示 "URL 标准化" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
AreaAccessRule | Object | 否 | 表示 "地域访问控制" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
MethodDeniedRule | Object | 否 | 表示 "禁用 HTTP Method" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
IpAccessRule | Object | 否 | 表示 "IP 黑白名单" 特性的配置。 该特性提供了两种配置方式:
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RefererAccessRule | Object | 否 | 表示 "Referer 黑白名单" 特性的配置。关于不同配置对请求匹配结果的影响,参见 配置示例。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
UaAccessRule | Object | 否 | 表示 "UA 黑白名单" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginAccessRule | Object | 否 | 表示 "Origin 黑白名单" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
CustomizeAccessRule | Object | 否 | 表示 "自定义头部黑白名单" 特性的配置。要使用该特性,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RequestBlockRule | Object | 否 | 表示 "自定义拦截" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RedirectionRewrite | Object | 否 | 表示 "URL 重定向改写" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
SignedUrlAuth | Object | 否 | 表示 "URL 鉴权" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RemoteAuth | Object | 否 | 表示 "远程鉴权" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
DownloadSpeedLimit | Object | 否 | 表示 "下载限速" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
CacheKey | Object[] | 否 | 表示 "缓存键值" 特性的配置。在该配置中,您可以创建一个规则列表,说明如下:
您必须在列表中添加以下默认规则,并且这条规则必须出现在列表的末尾。该默认规则用于匹配任何未能匹配其他规则的用户请求。在默认规则中,您可以调整 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Cache | Object[] | 否 | 表示 "缓存规则" 特性的配置。该特性默认为禁用,表示不创建自定义规则。
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
NegativeCache | Object[] | 否 | 表示 "状态码缓存" 特性的配置。在该配置中,您可以创建一个规则列表,说明如下:
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
BrowserCache | Object[] | 否 | 表示 "浏览器缓存" 特性的配置。在该配置中,您可以创建一个规则列表,说明如下:
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RequestHeader | Object[] | 否 | 表示 "回源 HTTP 请求头" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
CustomErrorPage | Object | 否 | 表示 "自定义错误页面" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
CacheHost | Object | 否 | 表示 "共享缓存" 特性的配置。要使用该功能,请 提交工单。 如果您要对多个加速域名配置共享缓存,您需要调用该 API 对每个加速域名配置目标域名。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
MultiRange | Object | 否 | 表示 "多重范围(Multi-range)" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OfflineCache | Object | 否 | 表示 "离线缓存" 特性的配置。要使用此特性,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
ResponseHeader | Object[] | 否 | 表示 "HTTP 响应头" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginRange | Boolean | 否 | 表示 "回源 Range" 特性的配置。该参数有以下取值:
该参数的默认值是 说明 如果 | true |
Range | Object | 否 | 表示分片大小的设置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Timeout | Object | 否 | 表示 "回源超时时间" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginRetry | Object | 否 | 表示 "回源重试设置" 特性的配置。要使用该功能,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
FollowRedirect | Boolean | 否 | 表示 "回源重定向跟随" 特性的配置。该参数有以下取值:
false。 | true |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RequestHeader | Object[] | 否 | 表示 "回源 HTTP 请求头" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginRewrite | Object | 否 | 表示 "回源 URL 改写" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginArg | Object[] | 否 | 表示 "回源参数" 配置的规则列表。
您必须在规则列表的最后添加以下这条默认规则。该默认规则用于匹配任何未能匹配其他规则的用户请求。您不可更改该规则中的
说明 如果您加速域名的源站配置尚未升级到 新版源站配置,回源参数的配置会有以下限制:
|
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginSni | Object | 否 | 表示 "回源 SNI" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
OriginResponseHeader | Object[] | 否 | 表示 "源站响应头设置" 的配置。要使用该特性,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Compression | Object | 否 | 表示 "智能压缩" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
PageOptimization | Object | 否 | 表示 "页面优化" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
VideoDrag | Object | 否 | 表示 "视频拖拽" 特性的配置。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RewriteHLS | Object | 否 | 表示 "标准 HLS 加密改写" 特性的配置。要使用该功能,请 提交工单。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
RuleEngine | Object | 否 | 详情参见 规则引擎配置。 |
由于该 API 没有响应参数,响应正文只有包含请求元数据的 ResponseMetadata 结构体,没有 Result 结构体。
参数名称 | 数据类型 | 参数说明 | 示例 |
|---|---|---|---|
暂无数据 | |||
本示例仅展示了基础配置。关于其他模块的示例以及源站配置的更多示例,参见 UpdateCdnConfig。
POST https://cdn.volcengineapi.com/?Action=AddCdnDomain&Version=2021-03-01 { "Domain": "www.example.com", "ServiceType": "web", "OriginProtocol": "http", "Origin": [ { "OriginAction": { "OriginLines": [ { "Address": "1.1.1.1", "HttpPort": "80", "HttpsPort": "443", "InstanceType": "ip", "OriginType": "primary", "PrivateBucketAccess": false, "Weight": "1" } ] } } ], "ResourceTags": [ { "Key": "hello", "Value": "world" } ] }
{ "ResponseMetadata": { "RequestId": "2021121621104801021219403908010CBC", "Action": "AddCdnDomain", "Version": "2021-03-01", "Service": "CDN", "Region": "cn-north-1" } }
如果响应正文的 ResponseMetadata 字段中包含 Error 字段,则表示 API 请求失败。更多关于错误码的信息,参见错误码。