批量添加域名--视频直播-火山引擎

文档中心

立即注册

导航

批量添加域名

最近更新时间：2024.06.25 11:17:43首次发布时间：2023.08.11 11:29:24

调用 CreateDomainV2 接口，批量添加域名到视频直播服务，并配置加速区域。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：
- 加速区域包含中国内地时（即加速区域选择中国内地加速或全球加速），待添加域名需进过 ICP 备案；
- 添加域名前请在视频直播控制台上完成主域名的域名归属权校验。
费用说明：不同的加速区域，直播服务费的价格不同，设置加速区域前，请参考直播服务费了解价格详情。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=CreateDomainV2&Version=2023-01-01

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Domains	Array of Domains	是	`["push.example.com","pull.example.com"]`	待添加到视频直播服务进行加速的域名列表信息。说明一个域名空间下最多包含 10 个域名。
Vhost	String	是	`push.example.com`	域名空间，是一组关联域名的集合，由字母（A - Z、a -z）、数字（0 - 9）和连字符（-）组成。您可以自定义新的域名空间或调用 ListDomainDetail 接口获取已有域名使用的域名空间。
ProjectName	String	否	`default`	为域名空间设置所属项目，默认为空表示归属到 `default` 项目，新建域名空间时需要为域名空间绑定项目，您可以在访问控制-项目列表查看已有项目并对项目进行管理。项目是火山引擎提供的一种资源管理方式，您可以对不同业务或项目使用的云资源进行分组管理，以实现基于项目的账单查看、子账号授权等功能。新建域名空间时，需为域名空间设置所属项目。每个域名空间只能属于一个项目，选择已有的域名空间时，项目不可配置；使用基于项目的账单查看需提前开通分账服务，请前往账单管理-分账账单进行服务开通；使用基于项目的子账号授权请参见使用 IAM 用户进行项目权限划分。
Tags	Array of Tags	否	`-`	为域名空间设置资源标签。您可以通过资源标签从不同维度对云资源进行分类和聚合管理，如资源分账等场景。说明如需使用标签进行资源分账，可以在可以在账单管理-费用标签处管理启用标签，将对应标签运用到账单明细等数据中。

Domains

参数	类型	是否必选	示例值	描述
DomainName	String	是	`push.example.com`	域名名称，域名由字母（A - Z、a -z）、数字（0 - 9）和连字符（-）组成，长度为 1 到 60 个字符。
ChainID	String	否	`93cb8cf3*******ece5600142`	HTTPS 证书链 ID，默认为空表示不为域名绑定 HTTPS 证书。您可以调用 ListCertV2 接口或在视频直播控制台的证书管理页面，获取待绑定的证书链 ID。
Type	String	是	`push`	域名类型，取值及含义如下所示。 `push`：推流域名； `pull-flv`：拉流域名。
Region	String	是	`cn`	域名加速区域，取值及含义如下所示。 `cn`：中国内地加速； `cn-global`：全球加速； `cn-oversea`：海外及港澳台加速。

参数	类型	是否必选	示例值	描述
Key	String	是	`key001`	标签 Key 值。
Value	String	是	`Valuedes`	标签 Value 值。
Category	String	是	`Custom`	标签类型，支持以下取值。 `System`：系统内置标签； `Custom`：自定义标签。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://live.volcengineapi.com?Action=CreateDomainV2&Version=2023-01-01
{
  "Vhost": "vhost",
  "Domains": [
    {
      "DomainName": "push.example.com",
      "Type": "push",
      "Region": "cn",
      "ChainID": "93cb8cf3*******ece5600142"
    },
    {
      "DomainName": "pull.example.com",
      "Type": "pull-flv",
      "Region": "cn",
      "ChainID": "93c56cf3*******ece522142"
    }
  ],
  "ProjectName": "default",
  "Tags": [
    {
      "Key": "key001",
      "Value": "Valuedes",
      "Category": "Custom"
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "CreateDomainV2",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
400	InvalidParam.Format	%s format error	参数格式错误，请检查错误消息中指定参数中是否存在非法字符或 URL 格式错误。
400	InvalidParam.OutOfRange	%s should be one of {[%s]}%s should be between %d and %d	参数超出允许范围，请检查错误消息中指定参数的取值是否超出取值范围。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
500	InternalError.DB	an internal error related to database occurred, please contact the administrator.	出现与数据库相关的内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。