You need to enable JavaScript to run this app.
导航
CreateDomain - 添加域名
最近更新时间:2025.05.30 17:48:25首次发布时间:2023.02.27 13:25:47
我的收藏
有用
有用
无用
无用

调用 CreateDomain 接口在指定空间下创建指定域名类别、源站类型的域名。

请求说明

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

调试

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
SpaceName
String
test-space

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

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

域名类型。取值如下:

  • play:点播加速域名和自定义源站加速域名。
  • image:封面加速域名。

说明

详见域名类型介绍

Domain
String
example.vod.com

域名。需遵循以下规则:

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

源站类型。取值如下:

  • 1:点播源站
  • 2:自定义源站
SourceStationAddressType
Integer
1

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

  • 1:域名类型源站,即源站是域名。
  • 2:IP 类型源站,即源站是 IP 地址。
  • 3:对象存储类型源站,即源站是对象存储桶。

注意

当 SourceStationType 参数取值为 2(自定义源站加速域名)时,此参数必传。

Origins
String
www.byte.net

源站列表。

  • SourceStationAddressType 取值为 1(域名类型源站)时,您需要传入源站域名。仅支持传入一个域名。
  • SourceStationAddressType 取值为 2(IP 类型源站)时,您需要传入援站的 IP 地址,可传入多个 IP 地址,用逗号隔开。不可超过 10 个。
  • SourceStationAddressType 的取值为 3(对象存储类型源站)时,您需传入云厂商为存储桶分配的域名。该域名不应包含 https://,且长度不得超过 100 个字符。存储桶可来自火山引擎 TOS、阿里云 OSS、腾讯云 COS、AWS S3,或任何采用与 AWS S3 鉴权方式兼容的第三方对象存储服务。例如,若回源的火山桶为 test-tos,火山 TOS 分配的域名为 test-tos.tos-cn-boe.volces.com,则此域名即为需要填入的回源域名。

注意

当 SourceStationType 参数取值为 2(自定义源站加速域名)时,此参数必传。

Area
String
cn

加速地区。取值如下:

  • cn:中国内地
  • overseas:(白名单)港澳台及海外
  • global:(白名单)全球
BucketName
String
test-tos
挂载的火山引擎 TOS 存储桶名称。
Host
String
vod.example.com
回源 Host。若未传入参数或传入空值,将默认将加速域名作为回源 Host。
PrivateBucketAccess
Boolean
true

对象存储桶是否为私有桶。

  • true:私有桶。
  • false:(默认)非私有桶。

说明

此参数仅当 SourceStationAddressType 取值为 3(对象存储类型源站)时生效。

PrivateBucketAuth
Object
-

访问存储桶的凭证信息。

说明

  • 此参数仅当 SourceStationAddressType 取值为 3(对象存储类型源站)时生效。

  • 存储桶归属于您的火山引擎账号,则无需设置此参数。视频点播 CDN 服务可访问您账号下的 TOS 存储桶,无需凭证,即使存储桶为私有。

Switch
Boolean
true
访问存储桶是否需要凭证。此参数取值必须为 true
AuthType
String
tos

存储桶采用的是哪个对象存储服务所提供的鉴权方式。该参数有以下取值:

  • tos:火山引擎 TOS。

  • cos:腾讯云 COS。

  • oss:阿里云 OSS。

  • aws:AWS S3。若存储桶所在的对象存储服务使用的鉴权方式与 S3 兼容,也需将此参数设为 aws

  • aws_common:含义与 aws 相同。若 AuthTypeaws_common,您可以在 Origins 中指定用于访问存储桶的自定义域名,该自定义域名是您在存储桶所在的对象存储服务中自行配置的。

该参数的默认值为空(""),默认指向火山引擎 TOS;若非火山引擎 TOS 三方源站,该参数不可为空。

说明

  • 若存储桶所属的云厂商未在 AuthType 参数描述中列出,或者存储桶来自另一个火山引擎主账号下的 TOS 服务,需以设置 AWS S3 存储桶的方式将存储桶设置为源站,并设置 TosAuthInformation

  • 火山引擎 TOS 控制台提供了存储桶的 S3 访问点以及存储桶的区域代码。

  • 若存储桶名称包含句点(.),您必须将 AuthType 指定为 aws_common,然后在 Origins 中指定云厂商分配给存储桶的 S3 域名,域名格式为 <bucket_name>.<S3_endpoint>

TosAuthInformation
Object
-

存储桶的访问凭证。满足以下任意一个条件时,您必须设置此参数:

  • AuthType 不为 tos

  • AuthTypetos,但存储桶属于火山引擎另一个主账号下的 TOS 服务。

AccessKeyId
String
AKLTYTg1NGIzOWEw***NTk3MzM5ZWNiNmE0MGU

访问凭证中的 Access Key ID(简称 AK)。

  • AuthType 取值为 oss,设为您阿里云账号的 AccessKey ID。

  • AuthType 取值为 cos,设为您腾讯云账号的 SecretId。

  • AuthType 取值为 aws,设为您 AWS 账号的 access key ID。

  • AuthType 取值为 tos,设为存储桶所属的火山引擎账号的 AccessKey ID。

AccessKeySecret
String
WlRjNVpUUTBZVEEyT1***Zd01HRTRPREppWm1VME1qaw==

访问凭证中的 Secret Access Key(简称 SK)。

  • AuthType 取值为 oss,设为您阿里云账号的 AccessKey Secret。

  • AuthType 取值为 cos,设为您腾讯云账号的 SecretKey。

  • AuthType 取值为 aws,设为您 AWS 账号的 secret access key。

  • AuthType 取值为 tos,设为存储桶所属的火山引擎账号的 AccessKey Secret。

Region
String
us-east-1
存储桶所在地域的信息,也就是存储桶的 region code。Region code 参与签名的计算。若 AuthType 为 aws_common 并且 PrivateBucketAccess 为 true,您必须指定此参数。

返回参数

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

请求示例

POST https://vod.volcengineapi.com?Action=CreateDomain&Version=2023-02-01
{
  "SpaceName": "test-space",
  "DomainType": "play",
  "Domain": "example.vod.com",
  "SourceStationType": 1,
  "Area": "cn"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "CreateDomain",
    "Version": "2023-02-01",
    "Service": "vod",
    "Region": "cn-north-1"
  }
}

错误码

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

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

服务端 SDK

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