调用 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 | 是 | test-space | |
DomainType | String | 是 | play | 域名类型。取值如下:
说明 详见域名类型介绍。 |
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 | String | 否 | set | 对响应头的操作。取值如下:
|
ValueType | String | 否 | constant |
|
AccessOriginControl | Boolean | 否 | false | 在点播 CDN 响应用户请求时,是否校验请求头中的
注意 该参数仅在以下条件都满足的情况下有效:
|
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 | 源站列表。
注意 当 |
OriginType | String | 否 | primary | 源站类别。取值如下:
|
PrivateBucketAuth | Object | 否 | - | 访问存储桶的凭证信息。 说明
|
Switch | Boolean | 否 | true | 访问存储桶是否需要凭证。此参数取值必须为 true 。 |
AuthType | String | 否 | tos | 存储桶采用的是哪个对象存储服务所提供的鉴权方式。该参数有以下取值:
该参数的默认值为空(""),默认指向火山引擎 TOS;若非火山引擎 TOS 三方源站,该参数不可为空。 说明
|
TosAuthInformation | Object | 否 | - | 存储桶的访问凭证。满足以下任意一个条件时,您必须设置此参数:
|
AccessKeyId | String | 否 | AKLTYTg1NGIzOWEw***NTk3MzM5ZWNiNmE0MGU | 访问凭证中的 Access Key ID(简称 AK)。
|
AccessKeySecret | String | 否 | WlRjNVpUUTBZVEEyT1***Zd01HRTRPREppWm1VME1qaw== | 访问凭证中的 Secret Access Key(简称 SK)。
|
PrivateBucketAccess | Boolean | 否 | true | 对象存储桶是否为私有桶。
说明 此参数仅当 |
SourceStationAddressType | Integer | 否 | 1 | 源站地址类型。取值如下:
注意 当 |
Region | String | 否 | us-east-1 | 存储桶所在地域的信息,也就是存储桶的 region code。Region code 参与签名的计算。若 AuthType 为 aws_common 并且 PrivateBucketAccess 为 true ,您必须指定此参数。 |
本接口无特有的返回参数。具体请见公共返回参数。
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 | 域名已锁定 |