You need to enable JavaScript to run this app.
导航
UpdateDomainConfig - 更新域名配置
最近更新时间:2025.05.30 17:37:19首次发布时间:2024.07.18 17:51:15
我的收藏
有用
有用
无用
无用

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

使用说明

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

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

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

注意事项

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

请求说明

请求地址: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
test-space

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

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

域名类型。取值如下:

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

说明

详见域名类型介绍

Domain
String
example.test.com
待修改配置的域名。
Config
Object
-
表示本次修改的配置。
ResponseHeaderControl
Object
-
HTTP 响应头配置模块。不传此参数表示不对该模块进行修改。更多信息,请见配置 HTTP 响应头
ResponseHeader
Object[]
-
HTTP 响应头配置。空值表示清空该模块配置。
ResponseHeaderAction
Object
-
点播 CDN 在响应用户请求的时候,对响应头的操作。
ResponseHeaderInstances
Object[]
-
响应头的配置规则列表。每个规则都包含一个头部的操作配置。最多支持 50 条规则。
Key
String
Content-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
OriginalControl
Object
-
源站配置模块。不传此参数表示不对该模块进行修改。
Host
String
vod.example.com
回源 Host,其优先级低于 VodOriginalConfig 中设置的 Host。若未传入此参数,则视为不进行更新。该参数的更新仅在 Origins 参数有效时才会生效。
Origins
Object[]
-
源站配置。当前仅支持单个源站。
Host
String
vod.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
-

访问存储桶的凭证信息。

说明

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

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

Switch
Boolean
true
访问存储桶是否需要凭证。此参数取值必须为 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
-

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

  • AuthType 不为 tos

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

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。

PrivateBucketAccess
Boolean
true

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

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

说明

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

SourceStationAddressType
Integer
1

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

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

注意

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

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

返回参数

本接口无特有的返回参数。具体请见公共返回参数

请求示例

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域名已锁定