调用 CreateDomain
接口在指定空间下创建指定域名类别、源站类型的域名。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDomain | 接口名称。当前 API 的名称为 CreateDomain 。 |
Version | String | 是 | 2023-02-01 | 接口版本。当前 API 的版本为 2023-02-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
SpaceName | String | 是 | test-space | |
DomainType | String | 是 | play | 域名类型。取值如下:
说明 详见域名类型介绍。 |
Domain | String | 是 | example.vod.com | 域名。需遵循以下规则:
|
SourceStationType | Integer | 是 | 1 | 源站类型。取值如下:
|
SourceStationAddressType | Integer | 否 | 1 | 源站地址类型。取值如下:
注意 当 |
Origins | String | 否 | www.byte.net | 源站列表。
注意 当 |
Area | String | 是 | cn | 加速地区。取值如下:
|
BucketName | String | 否 | test-tos | 挂载的火山引擎 TOS 存储桶名称。 |
Host | String | 否 | vod.example.com | 回源 Host。若未传入参数或传入空值,将默认将加速域名作为回源 Host。 |
PrivateBucketAccess | Boolean | 否 | true | 对象存储桶是否为私有桶。
说明 此参数仅当 |
PrivateBucketAuth | Object | 否 | - | 访问存储桶的凭证信息。 说明
|
Switch | Boolean | 否 | true | 访问存储桶是否需要凭证。此参数取值必须为 true 。 |
AuthType | String | 否 | tos | 存储桶采用的是哪个对象存储服务所提供的鉴权方式。该参数有以下取值:
该参数的默认值为空(""),默认指向火山引擎 TOS;若非火山引擎 TOS 三方源站,该参数不可为空。 说明
|
TosAuthInformation | Object | 否 | - | 存储桶的访问凭证。满足以下任意一个条件时,您必须设置此参数:
|
AccessKeyId | String | 否 | AKLTYTg1NGIzOWEw***NTk3MzM5ZWNiNmE0MGU | 访问凭证中的 Access Key ID(简称 AK)。
|
AccessKeySecret | String | 否 | WlRjNVpUUTBZVEEyT1***Zd01HRTRPREppWm1VME1qaw== | 访问凭证中的 Secret Access Key(简称 SK)。
|
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" } }
下表列举了本接口特有的错误码。如需了解更多错误码,详见视频点播公共错误码。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
403 | RequestForbidden.AccessIsRestricted | - | 账号访问受到限制。 |
视频点播为 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: