You need to enable JavaScript to run this app.
导航

批量添加域名

最近更新时间2023.10.23 16:12:33

首次发布时间2023.08.11 11:29:24

批量添加域名。域名请在工信部完成备案。新添加的域名的状态为审核中

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainsArray of Domains-域名列表,总和最多十个。

Region

String

cn

区域,包含四种类型。

  • cn:中国大陆;
  • cn-global:全球;
  • cn-oversea:海外及港澳台
VhostStringvhost域名空间名称。
ProjectNameStringdefault项目名称,vhost 将归类这个项目里,新创建的 vhost 才需要。
TagsArray of Tags-标签列表,vhost 将归类这个 tag 里,新创建的 vhost 才需要。

Domains

参数类型是否必选示例值描述
DomainNameStringpush.example.com域名名称。
ChainIDString93cb8cf3*******ece5600142证书ID。

Type

String

push

域名类型。

  • push:推流域名
  • pull-flv:拉流域名

Tags

参数类型是否必选示例值描述
KeyStringkey001标签KEY值。
ValueStringValuedes标签Value值。

Category

String

Custom

标签类型。

  • System
  • Custom

返回参数

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

示例

请求示例

POST https://live.volcengineapi.com?Action=CreateDomainV2&Version=2023-01-01
{
  "Region": "cn",
  "Vhost": "vhost",
  "Domains": [
    {
      "DomainName": "push.example.Custom",
      "Type": "push",
      "ChainID": "93cb8cf3*******ece5600142"
    },
    {
      "DomainName": "pull.example.Custom",
      "Type": "pull-flv",
      "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"
  },
}

错误码

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

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