最近更新时间:2023.10.23 16:12:33
首次发布时间:2023.08.11 11:29:24
批量添加域名。域名请在工信部完成备案。新添加的域名的状态为审核中。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDomainV2 | 接口名称。当前 API 的名称为 CreateDomainV2 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Domains | Array of Domains | 是 | - | 域名列表,总和最多十个。 |
Region | String | 是 |
| 区域,包含四种类型。
|
Vhost | String | 是 | vhost | 域名空间名称。 |
ProjectName | String | 否 | default | 项目名称,vhost 将归类这个项目里,新创建的 vhost 才需要。 |
Tags | Array of Tags | 否 | - | 标签列表,vhost 将归类这个 tag 里,新创建的 vhost 才需要。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainName | String | 是 | push.example.com | 域名名称。 |
ChainID | String | 否 | 93cb8cf3*******ece5600142 | 证书ID。 |
Type | String | 是 |
| 域名类型。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Key | String | 是 | key001 | 标签KEY值。 |
Value | String | 是 | Valuedes | 标签Value值。 |
Category | String | 是 |
| 标签类型。
|
本接口无特有的返回参数。更多信息请见返回结构。
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" }, }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
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. | 内部服务超时,请联系技术支持。 |