调用 UpdateDomainConfig 更新点播域名配置。
此接口为模块级别的覆盖修改,具体说明如下:
此接口当前仅支持修改 HTTP 响应头配置模块。
请求地址:https://vod.volcengineapi.com?Action=UpdateDomainConfig&Version=2023-07-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateDomainConfig | 接口名称。当前 API 的名称为 UpdateDomainConfig。 |
| Version | String | 是 | 2023-07-01 | 接口版本。当前 API 的版本为 2023-07-01。 |
SpaceName | String | 是 |
| 点播空间名称。您可通过以下方式获取空间名称: |
DomainType | String | 是 |
| 域名类型。取值如下:
说明 详见域名类型介绍。 |
| Domain | String | 是 | example.test.com | 待修改配置的域名。 |
| Config | Object of VodDomainConfig | 是 | - | 表示本次修改的配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ResponseHeaderControl | Object of VodResponseHeaderControl | 否 | - | HTTP 响应头配置模块。不传此参数表示不对该模块进行修改。更多信息,请见配置 HTTP 响应头。 |
| IPv6 | Object of CdnIPv6 | 否 | - | IPV6 配置模块。该功能默认是禁用。 |
Cache | Array of CacheControlRule | 否 |
| 表示 "节点缓存规则" 列表,列表中最多可以包含 50 条规则。列表中规则的出现顺序表示规则的优先级。列表中第一条规则的优先级最高。 |
| HTTPS | Object of HTTPS | 否 | - | 表示 HTTPS 配置模块。该功能默认是禁用。 |
CacheKey | Array of CacheKeyRule | 否 |
| 表示 "缓存键" 规则列表。
|
OriginArg | Array of VodOriginArgRule | 否 |
| 表示 "回源参数" 配置的规则列表。
|
| Compression | Object of Compression | 否 | - | 表示 "智能压缩" 特性的配置模块。该特性默认为禁用。 |
OriginRange | Boolean | 否 |
| 表示是否启用 "Range 回源" 特性。该特性默认为禁用。支持以下取值:
|
| IpAccessRule | Object of IpAccessRule | 否 | - | 表示 "IP 黑白名单" 特性的配置模块。该特性默认为禁用。 |
| UaAccessRule | Object of UserAgentAccessRule | 否 | - | 表示 "UA 黑白名单" 特性的配置模块。该特性默认为禁用。 |
| RequestHeader | Array of RequestHeaderRule | 否 | - | 表示 "回源 HTTP 请求头" 特性的配置模块。该特性默认为禁用。 |
FollowRedirect | Boolean | 否 |
| 表示是否启用 "回源重定向跟随" 特性。该特性默认为禁用。支持以下取值:
|
| OriginalControl | Object of VodOriginalControl | 否 | - | 源站配置模块。不传此参数表示不对该模块进行修改。 |
| RefererAccessRule | Object of RefererAccessRule | 否 | - | 表示 "Referer 黑白名单" 特性的配置模块。该特性默认为禁用。关于不同配置对请求匹配结果的影响,参见配置示例。 |
| DownloadSpeedLimit | Object of DownloadSpeedLimit | 否 | - | 表示 "下载限速" 特性的配置模块。该特性默认为禁用。 |
HttpForcedRedirect | Object of HttpForcedRedirect | 否 |
| 表示 "HTTPS 强制跳转到 HTTP" 特性的配置模块。该特性默认是禁用。 注意 CDN 提供了两种协议重定向的特性:
|
| OriginRewriteControl | Object of VodOriginRewrite | 否 | - | 表示 "回源 URL 改写" 特性的配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ResponseHeader | Array of VodResponseHeaderRule | 否 | - | HTTP 响应头配置。空值表示清空该模块配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Switch | Boolean | 否 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Condition | Object of CdnCondition | 否 | - | 表示一个条件。如果请求满足该条件中的规则,则执行 CacheAction 中定义的操作。 |
| CacheAction | Object of CacheAction | 否 | - | 表示缓存行为的相关配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Switch | Boolean | 否 |
| 表示是否启用 HTTPS 特性。该参数有以下取值:
|
| CertInfo | Object of CertInfo | 否 | - | 表示要与加速域名关联的单本证书。 |
HTTP2 | Boolean | 否 |
| 表示是否为用户请求启用 HTTP/2 支持。该参数有以下取值:
|
ForcedRedirect | Object of ForcedRedirect | 否 |
| 表示 "HTTP 强制跳转到 HTTPS" 特性的配置模块。该特性默认是禁用。 注意 CDN 提供了两种协议重定向的特性:
|
TlsVersion | Array of String | 否 |
| 表示 "TLS 版本" 特性的配置。该参数指定用户请求可以使用的 TLS 版本,有以下取值:
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Condition | Object of CdnCondition | 否 | - | 指定一个条件。如果请求满足该条件中的规则,则执行 CacheKeyAction 中定义的操作。 |
| CacheKeyAction | Object of CacheKeyAction | 否 | - | 表示在 Condition 情况下,CDN 执行的操作。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Condition | Object of CdnCondition | 是 | - | 表示匹配条件的配置。如果请求满足该匹配条件,CDN 执行 OriginArgAction 中指定的操作。当前您必须且只能指定一个条件。 |
| OriginArgAction | Object of VodOriginArgAction | 是 | - | 表示在请求满足 Condition 时 CDN 执行的操作。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Switch | Boolean | 否 |
| 表示是否启用该特性。该参数有以下取值:
|
| CompressionRules | Array of CompressionRule | 否 | - | 表示一组规则。每条规则包含过滤条件配置以及操作配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Ip | Array of String | 否 | ["192.168.1.1","2001:db8::1","10.0.0.0/24"] | 表示 IP 黑白名单中的 IP 地址或网段。当 Switch 为 true 时,该参数为必填。支持 IPv4 和 IPv6 格式,最多可指定 1,000 个地址。 |
Switch | Boolean | 否 |
| 表示是否启用该特性。该参数有以下取值:
|
RuleType | String | 否 |
| IP 名单的类型,当
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Switch | Boolean | 否 |
| 表示是否启用该特性。该参数有以下取值:
|
RuleType | String | 否 |
| 表示指定的是黑名单还是白名单。当
|
UserAgent | Array of String | 否 |
| 表示一个 UA 的列表。当
|
AllowEmpty | Boolean | 否 |
| 表示是否允许 UA 为空("")或者不包含 UA 字段的请求访问加速域名。该参数有以下取值:
|
IgnoreCase | Boolean | 否 |
| 表示 UA 字符串是否是大小写敏感的。该参数有以下取值:
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Condition | Object of CdnCondition | 否 | - | 指定一个条件。如果请求满足该条件中的规则,则执行 RequestHeaderAction 中定义的操作。 |
| RequestHeaderAction | Object of RequestHeaderAction | 否 | - | 表示一个请求头的配置规则列表。每个规则都包含一个头部的相关操作设置。您最多可以添加 50 条规则。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Host | String | 否 | vod.example.com | 回源 Host,其优先级低于 VodOriginalConfig 中设置的 Host。若未传入此参数,则视为不进行更新。该参数的更新仅在 Origins 参数有效时才会生效。 |
| Origins | Array of VodOriginalConfig | 否 | - | 源站配置。 |
OriginProtocol | String | 否 |
| 回源请求使用的协议,默认为
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Switch | Boolean | 否 |
| 表示是否启用该特性。该参数有以下取值:
|
| Referers | Array of String | 否 | ["www.example.com","xxx.xx.x.x","xx.xx.xx.x/24"] | 表示一个 Referer 列表,该参数的输入要求与 ReferersType 下 CommonType 类型的 Referers 的输入要求相同。建议您使用 ReferersType 来指定 Referer 列表。 |
RuleType | String | 否 |
| 表示 Referer 名单的类型。当
|
AllowEmpty | Boolean | 否 |
| 表示当用户请求不包含 Referer 头部时,CDN 处理请求的方式。该参数有以下取值:
|
| ReferersType | Object of ReferersType | 否 | - | 表示一个 ReferersType 对象。其包含一个 CommonType 对象和一个 RegularType 对象,分别表示一个常规 Referer 列表和一个用于匹配 Referer 的正则表达式列表。您可以同时定义这两个对象。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Switch | Boolean | 否 |
| 表示是否启用 "下载限速" 特性。支持的取值如下:
|
| DownloadSpeedLimitRules | Array of DownloadSpeedLimitRule | 否 | - | 下载限速规则列表,当 Switch 为 true 时必填。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
StatusCode | String | 否 |
| 表示当收到 HTTPS 请求时,CDN 返回的重定向状态码。支持的取值如下:
|
EnableForcedRedirect | Boolean | 否 |
| 表示是否启用 HTTPS 强制跳转到 HTTP 特性。该参数有以下取值:
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Switch | Boolean | 否 |
| 表示是否启用该特性。该参数有以下取值:
|
OriginRewriteRule | Array of VodOriginRewriteRule | 否 |
| 表示一个规则列表。当
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ResponseHeaderAction | Object of VodResponseHeaderAction | 否 | - | 点播 CDN 在响应用户请求的时候,对响应头的操作。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Connective | String | 否 |
| 多个
|
ConditionRule | Array of ConditionRule | 否 |
| 表示一个内容匹配规则的列表。 说明 在每个 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Ttl | Long | 否 | 3600 | 表示缓存的时间,单位为秒,时间范围为 0-315,360,000。315,360,000 表示 10 年。如果设置为 0,则表示 CDN 不对指定的内容进行缓存。 |
| Action | String | 否 | cache | 表示缓存的行为,当前仅支持 cache,表示行为是缓存。 |
IgnoreCase | Boolean | 否 |
| 表示 CDN 对请求的文件匹配
|
DefaultPolicy | String | 否 |
| 表示缓存策略,默认值为
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| CertId | String | 否 | cert-eb5d99026753499a8a34d2a4f0a08d92 | 表示要关联的证书 ID。证书需要托管在火山引擎证书中心。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
StatusCode | String | 否 |
| 表示当收到 HTTP 请求时 CDN 强制跳转到 HTTPS 的重定向响应状态码。支持的取值如下:
|
EnableForcedRedirect | Boolean | 否 |
| 表示是否启用 HTTP 强制跳转到 HTTPS 特性。该参数有以下取值:
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| CacheKeyComponents | Array of CacheKeyComponent | 否 | - | 表示一个操作配置的列表。当前您仅可设置一个操作配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| OriginArgComponents | Array of VodOriginArgComponents | 是 | - | 表示一个操作列表。这些操作定义了 CDN 如何处理回源请求中的查询参数。当前,列表中只能包含一个操作。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Condition | Object of CdnCondition | 否 | - | 指定一个条件。如果请求满足该条件中的规则,则执行 CompressionAction 中定义的操作。如果指定了 CompressionFormat,则该字段必须为 null或不指定。 |
| CompressionAction | Object of CompressionAction | 否 | - | 表示当用户请求满足 Condition 时,CDN 对请求文件执行的压缩操作的配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| RequestHeaderInstances | Array of RequestHeaderInstance | 否 | - | 表示一个请求头的配置规则列表。每个规则都包含一个头部的相关操作设置。您最多可以添加 50 条规则。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Host | String | 否 | vod.example.com | 回源 Host。若未传入参数或传入空值,将默认将加速域名作为回源 Host。 |
Origins | String | 否 |
| 源站列表。
注意 当 |
OriginType | String | 否 |
| 源站类别。取值如下:
源站列表中必须至少包含一个主源站,备源站为可选。当前仅支持一个源站,若传入空值,则默认为主源站(primary);若传入的值既非空值,也非主源站(primary)或备源站(backup),则会报错。 |
PrivateBucketAuth | Object of VodPrivateBucketAuth | 否 |
| 访问存储桶的凭证信息。 说明
|
PrivateBucketAccess | Boolean | 否 |
| 对象存储桶是否为私有桶。
说明 此参数仅当 |
SourceStationAddressType | Integer | 否 |
| 源站地址类型。取值如下:
注意 当 |
| Region | String | 否 | us-east-1 | 存储桶所在地域的信息,也就是存储桶的 region code。Region code 参与签名的计算。若 AuthType 为 aws_common 并且 PrivateBucketAccess 为 true,您必须指定此参数。 |
Weight | String | 否 |
| 该源站的权重,取值范围是 1-100,默认值是 注意 该参数仅当 |
HttpPort | String | 否 |
| CDN 使用 HTTP 协议访问该源站时所访问的端口,取值范围是 1-65535,默认值是 注意 该参数仅当 |
HttpsPort | String | 否 |
| CDN 使用 HTTPS 协议访问该源站时所访问的端口,取值范围是 1-65535,默认值是 注意 该参数仅当 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| CommonType | Object of CommonReferType | 否 | - | 表示一个 CommonType 对象,其包含一个常规 Referer 列表。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Condition | Object of CdnCondition | 否 | - | 指定一个条件。如果请求满足该条件中的规则,则执行 DownloadSpeedLimitAction 中定义的操作。可以不指定该参数,表示限速对所有文件生效。 |
| DownloadSpeedLimitAction | Object of DownloadSpeedLimitAction | 否 | - | 表示限速配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| OriginRewriteAction | Object of VodOriginRewriteAction | 否 | - | 表示 CDN 执行的动作。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ResponseHeaderInstances | Array of VodResponseHeaderInstance | 否 | - | 响应头的配置规则列表。每个规则都包含一个头部的操作配置。最多支持 50 条规则。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Type | String | 是 | url | 表示请求的目标地址的类型,当前仅支持 url,表示 URL 类型的链接。 |
Value | String | 是 |
| 表示
|
Object | String | 是 |
| 表示 CDN 对哪些对象类型进行规则匹配。支持的取值如下:
|
| Operator | String | 是 | match | 表示匹配方式,当前仅支持 match,表示对请求的对象进行规则匹配。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 否 |
| 执行动作,修改时需要指定。该参数有以下取值:
|
| Object | String | 否 | queryString | 表示需要设置的对象,当前仅可指定 queryString,即请求 URL 中的查询参数。 |
Subobject | String | 否 |
| 指定一个或者多个
|
IgnoreCase | Boolean | 否 |
| 表示 CDN 在匹配
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 |
| 表示 CDN 执行的操作。该参数有以下取值:
|
| Object | String | 是 | queryString | 表示 CDN 对哪个对象执行 Action。当前,该参数值只能是 queryString,表示请求 URL 中的查询字符串。 |
Subobject | String | 是 | 表示一个或者多个查询参数。多个查询参数之间使用分号(;)分隔,总长度不能超过 1,024 个字符。
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| MaxFileSizeKB | Long | 否 | ||
| MinFileSizeKB | Long | 否 | ||
CompressionType | Array of String | 否 |
| 表示 CDN 使用的压缩算法。该参数有以下取值:
|
CompressionFormat | String | 否 |
| 表示 CDN 基于请求中的
|
CompressionTarget | String | 否 |
| 表示
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Key | String | 否 | Content-Disposition | 头部名称。名称不能超过 1,024 个字符,不区分大小写。可包含除以下字符外的可打印 ASCII 字符:下划线(_)、空格、双引号(")、Delete(ASCII code 127)。同时,不能使用这些特定的名称。 |
Value | String | 否 |
| 头部的值。仅当
|
Action | String | 否 |
| 指定对请求头的操作。该参数有以下取值:
|
ValueType | String | 否 |
|
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Switch | Boolean | 否 | true | 访问存储桶是否需要凭证。此参数取值必须为 true。 |
AuthType | String | 否 |
| 存储桶采用的是哪个对象存储服务所提供的鉴权方式。该参数有以下取值:
说明
|
TosAuthInformation | Object of VodTosAuthInformation | 否 |
| 存储桶的访问凭证。满足以下任意一个条件时,您必须设置此参数:
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Referers | Array of String | 否 | ["www.example.com","192.168.1.1","10.0.0.0/24"] | 表示一个常规 Referer 列表。在该列表中,可以指定一个或多个 IP 地址、CIDR 网段、域名或泛域名。域名可以是二级域名。IP 地址只能是 IPv4 格式的地址。您最多可输入 1,000 个 IP 地址。输入的域名不能包含 http:// 或 https://。该参数值的长度不能超过 30,000 个字符。 |
IgnoreCase | Boolean | 否 |
| 表示
|
IgnoreScheme | Boolean | 否 |
| 表示 CDN 是否对 Referer 中的 scheme 进行校验,也就是校验 Referer 是否包含
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| SpeedLimitRate | Long | 否 | 1048576 | 表示单个请求的下载速度上限,单位为 B/S,取值范围是 1-1,073,741,824,000,000。 |
| SpeedLimitTime | Object of SpeedLimitTime | 否 | - | 表示限速发生的日期和时间段。 |
| SpeedLimitRateAfter | Long | 否 | 1048576 | 表示单个请求下载的数据量阈值,单位为 Byte。当请求下载的数据量达到该阈值时,才会对该请求启用下载限速。取值范围为 0-1,073,741,824,000,000。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
SourcePath | String | 否 |
| 表示一个正则表达式,长度不能超过 1,024 个字符,用于匹配用户请求 URL 中的对象。对于一个用户请求,如果该正则表达式匹配了对象中的任何部分,这条规则就匹配了这个用户请求。
说明 假设您在调用该 API 时在 |
TargetPath | String | 否 |
| 表示改写后,回源请求 URL 中的对象。
|
RewriteType | String | 否 |
| 表示改写类型。该参数有以下取值:
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Key | String | 否 | Content-Disposition | 头部名称。名称不能超过 1,024 个字符,不区分大小写。可包含除以下字符外的可打印 ASCII 字符:下划线(_)、空格、双引号(")、Delete(ASCII code 127)。同时,不能使用这些特定的名称。 |
Value | String | 否 |
| 头部的值。仅当
|
Action | String | 否 |
| 对响应头的操作。取值如下:
|
ValueType | String | 否 |
|
|
AccessOriginControl | Boolean | 否 |
| 在点播 CDN 响应用户请求时,是否校验请求头中的
注意 该参数仅在以下条件都满足的情况下有效:
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
AccessKeyId | String | 否 |
| 访问凭证中的 Access Key ID(简称 AK)。
|
AccessKeySecret | String | 否 |
| 访问凭证中的 Secret Access Key(简称 SK)。
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
DayWeek | String | 否 |
| 表示限速发生的日期。支持的取值如下:
|
| EndTime | String | 否 | 23:59 | 表示限速发生的结束时间,格式为 mm:ss。当 DayWeek 的值为 unlimited 时,默认值为 23:59。 |
| BeginTime | String | 否 | 09:00 | 表示限速规则生效的开始时间,格式为 mm:ss。当 DayWeek 的值为 unlimited 时,默认值为 00:00。 |
本接口无特有的返回参数。具体请见公共返回参数。
https://vod.volcengineapi.com?Action=UpdateDomainConfig&Version=2023-07-01 { "SpaceName": "test-space", "DomainType": "play", "Domain": "example.test.com", "Config": { "ResponseHeaderControl": { "ResponseHeader": [ { "ResponseHeaderAction": { "ResponseHeaderInstances": [ { "Action": "set", "Key": "Access-Control-Allow-Origin", "Value": "*", "AccessOriginControl": false, "ValueType": "constant" } ] } } ] } } }
{ "ResponseMetadata": { "Action": "UpdateDomainConfig", "Region": "cn-north-1", "Service": "vod", "Version": "2023-07-01", "RequestId": "20230604110420****100232280022D31" } }
下表列举了本接口特有的错误码。如需了解更多错误码,详见视频点播公共错误码。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | InvalidParameter.InvalidDomainType | Domain type must be play/image | DomainType 取值不合法 |
| 400 | InvalidParameter.DomainNotFound | The domain does not exist | 域名不存在 |
| 400 | InvalidParameter.DomainBeLocked | The domain has been locked. Please contact sre for processing | 域名已锁定 |