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

视频点播

复制全文
下载 pdf
点播 CDN
UpdateDomainConfig - 更新域名配置
复制全文
下载 pdf
UpdateDomainConfig - 更新域名配置

调用 UpdateDomainConfig 更新点播域名配置。

使用说明

此接口为模块级别的覆盖修改,具体说明如下:

  • 如果您未指定某个模块,那么在您提交请求后,该模块的配置将保持不变。
  • 如果您指定了某个模块,那么在您提交请求后,该模块的现有配置将被覆盖。

此接口当前仅支持修改 HTTP 响应头配置模块。

注意事项

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

请求说明

请求地址:https://vod.volcengineapi.com?Action=UpdateDomainConfig&Version=2023-07-01

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringUpdateDomainConfig接口名称。当前 API 的名称为 UpdateDomainConfig
VersionString2023-07-01接口版本。当前 API 的版本为 2023-07-01

SpaceName

String

test-space

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

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

DomainType

String

play

域名类型。取值如下:

  • play:点播加速域名和自定义源站加速域名。
  • image:封面加速域名。

说明

详见域名类型介绍

DomainStringexample.test.com待修改配置的域名。
ConfigObject of VodDomainConfig-表示本次修改的配置。

VodDomainConfig

参数类型是否必选示例值描述
ResponseHeaderControlObject of VodResponseHeaderControl-HTTP 响应头配置模块。不传此参数表示不对该模块进行修改。更多信息,请见配置 HTTP 响应头
IPv6Object of CdnIPv6-IPV6 配置模块。该功能默认是禁用。

Cache

Array of CacheControlRule

-

表示 "节点缓存规则" 列表,列表中最多可以包含 50 条规则。列表中规则的出现顺序表示规则的优先级。列表中第一条规则的优先级最高。
CDN 维护一条默认缓存规则,用于匹配任何未能匹配其他规则的用户请求。该规则始终生效,无法删除。当您通过 API 配置 "节点缓存规则" 时,您无需添加该默认规则。

HTTPSObject of HTTPS-表示 HTTPS 配置模块。该功能默认是禁用。

CacheKey

Array of CacheKeyRule

-

表示 "缓存键" 规则列表。

  • 列表中最多可以包含 50 条规则。
  • 列表中规则的出现顺序表示规则的优先级。列表中第一条规则的优先级最高。
  • 每条规则包含一个过滤器(Condition)和 CDN 执行的操作(CacheKeyAction)。
    必须在列表中添加以下默认规则,并且这条规则必须出现在列表的末尾。该默认规则用于匹配任何未能匹配其他规则的用户请求。在默认规则中,您可以调整 CacheKeyAction 的配置,但不能调整 Condition 的配置。
{
    "CacheKeyAction": {
        "CacheKeyComponents": [
            {
                "Action": "include",
                "IgnoreCase": true,
                "Object": "queryString",
                "Subobject": "*"
            }
        ]
    },
    "Condition": {
        "ConditionRule": [
            {
                "Name": "",
                "Object": "directory",
                "Operator": "match",
                "Type": "url",
                "Value": "/"
            }
        ]
    }
}

OriginArg

Array of VodOriginArgRule

-

表示 "回源参数" 配置的规则列表。

  • 列表中最多可以包含 50 条规则。
  • 每条规则包含一个匹配条件(Condition)和 CDN 执行操作(OriginArgAction)。
  • 列表中规则的顺序定义了规则的优先级。列表中第一条规则的优先级最高。
  • 当收到一个用户请求时,CDN 按规则的优先级,从高到低将规则与请求匹配。如果一条规则匹配了请求,CDN 就停止处理其余规则。
    必须在规则列表的最后添加以下这条默认规则。该默认规则用于匹配任何未能匹配其他规则的用户请求。您不可更改该规则中的 Condition,但可以更改 OriginArgAction 中的配置。
{
    "Condition": {
        "ConditionRule": [
            {
                "Object": "directory",
                "Operator": "match",
                "Type": "url",
                "Value": "/"
            }
        ]
    },
    "OriginArgAction": {
        "OriginArgComponents": [
            {
                "Action": "include",
                "Object": "queryString",
                "Subobject": "*"
            }
        ]
    }
}
CompressionObject of Compression-表示 "智能压缩" 特性的配置模块。该特性默认为禁用。

OriginRange

Boolean

-

表示是否启用 "Range 回源" 特性。该特性默认为禁用。支持以下取值:

  • true:表示启用该特性。
  • false:表示禁用该特性。
IpAccessRuleObject of IpAccessRule-表示 "IP 黑白名单" 特性的配置模块。该特性默认为禁用。
UaAccessRuleObject of UserAgentAccessRule-表示 "UA 黑白名单" 特性的配置模块。该特性默认为禁用。
RequestHeaderArray of RequestHeaderRule-表示 "回源 HTTP 请求头" 特性的配置模块。该特性默认为禁用。

FollowRedirect

Boolean

-

表示是否启用 "回源重定向跟随" 特性。该特性默认为禁用。支持以下取值:

  • true:表示启用该特性。
  • false:表示禁用该特性。
OriginalControlObject of VodOriginalControl-源站配置模块。不传此参数表示不对该模块进行修改。
RefererAccessRuleObject of RefererAccessRule-表示 "Referer 黑白名单" 特性的配置模块。该特性默认为禁用。关于不同配置对请求匹配结果的影响,参见配置示例
DownloadSpeedLimitObject of DownloadSpeedLimit-表示 "下载限速" 特性的配置模块。该特性默认为禁用。

HttpForcedRedirect

Object of HttpForcedRedirect

-

表示 "HTTPS 强制跳转到 HTTP" 特性的配置模块。该特性默认是禁用。

注意

CDN 提供了两种协议重定向的特性:

  • HTTP 重定向到 HTTPS,即 ForcedRedirect 模块。
  • HTTPS 重定向到 HTTP,即 HttpForcedRedirect 模块。
    这两个协议重定向特性是互斥的,启用其中一个特性后将无法启用另一个。
OriginRewriteControlObject of VodOriginRewrite-表示 "回源 URL 改写" 特性的配置。

VodResponseHeaderControl

参数类型是否必选示例值描述
ResponseHeaderArray of VodResponseHeaderRule-HTTP 响应头配置。空值表示清空该模块配置。

CdnIPv6

参数类型是否必选示例值描述
SwitchBoolean

CacheControlRule

参数类型是否必选示例值描述
ConditionObject of CdnCondition-表示一个条件。如果请求满足该条件中的规则,则执行 CacheAction 中定义的操作。
CacheActionObject of CacheAction-表示缓存行为的相关配置。

HTTPS

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

Switch

Boolean

true

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

  • true:表示启用该特性。
  • false:表示禁用该特性。
    如果 Switchtrue,必须指定证书。证书需要托管在火山引擎证书中心。
CertInfoObject of CertInfo-表示要与加速域名关联的单本证书。

HTTP2

Boolean

true

表示是否为用户请求启用 HTTP/2 支持。该参数有以下取值:

  • true:表示启用 HTTP/2。
  • false:表示禁用 HTTP/2。
    要启用该特性,您的加速域名必须已经启用了 HTTPS。
    该参数的默认值是 false

ForcedRedirect

Object of ForcedRedirect

-

表示 "HTTP 强制跳转到 HTTPS" 特性的配置模块。该特性默认是禁用。

注意

CDN 提供了两种协议重定向的特性:

  • HTTP 重定向到 HTTPS,即 ForcedRedirect 模块。
  • HTTPS 重定向到 HTTP,即 HttpForcedRedirect 模块。
    这两个协议重定向特性是互斥的,启用其中一个特性后将无法启用另一个。

TlsVersion

Array of String

["tlsv1.1","tlsv1.2"]

表示 "TLS 版本" 特性的配置。该参数指定用户请求可以使用的 TLS 版本,有以下取值:

  • tlsv1.0:表示 TLS 1.0。
  • tlsv1.1:表示 TLS 1.1。
  • tlsv1.2:表示 TLS 1.2。
  • tlsv1.3:表示 TLS 1.3。
    该参数的默认值是 ["tlsv1.1", "tlsv1.2", "tlsv1.3"]

CacheKeyRule

参数类型是否必选示例值描述
ConditionObject of CdnCondition-指定一个条件。如果请求满足该条件中的规则,则执行 CacheKeyAction 中定义的操作。
CacheKeyActionObject of CacheKeyAction-表示在 Condition 情况下,CDN 执行的操作。

VodOriginArgRule

参数类型是否必选示例值描述
ConditionObject of CdnCondition-表示匹配条件的配置。如果请求满足该匹配条件,CDN 执行 OriginArgAction 中指定的操作。当前您必须且只能指定一个条件。
OriginArgActionObject of VodOriginArgAction-表示在请求满足 Condition 时 CDN 执行的操作。

Compression

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

Switch

Boolean

true

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

  • true:表示启用该特性。
  • false:表示禁用该特性。
CompressionRulesArray of CompressionRule-表示一组规则。每条规则包含过滤条件配置以及操作配置。

IpAccessRule

参数类型是否必选示例值描述
IpArray of String["192.168.1.1","2001:db8::1","10.0.0.0/24"]表示 IP 黑白名单中的 IP 地址或网段。当 Switchtrue 时,该参数为必填。支持 IPv4 和 IPv6 格式,最多可指定 1,000 个地址。

Switch

Boolean

true

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

  • true:表示启用该特性。
  • false:表示禁用该特性。

RuleType

String

allow

IP 名单的类型,当 Switchtrue 时必填。支持的取值如下:

  • allow:表示白名单;
  • deny:表示黑名单。

UserAgentAccessRule

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

Switch

Boolean

true

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

  • true:表示启用该特性。
  • false:表示禁用该特性。

RuleType

String

deny

表示指定的是黑名单还是白名单。当 Switchtrue 时,该参数为必填。该参数有以下取值:

  • deny: 表示指定的是黑名单。
  • allow: 表示指定的是白名单。

UserAgent

Array of String

["curl","Mozilla"]

表示一个 UA 的列表。当 Switchtrue 时,该参数为必填。该列表最多包含 1,000 个 UA。该参数的说明如下:

  • 该参数值的长度不能超过 30,000 个字符。
  • 如果 RuleTypeallow,表示仅允许包含列表中的 UA 的请求访问加速域名。
  • 如果 RuleTypedeny,表示如果访问请求包含列表中的 UA,则不允许访问加速域名。
    UA 能包含的字符有以下限制:
  • UA 中可以使用 * 表示一个或者多个字符。* 仅可以出现在 UA 的开头和末尾。
  • UA 不能只包含 *或者空格。
  • UA 可以包含除了 Delete(ASCII code 127)的可打印 ASCII 字符。
  • UA 如果包含符号,符号必须是被 HTML 编码的。

AllowEmpty

Boolean

true

表示是否允许 UA 为空("")或者不包含 UA 字段的请求访问加速域名。该参数有以下取值:

  • true:表示允许。
  • false:表示不允许。
    该参数的默认值是 false

IgnoreCase

Boolean

true

表示 UA 字符串是否是大小写敏感的。该参数有以下取值:

  • true: 表示 UA 字符串是大小写不敏感的。
  • false: 表示 UA 字符串是大小写敏感的。
    该参数的默认值是 false

RequestHeaderRule

参数类型是否必选示例值描述
ConditionObject of CdnCondition-指定一个条件。如果请求满足该条件中的规则,则执行 RequestHeaderAction 中定义的操作。
RequestHeaderActionObject of RequestHeaderAction-表示一个请求头的配置规则列表。每个规则都包含一个头部的相关操作设置。您最多可以添加 50 条规则。

VodOriginalControl

参数类型是否必选示例值描述
HostStringvod.example.com回源 Host,其优先级低于 VodOriginalConfig 中设置的 Host。若未传入此参数,则视为不进行更新。该参数的更新仅在 Origins 参数有效时才会生效。
OriginsArray of VodOriginalConfig-源站配置。

OriginProtocol

String

http

回源请求使用的协议,默认为 http。取值如下:

  • http:回源请求使用 HTTP 协议。

  • https:回源请求使用 HTTPS 协议。

  • followclient:回源协议与用户请求使用的协议相同。

RefererAccessRule

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

Switch

Boolean

true

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

  • true:表示启用该特性。
  • false:表示禁用该特性。
ReferersArray of String["www.example.com","xxx.xx.x.x","xx.xx.xx.x/24"]表示一个 Referer 列表,该参数的输入要求与 ReferersTypeCommonType 类型的 Referers 的输入要求相同。建议您使用 ReferersType 来指定 Referer 列表。

RuleType

String

allow

表示 Referer 名单的类型。当 Switchtrue 时,该参数为必填。支持的取值如下:

  • allow:表示白名单;
  • deny:表示黑名单。

AllowEmpty

Boolean

true

表示当用户请求不包含 Referer 头部时,CDN 处理请求的方式。该参数有以下取值:

  • true:表示如果请求不包含 Referer 头部,则该请求被认为匹配您配置的 Referer 列表。
  • false:表示如果请求不包含 Referer 头部,则该请求被认为不匹配您配置的 Referer 列表。
    该参数的默认值是 false
ReferersTypeObject of ReferersType-表示一个 ReferersType 对象。其包含一个 CommonType 对象和一个 RegularType 对象,分别表示一个常规 Referer 列表和一个用于匹配 Referer 的正则表达式列表。您可以同时定义这两个对象。

DownloadSpeedLimit

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

Switch

Boolean

true

表示是否启用 "下载限速" 特性。支持的取值如下:

  • true:表示启用该特性;
  • false:表示禁用该特性。
DownloadSpeedLimitRulesArray of DownloadSpeedLimitRule-下载限速规则列表,当 Switchtrue 时必填。

HttpForcedRedirect

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

StatusCode

String

301

表示当收到 HTTPS 请求时,CDN 返回的重定向状态码。支持的取值如下:

  • 301:表示 301 响应状态码;
  • 302:表示 302 响应状态码。
    默认值为 301

EnableForcedRedirect

Boolean

true

表示是否启用 HTTPS 强制跳转到 HTTP 特性。该参数有以下取值:

  • true:启用该特性,CDN 会将收到的 HTTPS 请求重定向到 HTTP 请求;
  • false:禁用该特性,CDN 不会将 HTTPS 请求重定向到 HTTP 请求。
    要启用该特性,您的加速域名必须已启用 HTTPS。

VodOriginRewrite

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

Switch

Boolean

true

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

  • true:表示启用该特性。
  • false:表示禁用该特性。
    该参数的默认值是 false

OriginRewriteRule

Array of VodOriginRewriteRule

-

表示一个规则列表。当 Switchtrue 时,该参数为必填。

  • 列表中最多可以包含 50 条规则。
  • 列表中规则的顺序定义了规则的优先级。列表中第一条规则的优先级最高。规则中的 SourcePath 定义了规则的作用范围。如果您创建了多条规则,作用范围较大的规则应出现在作用范围较小的规则后面。
  • 当收到一个用户请求时,CDN 按规则的优先级,从高到低尝试将请求与规则匹配。如果请求匹配了一条规则,CDN 就停止处理其余规则。

VodResponseHeaderRule

参数类型是否必选示例值描述
ResponseHeaderActionObject of VodResponseHeaderAction-点播 CDN 在响应用户请求的时候,对响应头的操作。

CdnCondition

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

Connective

String

AND

多个 ConditionRule 之间的逻辑关系。取值如下:

  • AND: 逻辑关系是所有。只有匹配所有规则的请求才会被鉴权。
  • OR: (默认)逻辑关系是任一。匹配任何一个规则的请求就会被鉴权。

ConditionRule

Array of ConditionRule

-

表示一个内容匹配规则的列表。

说明

在每个 CacheKeyGenerationRule 中,您只能指定一个内容匹配规则。

CacheAction

参数类型是否必选示例值描述
TtlLong3600表示缓存的时间,单位为秒,时间范围为 0-315,360,000315,360,000 表示 10 年。如果设置为 0,则表示 CDN 不对指定的内容进行缓存。
ActionStringcache表示缓存的行为,当前仅支持 cache,表示行为是缓存。

IgnoreCase

Boolean

true

表示 CDN 对请求的文件匹配 ConditionRule 时是否忽略大小写,仅在 DefaultPolicydefault 时有效。默认值为 false

  • true:忽略大小写;
  • false:不忽略大小写。

DefaultPolicy

String

default

表示缓存策略,默认值为 default。支持的取值如下所示。

  • force_cache:对应控制台的 CDN缓存 + 强制缓存(开) 的配置组合;
  • default:对应控制台的 CDN缓存 + 强制缓存(关) 的配置组合;
  • origin_first:对应控制台的 遵循源站 + 补充缓存(开) 的配置组合;
  • origin_first_Replenish:对应控制台的 遵循源站 + **补充缓存(关)**的配置组合。

CertInfo

参数类型是否必选示例值描述
CertIdStringcert-eb5d99026753499a8a34d2a4f0a08d92表示要关联的证书 ID。证书需要托管在火山引擎证书中心。

ForcedRedirect

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

StatusCode

String

301

表示当收到 HTTP 请求时 CDN 强制跳转到 HTTPS 的重定向响应状态码。支持的取值如下:

  • 301:表示返回的状态码是 301。
  • 302:表示返回的状态码是 302。
    默认值为 301

EnableForcedRedirect

Boolean

true

表示是否启用 HTTP 强制跳转到 HTTPS 特性。该参数有以下取值:

  • true:启用该特性,CDN 会将收到的 HTTP 请求重定向到 HTTPS 请求。
  • false:禁用该特性,CDN 不会将 HTTP 请求重定向到 HTTPS 请求。
    要启用该特性,您的加速域名必须已启用 HTTPS。

CacheKeyAction

参数类型是否必选示例值描述
CacheKeyComponentsArray of CacheKeyComponent-表示一个操作配置的列表。当前您仅可设置一个操作配置。

VodOriginArgAction

参数类型是否必选示例值描述
OriginArgComponentsArray of VodOriginArgComponents-表示一个操作列表。这些操作定义了 CDN 如何处理回源请求中的查询参数。当前,列表中只能包含一个操作。

CompressionRule

参数类型是否必选示例值描述
ConditionObject of CdnCondition-指定一个条件。如果请求满足该条件中的规则,则执行 CompressionAction 中定义的操作。如果指定了 CompressionFormat,则该字段必须为 null或不指定。
CompressionActionObject of CompressionAction-表示当用户请求满足 Condition 时,CDN 对请求文件执行的压缩操作的配置。

RequestHeaderAction

参数类型是否必选示例值描述
RequestHeaderInstancesArray of RequestHeaderInstance-表示一个请求头的配置规则列表。每个规则都包含一个头部的相关操作设置。您最多可以添加 50 条规则。

VodOriginalConfig

参数类型是否必选示例值描述
HostStringvod.example.com回源 Host。若未传入参数或传入空值,将默认将加速域名作为回源 Host。

Origins

String

www.byte.net

源站列表。

  • SourceStationAddressType 取值为 1(域名类型源站)时,您需要传入源站域名。仅支持传入一个域名。
  • SourceStationAddressType 取值为 2(IP 类型源站)时,您需要传入源站的 IP 地址,可传入多个 IP 地址,用逗号隔开。不可超过 10 个。
  • SourceStationAddressType 的取值为 3(对象存储类型源站)时,您需传入云厂商为存储桶分配的域名。该域名不应包含 https://,且长度不得超过 100 个字符。存储桶可来自火山引擎 TOS、阿里云 OSS、腾讯云 COS、AWS S3,或任何采用与 AWS S3 鉴权方式兼容的第三方对象存储服务。例如,若回源的火山桶为 test-tos,火山 TOS 分配的域名为 test-tos.tos-cn-boe.volces.com,则此域名即为需要填入的回源域名。

注意

当 SourceStationType 参数取值为 2(自定义源站加速域名)时,此参数必传。

OriginType

String

primary

源站类别。取值如下:

  • primary:主源站。

  • backup:备源站。

源站列表中必须至少包含一个主源站,备源站为可选。当前仅支持一个源站,若传入空值,则默认为主源站(primary);若传入的值既非空值,也非主源站(primary)或备源站(backup),则会报错。

PrivateBucketAuth

Object of VodPrivateBucketAuth

-

访问存储桶的凭证信息。

说明

  • 此参数仅当 SourceStationAddressType 取值为 3(对象存储类型源站)时生效。

  • 存储桶归属于您的火山引擎账号,则无需设置此参数。视频点播 CDN 服务可访问您账号下的 TOS 存储桶,无需凭证,即使存储桶为私有。

PrivateBucketAccess

Boolean

true

对象存储桶是否为私有桶。

  • true:私有桶。
  • false:(默认)非私有桶。

说明

此参数仅当 SourceStationAddressType 取值为 3(对象存储类型源站)时生效。

SourceStationAddressType

Integer

1

源站地址类型。取值如下:

  • 1:域名类型源站,即源站是域名。
  • 2:IP 类型源站,即源站是 IP 地址。
  • 3:对象存储类型源站,即源站是对象存储桶。

注意

当 SourceStationType 参数取值为 2(自定义源站加速域名)时,此参数必传。

RegionStringus-east-1存储桶所在地域的信息,也就是存储桶的 region code。Region code 参与签名的计算。若 AuthTypeaws_common 并且 PrivateBucketAccesstrue,您必须指定此参数。

Weight

String

1

该源站的权重,取值范围是 1-100,默认值是 1。权重越大,该源站在 CDN 发送回源请求时被选择到的概率也越大。

注意

该参数仅当 SourceStationAddressType1(IP 类型)或 2(域名类型)时才有效。

HttpPort

String

80

CDN 使用 HTTP 协议访问该源站时所访问的端口,取值范围是 1-65535,默认值是 80。如果源站没有开放该端口,您无需指定该参数。

注意

该参数仅当 SourceStationAddressType1(IP 类型)或 2(域名类型)时才有效。

HttpsPort

String

443

CDN 使用 HTTPS 协议访问该源站时所访问的端口,取值范围是 1-65535,默认值是 443。如果源站没有开放该端口,您无需指定该参数。

注意

该参数仅当 SourceStationAddressType1(IP 类型)或 2(域名类型)时才有效。

ReferersType

参数类型是否必选示例值描述
CommonTypeObject of CommonReferType-表示一个 CommonType 对象,其包含一个常规 Referer 列表。

DownloadSpeedLimitRule

参数类型是否必选示例值描述
ConditionObject of CdnCondition-指定一个条件。如果请求满足该条件中的规则,则执行 DownloadSpeedLimitAction 中定义的操作。可以不指定该参数,表示限速对所有文件生效。
DownloadSpeedLimitActionObject of DownloadSpeedLimitAction-表示限速配置。

VodOriginRewriteRule

参数类型是否必选示例值描述
OriginRewriteActionObject of VodOriginRewriteAction-表示 CDN 执行的动作。

VodResponseHeaderAction

参数类型是否必选示例值描述
ResponseHeaderInstancesArray of VodResponseHeaderInstance-响应头的配置规则列表。每个规则都包含一个头部的操作配置。最多支持 50 条规则。

ConditionRule

参数类型是否必选示例值描述
TypeStringurl表示请求的目标地址的类型,当前仅支持 url,表示 URL 类型的链接。

Value

String

png

表示 Object 对应的具体对象。参数值的长度不能超过 1,024 个字符。多个对象之间使用英文分号(;)分隔。该参数的说明如下:

  • 如果 Objectfiletype,表示一个或者多个文件后缀。文件后缀可以包含英文字母和数字。多个文件后缀使用分号(;)分隔。例如 xlsx 或者 png;txt
  • 如果 Objectdirectory,表示一个或者多个目录路径。多个目录使用分号(;)分隔。每个目录必须以斜杠(/)开头和结尾,例如 /www/img/volc/;/www/doc// 表示域名下所有目录中的文件。同时,目录可以包含除了以下字符的可打印 ASCII 字符:
    • 连续斜杠(//)、百分号(%)、美元符号($)、空格、问号(?)、Delete(ASCII code 127)
  • 如果 Objectpath,表示一个或者多个表示文件的路径。路径支持使用通配符(*)表示一个或者多个字符。多个路径使用分号(;)分隔,例如 /www/img/volcano.png;/doc/study.docx。路径必须以/ 开头。同时,路径可以包含除了以下字符的可打印 ASCII 字符:
    • 连续斜杠(//)、百分号(%)、美元符号($)、空格、问号(?)、Delete(ASCII code 127)
      在路径中,您可以使用 * 表示一个或者多个任意字符。例如 /www/img/volcano.png;/a*/ab*.png

Object

String

filetype

表示 CDN 对哪些对象类型进行规则匹配。支持的取值如下:

  • filetype:表示特定后缀的文件;
  • directory:表示特定文件目录下的所有文件;
  • path:表示特定的文件。
OperatorStringmatch表示匹配方式,当前仅支持 match,表示对请求的对象进行规则匹配。

CacheKeyComponent

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

Action

String

excludePart

执行动作,修改时需要指定。该参数有以下取值:

  • exclude:缓存键不包括任何查询参数,也就是去参数缓存。
  • include:缓存键包括所有的查询参数,也就是保留参数缓存。
  • includePart:缓存键包括 Subobject 中的查询参数,也就是保留部分参数缓存。
  • excludePart:缓存键不包括 Subobject 中的查询参数,也就是删除部分参数缓存。
ObjectStringqueryString表示需要设置的对象,当前仅可指定 queryString,即请求 URL 中的查询参数。

Subobject

String

sign;testParams

指定一个或者多个 Object 类型的对象。该参数的说明如下:

  • 如果Actioninclude 或者 excludeSubobject的值必须是 ** 表示全部查询参数。
  • 如果 ActionincludePart 或者 excludePart,您可以指定一个或者多个查询参数。您指定的查询参数不能是 *,也不能包含连续斜杠(//)、百分号(%)、空格。多个查询参数名称使用英文分号(;)分隔。
    Subobject 的默认值是 *

IgnoreCase

Boolean

true

表示 CDN 在匹配 Value 时,是否忽略大小写。该参数有以下取值:

  • true:表示忽略大小写。
  • false:表示不忽略大小写。
    该参数的默认值是 false

VodOriginArgComponents

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

Action

String

exclude

表示 CDN 执行的操作。该参数有以下取值:

  • include: 表示回源请求 URL 中包含用户请求 URL 中的全部查询参数。
  • exclude:表示回源请求 URL 中不包含用户请求 URL 中的任何查询参数。
  • addPart:表示回源请求 URL 中包含用户请求 URL 中的全部查询参数,并额外包含 Subobject 中指定的查询参数。
  • includePart:表示如果用户请求 URL 中包含 Subobject 中指定的查询参数,那么回源请求 URL 中包含这些指定的查询参数。
  • excludePart:表示回源请求 URL 中包含用户请求 URL 中的全部查询参数,除了Subobject 中指定的查询参数。
  • set:表示回源请求 URL 中包含用户请求 URL 中的全部查询参数。同时,对于您在 Subobject 中指定的查询参数和参数值,CDN 会执行以下操作:
    • 如果这些查询参数在用户请求 URL 中,CDN 会在回源请求 URL 中将这些参数的值设置为您指定的值。
    • 如果用户请求 URL 中不包含这些查询参数,CDN 会在回源请求 URL 中添加这些查询参数。
ObjectStringqueryString表示 CDN 对哪个对象执行 Action。当前,该参数值只能是 queryString,表示请求 URL 中的查询字符串。

Subobject

String

表示一个或者多个查询参数。多个查询参数之间使用分号(;)分隔,总长度不能超过 1,024 个字符。Subobject 只能包含字母、数字、下划线(_)、逗号(,)、短横线(-)、句点(.)和感叹号(!)。
在匹配请求 URL 中的查询参数时,Subobject 中的参数是大小写敏感的。
Subobject 的额外说明如下:

  • Actionincludeexclude 时,Subobject 必须是 *,表示请求 URL 中的所有查询参数。
  • ActionincludePartexcludePart 时,Subobject 表示一个或者多个查询参数。例如 param1;param2
  • ActionaddPartset 时,Subobject 表示一个或者多个查询参数和参数值,格式是 key=value。例如 param1=val1;param2=val2;param3=val3

CompressionAction

参数类型是否必选示例值描述
MaxFileSizeKBLong
MinFileSizeKBLong

CompressionType

Array of String

["gzip","br"]

表示 CDN 使用的压缩算法。该参数有以下取值:

  • br:表示 Brotli 压缩算法。
  • gzip:表示 Gzip 压缩算法。
    您可以同时指定这两个算法。
    需要留意的是,CDN 基于用户请求中 Accept-Encoding 头部来决定是否对请求文件进行压缩以及使用的压缩算法。

CompressionFormat

String

customize

表示 CDN 基于请求中的 Content-Type 头部对请求进行过滤。该参数有以下取值:

  • default:表示如果 Content-Type 头部值在下方的默认列表中,CDN 对请求文件执行 CompressionAction 中配置的操作。
  • customize:表示如果 Content-Type 头部值在 CompressionFormat 指定的头部值中,CDN 对请求文件执行 CompressionAction 中配置的操作。
    如果您需要 CDN 基于 Condition 中配置的过滤条件对请求进行过滤,您需 CompressionFormatall
    默认列表
    text/html、text/xml、text/plain、text/css、application/javascript、application/x-javascript、application/rss+xml、text/javascript、image/tiff、image/svg+xml、application/json、application/xml、text/plain; charset=utf-8

CompressionTarget

String

application/xml,hello/world

表示 Content-Type 的过滤值。

  • 如果 CompressionFormatdefault 或者 all,该参数必须为 *
  • 如果 CompressionFormatcustomize,您需要指定一个或者多个文件类型。多个文件类型之间以逗号(,)分隔。

RequestHeaderInstance

参数类型是否必选示例值描述
KeyStringContent-Disposition头部名称。名称不能超过 1,024 个字符,不区分大小写。可包含除以下字符外的可打印 ASCII 字符:下划线(_)、空格、双引号(")、Delete(ASCII code 127)。同时,不能使用这些特定的名称

Value

String

attachment;filename=FileName.xls

头部的值。仅当 Actionset 时有效。

  • ValueTypeconstant 时,您需要指定一个固定字符串作为头部的值。头部值的长度不能超过 1,024 个字符,可以包含除以下字符外的可打印 ASCII 字符:美元符号($)、Delete(ASCII code 127)
  • ValueTypevariable 时,Key 的值可以是来自该列表中的某个变量。除了名称包含下划线的变量,列表中的任何一个变量都可以作为 Key,并赋予一个固定字符串来替换其已有的值。也就是说,当您使用任意这些名称不包含下划线的变量作为 Key 时,其值是可以被覆盖的。
  • ValueTypecustomize 时,Key 的值是列表中的变量与固定字符串拼接后的字符串。在拼接的字符串中,变量使用 ${变量名} 表示。示例值:${remote_addr}aaa${host}ccc

Action

String

set

指定对请求头的操作。该参数有以下取值:

  • set:表示设置一个头部。设置操作包括添加与修改。如果请求中已包含该头部,该头部的值会被覆盖。如果请求中没有包含该头部,该头部会被添加。
  • delete,表示删除一个头部。

ValueType

String

constant

Key 的取值类型。仅当 Actionset 时有效。取值如下:

  • constantKey 的值是一个固定字符串。
  • variableKey 的值来自一个变量。
  • customizeKey的值是一个变量与固定字符串拼接后的字符串。

VodPrivateBucketAuth

参数类型是否必选示例值描述
SwitchBooleantrue访问存储桶是否需要凭证。此参数取值必须为 true

AuthType

String

tos

存储桶采用的是哪个对象存储服务所提供的鉴权方式。该参数有以下取值:

  • tos:火山引擎 TOS。

  • cos:腾讯云 COS。

  • oss:阿里云 OSS。

  • aws:AWS S3。若存储桶所在的对象存储服务使用的鉴权方式与 S3 兼容,也需将此参数设为 aws

  • aws_common:含义与 aws 相同。若 AuthTypeaws_common,您可以在 Origins 中指定用于访问存储桶的自定义域名,该自定义域名是您在存储桶所在的对象存储服务中自行配置的。
    该参数的默认值为空(""),默认指向火山引擎 TOS;若非火山引擎 TOS 三方源站,该参数不可为空。

说明

  • 若存储桶所属的云厂商未在 AuthType 参数描述中列出,或者存储桶来自另一个火山引擎主账号下的 TOS 服务,需以设置 AWS S3 存储桶的方式将存储桶设置为源站,并设置 TosAuthInformation

  • 火山引擎 TOS 控制台提供了存储桶的 S3 访问点以及存储桶的区域代码。

  • 若存储桶名称包含句点(.),您必须将 AuthType 指定为 aws_common,然后在 Origins 中指定云厂商分配给存储桶的 S3 域名,域名格式为 <bucket_name>.<S3_endpoint>

TosAuthInformation

Object of VodTosAuthInformation

-

存储桶的访问凭证。满足以下任意一个条件时,您必须设置此参数:

  • AuthType 不为 tos

  • AuthTypetos,但存储桶属于火山引擎另一个主账号下的 TOS 服务。

CommonReferType

参数类型是否必选示例值描述
ReferersArray 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

true

表示 CommonType 下的 Referers 列表是否是大小写敏感的。默认值为 true

  • true:表示大小写不敏感;
  • false:表示大小写敏感。

IgnoreScheme

Boolean

true

表示 CDN 是否对 Referer 中的 scheme 进行校验,也就是校验 Referer 是否包含 http:// 或者 https://。该参数有以下取值:

  • true: 表示 CDN 不校验 Referer 是否包含 scheme。在这个情况下,无论 Referer 是否包含 scheme,CDN 都会将 Referer 与您配置的名单进行匹配校验。
  • false: 表示 CDN 会先校验 Referer 是否包含 scheme。只有 Referer 包含 scheme,CDN 才会将 Referer 与您配置的名单进行匹配校验。否则,CDN 判定请求与您配置的名单不匹配。
    该参数的默认值是 false
    另外,该配置对
    RegularType
    下的正则表达式列表不生效,因为 CDN 依赖正则表达式来判断 Referer 是否匹配正则名单。

DownloadSpeedLimitAction

参数类型是否必选示例值描述
SpeedLimitRateLong1048576表示单个请求的下载速度上限,单位为 B/S,取值范围是 1-1,073,741,824,000,000
SpeedLimitTimeObject of SpeedLimitTime-表示限速发生的日期和时间段。
SpeedLimitRateAfterLong1048576表示单个请求下载的数据量阈值,单位为 Byte。当请求下载的数据量达到该阈值时,才会对该请求启用下载限速。取值范围为 0-1,073,741,824,000,000

VodOriginRewriteAction

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

SourcePath

String

^/img/food.png

表示一个正则表达式,长度不能超过 1,024 个字符,用于匹配用户请求 URL 中的对象。对于一个用户请求,如果该正则表达式匹配了对象中的任何部分,这条规则就匹配了这个用户请求。

  • RewriteTyperewrite_path 时,该对象指的是请求 URL 中的路径。
  • RewriteTyperewrite_url 时,该对象指的是请求 URL 中的路径和查询字符串。
    参见配置示例

说明

假设您在调用该 API 时在 SourcePath 中使用 \? 表示查询字符串中开头的 ?。当您调用 DescribeDomainConfig 查看 SourcePath 的值时,您会发现 \? 变成了 \\?。这个变化是符合预期的,因为 DescribeDomainConfig 返回内容是 JSON 格式,内容中的 \ 被转义成了 \\

TargetPath

String

/png/food.webp

表示改写后,回源请求 URL 中的对象。

  • RewriteTyperewrite_path 时,该对象是回源请求 URL 中的路径。
  • RewriteTyperewrite_url 时,该对象是回源请求 URL 中的路径和查询字符串。
    您可以在 TargetPath 中使用 $1$2$3 等表示您在 SourcePath 的正则表达式中定义的组。
    参见配置示例

RewriteType

String

rewrite_path

表示改写类型。该参数有以下取值:

  • rewrite_path:表示对请求 URL 中的路径进行改写。
  • rewrite_url:表示对请求 URL 中的路径和查询字符串进行改写。
    该参数的默认值是 rewrite_path

VodResponseHeaderInstance

参数类型是否必选示例值描述
KeyStringContent-Disposition头部名称。名称不能超过 1,024 个字符,不区分大小写。可包含除以下字符外的可打印 ASCII 字符:下划线(_)、空格、双引号(")、Delete(ASCII code 127)。同时,不能使用这些特定的名称

Value

String

attachment;filename=FileName.xls

头部的值。仅当 Action 为 set 时有效。

  • 当 ValueType 为 constant 时,您需要指定一个固定字符串作为头部的值。头部值的长度不能超过 1,024 个字符,可以包含除以下字符外的可打印 ASCII 字符:美元符号($)、Delete(ASCII code 127)
  • 当 ValueType 为 variable 时,Key 的值可以是来自该列表中的某个变量。除了名称包含下划线的变量,列表中的任何一个变量都可以作为 Key,并赋予一个固定字符串来替换其已有的值。也就是说,当您使用任意这些名称不包含下划线的变量作为 Key 时,其值是可以被覆盖的。
  • 当 ValueType 为 customize 时,Key 的值是列表中的变量与固定字符串拼接后的字符串。在拼接的字符串中,变量使用 ${变量名} 表示。示例值:${remote_addr}aaa${host}ccc

Action

String

set

对响应头的操作。取值如下:

  • set:设置一个头部。设置操作包括添加与修改。如果源站响应中已包含该头部,该头部的值会被覆盖。如果源站响应中没有包含该头部,该头部会被添加。
  • delete: 删除一个头部。

ValueType

String

constant

Key 的取值类型。仅当 Action 为 set 时有效。取值如下:

  • constantKey 的值是一个固定字符串。
  • variableKey 的值来自一个变量。
  • customizeKey 的值是一个变量与固定字符串拼接后的字符串。

AccessOriginControl

Boolean

false

在点播 CDN 响应用户请求时,是否校验请求头中的 Origin 字段。取值如下:

  • true:点播 CDN 会校验 Origin 字段。
    • 如果校验成功,CDN 会在响应头中包含 Access-Control-Allow-Origin 字段。字段值与 Origin 字段值相同。
    • 如果校验失败,响应头中不会包含 Access-Control-Allow-Origin 字段。
  • false:(默认)CDN 不会校验 Origin 字段。在响应头中,CDN 会包含 Access-Control-Allow-Origin 字段。字段值是您配置的 Access-Control-Allow-Origin 的内容。

注意

该参数仅在以下条件都满足的情况下有效:

  • Action 是 set
  • Key 是 Access-Control-Allow-Origin
  • ValueType 是 constant

VodTosAuthInformation

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

AccessKeyId

String

AKLTYTg1NGIzOWEw***NTk3MzM5ZWNiNmE0MGU

访问凭证中的 Access Key ID(简称 AK)。

  • AuthType 取值为 oss,设为您阿里云账号的 AccessKey ID。

  • AuthType 取值为 cos,设为您腾讯云账号的 SecretId。

  • AuthType 取值为 aws,设为您 AWS 账号的 access key ID。

  • AuthType 取值为 tos,设为存储桶所属的火山引擎账号的 AccessKey ID。

AccessKeySecret

String

WlRjNVpUUTBZVEEyT1***Zd01HRTRPREppWm1VME1qaw==

访问凭证中的 Secret Access Key(简称 SK)。

  • AuthType 取值为 oss,设为您阿里云账号的 AccessKey Secret。

  • AuthType 取值为 cos,设为您腾讯云账号的 SecretKey。

  • AuthType 取值为 aws,设为您 AWS 账号的 secret access key。

  • AuthType 取值为 tos,设为存储桶所属的火山引擎账号的 AccessKey Secret。

SpeedLimitTime

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

DayWeek

String

monday;friday

表示限速发生的日期。支持的取值如下:

  • monday:周一;
  • tuesday:周二;
  • wednesday:周三;
  • thursday:周四;
  • friday:周五;
  • saturday:周六;
  • sunday:周日;
  • unlimited:每天。
    可以指定一个或多个值,多个值之间使用英文分号(;)分隔。
EndTimeString23:59表示限速发生的结束时间,格式为 mm:ss。当 DayWeek 的值为 unlimited 时,默认值为 23:59
BeginTimeString09: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"
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码,详见视频点播公共错误码

状态码错误码错误信息说明
400InvalidParameter.InvalidDomainTypeDomain type must be play/imageDomainType 取值不合法
400InvalidParameter.DomainNotFoundThe domain does not exist域名不存在
400InvalidParameter.DomainBeLockedThe domain has been locked. Please contact sre for processing域名已锁定
最近更新时间:2025.11.21 16:11:18
这个页面对您有帮助吗?
有用
有用
无用
无用