修改域名 URL 鉴权配置--视频点播-火山引擎

文档中心

立即注册

导航

修改域名 URL 鉴权配置

最近更新时间：2024.11.06 17:52:55首次发布时间：2023.12.20 15:08:09

此接口用于在指定空间下修改域名 URL 鉴权配置。

注意事项

URL 鉴权类型：目前支持 TypeA 类型的 URL 鉴权。
点播调度：调用 AddDomainToScheduler 将域名添加至点播调度后，不允许修改 URL 鉴权配置。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateDomainUrlAuthConfig`	接口名称。当前 API 的名称为 `UpdateDomainUrlAuthConfig`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceName	String	是	`test`	点播空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
DomainType	String	是	`play`	域名类别。目前支持的取值为 `play`：播放域名。
Domain	String	是	`www.example.com`	域名。您可通过 ListDomain 接口获取当前空间账号下的所有域名列表。域名规则如下：支持精确域名。不支持添加泛域名，如 `*.vod.com`。不支持大写。不支持重复域名。
MainKey	String	否	`testM`	主密钥。如果不为空，长度为 6-40 个字符。说明当 `Status` 参数取值为 `enable` 时，该参数必传。
BackupKey	String	否	`testB`	备用密钥。如果不为空，长度为 6-40 个字符。说明当 `Status` 参数取值为 `enable` 时，该参数必传。
Status	String	是	`enable`	是否开启 URL 鉴权。取值如下： `enable`：开启。 `disable`：关闭。说明源站类型为点播加速域名时，即 CreateDomain 的请求参数中 `SourceStationType` 取值为 1 时，该参数才有效。如果鉴权类型为 C 或者 E 时，需要配置该参数 `Status` 取值为 `disable` 时，再次 `enable` 开启后，鉴权类型变为 A。

返回参数

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

请求示例

https://vod.volcengineapi.com?Action=UpdateDomainUrlAuthConfig&Version=2023-07-01

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110***100232280022D31",
    "Action": "UpdateDomainUrlAuthConfig",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：