启用域名--视频点播-火山引擎

文档中心

立即注册

导航

视频点播

启用域名

最近更新时间：2024.11.06 17:52:55首次发布时间：2023.11.07 18:16:37

此接口用于在指定空间下，启用不同类型下的指定域名。

使用说明

启用域名并且加入点播调度后，才能播放。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`StartDomain`	接口名称。当前 API 的名称为 `StartDomain`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceName	String	是	`test`	点播空间名称。您可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
DomainType	String	是	`play`	域名类型。取值如下： `play`：播放域名 `image`：封面域名
Domain	String	是	`example.vod.com`	域名。您可通过 ListDomain 接口获取当前空间账号下的所有域名列表。域名规则如下：支持精确域名。不支持添加泛域名，如 `*.vod.com`。不支持大写。不支持重复域名。
SourceStationType	Integer	是	`1`	源站类型。取值如下： `1`：点播源站。 `2`：自定义源站。

返回参数

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

请求示例

https://vod.volcengineapi.com?Action=StartDomain&Version=2023-07-01&Domain=example.vod.com&DomainType=play&SourceStationType=1&SpaceName=test

返回示例

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

错误码

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

状态码	错误码	错误信息	说明
403	RequestForbidden.AccessIsRestricted	-	账号访问受到限制。

服务端 SDK

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