You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /
  • 视频点播

创建域名

最近更新时间：2024.01.09 11:55:20

首次发布时间：2023.02.27 13:25:47

我的收藏

此接口用于创建域名。

请求说明

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

调试

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

请求参数

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

参数类型是否必选示例值描述
ActionString是CreateDomain接口名称。当前 API 的名称为 CreateDomain。
VersionString是2023-02-01接口版本。当前 API 的版本为 2023-02-01。

SpaceName

String

是

test-space

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

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

DomainType

String

是

play

域名类别。取值如下：

  • play：播放域名。
  • image：封面域名。

Domain

String

是

example.byte-test.com

域名。域名规则如下：

  • 支持精确域名。
  • 不支持添加泛域名，如 *.vod.com。
  • 不支持大写。
  • 不支持重复域名。

SourceStationType

Integer

是

2

源站类型。取值如下：

  • 1：点播加速域名。
  • 2：自定义源站加速域名。

SourceStationAddressType

Integer

否

1

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

  • 1：域名类型源站。
  • 2：IP 类型源站。

说明

在 SourceStationType 参数取值为 2（自定义源站加速域名）时，该参数是必传的。

Origins

String

否

www.byte.net

源站列表。多个用逗号隔开。

  • 域名类型源站：只能有 1 个。
  • IP 类型源站：不能超过 10 个。

说明

在 SourceStationType 参数取值为 2（自定义源站加速域名）时，该参数是必传的。

Area

String

是

cn

地区。取值如下：

  • cn：中国内地
  • overseas：（白名单）港澳台及海外
  • global：（白名单）全球

返回参数

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

请求示例

https://vod.volcengineapi.com?Action=CreateDomain&Version=2023-02-01&SpaceName=space&DomainType=play&Domain=www.byte.net&SourceStationType=1&SourceStationAddressType=1&Origins&www.byte.net&Area=cn

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202302151527***3D791E306FD67FD5C",
    "Action": "CreateDomain",
    "Version": "2023-02-01",
    "Service": "vod",
    "Region": "cn-north-1"
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，更多信息请见公共错误码。

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

服务端 SDK

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