文档中心

创建域名

最近更新时间：2023.07.28 13:03:57

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

此接口用于创建域名。

请求说明

接口名称：CreateDomain
接口地址：https://vod.volcengineapi.com?Action=CreateDomain&Version=2023-02-01

请求参数

参数	类型	是否必选	描述
Action	String	是	接口名称。当前接口取值为 `CreateDomain`。
Version	String	是	接口版本。当前接口取值为 `2023-02-01`。
SpaceName	String	是	空间名称。您可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
DomainType	String	是	域名类别。取值如下： play：播放域名。 image：封面域名。
Domain	String	是	域名。暂不支持添加泛域名，如"*.vod.com"。详细的域名规则如下所示。支持精确域名。例如：`example.byte-test.com` 不支持大写。不支持重复域名。
SourceStationType	Integer	是	源站类型。取值如下： 1：点播加速域名。 2：自定义源站加速域名。
SourceStationAddressType	Integer	否	源站地址类型。取值如下： 1：域名类型源站。 2：IP 类型源站。说明在 `SourceStationType` 参数取值为 2（自定义源站加速域名）时，该参数是必传的。
Origins	String	否	源站列表。多个用逗号隔开。域名类型源站：只能有 1 个。 IP 类型源站：不能超过 10 个。说明在 `SourceStationType` 参数取值为 2（自定义源站加速域名）时，该参数是必传的。
Area	String	是	地区。取值如下： cn：中国内地 overseas：（白名单）港澳台及海外 global：（白名单）全球说明如果您需要除中国内地以外的区域，需要开通白名单，请联系我们申请开通。

返回参数

参数	类型	描述
ResponseMetadata	ResponseMetadata	通用响应信息

ResponseMetadata

参数	类型	描述
RequestId	String	请求 ID
Action	String	请求接口
Version	String	版本
Service	String	服务
Region	String	区域
Error	ResponseError	异常信息

ResponseError

参数	类型	描述
Code	String	错误码
Message	String	详细错误信息

示例

请求示例

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"
    }
}

错误码

详见视频点播公共错误码。

服务端 SDK

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

请求说明

请求参数

返回参数

ResponseMetadata

ResponseError

示例

请求示例

返回示例

错误码

服务端 SDK