新增域名--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

新增域名

最近更新时间：2025.01.08 18:09:09首次发布时间：2021.02.23 10:42:23

本接口支持通过指定服务 ID 以及输入域名等相关配置项，向该服务新增域名。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=AddDomainV1&Version=2018-08-01

调试

API Explorer

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

去调试

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 AddDomainV1 接口名称。当前 API 的名称为 AddDomainV1。

Version String 是 2018-08-01 接口版本。当前 API 的版本为 2018-08-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`AddDomainV1`	接口名称。当前 API 的名称为 `AddDomainV1`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`qhc**nuslz`	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

qhc**nuslz

服务 ID。

您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
domain	String	是	`test456.volcimagextest.com`	新增域名。
https	Array of Https	否	`-`	证书配置，海外加速或者全球加速为必选，否则审核不通过。
access_control	Array of AccessControl	否	`-`	访问控制配置。
resp_hdrs	Array of RespHdrs	否	`-`	请求需要添加的响应头。

Https

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
enable_https	Boolean	否	`true`	是否开启 Https，取值如下所示： `true`：开启 `false`：关闭
force_https	Boolean	否	`false`	是否强制使用 Https，取值如下所示： `true`：强制 `false`：不强制
cert_id	String	否	`cert-bce71503813******84072a423610471`	证书 ID，若`enable_https`为`true`，则为必选。

enable_https

Boolean

否

true

是否开启 Https，取值如下所示：

true：开启
false：关闭

force_https

Boolean

否

false

是否强制使用 Https，取值如下所示：

true：强制
false：不强制

cert_id String 否 cert-bce71503813******84072a423610471 证书 ID，若enable_https为true，则为必选。

AccessControl

参数	类型	是否必选	示例值	描述
refer_link	Array of ReferLink	否	`-`	Referer 配置。

RespHdrs

参数	类型	是否必选	示例值	描述
key	String	是	`Access-Control-Allow-Origin`	Header Key，请见支持配置的响应头。
value	String	否	`*`	Header Value，设置该响应头字段的值。字段值不能超过 1,024 个字符，可以包含除美元符号（$），Delete（ASCII code 127）外的可打印 ASCII 字符。

ReferLink

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启 Referer 防盗链，取值如下所示： `true`：开启 `false`：关闭
is_white_mode	Boolean	否	`true`	是否配置白名单，取值如下所示： `true`：配置白名单 `false`：配置黑名单
values	Array of String	否	`["s.com", "y.com", "q.com"]`	根据是否为白名单，为对应的白/黑名单的值。
allow_empty_refer	Boolean	否	`false`	是否允许空 Referer，取值如下所示： `true`：允许空 Referer `false`：不允许空 Referer

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Domain	String	`test456.volcimagextest.com`	新增的域名。

请求示例

POST https://imagex.volcengineapi.com/?Action=AddDomainV1&Version=2018-08-01&ServiceId=qhc**nuslz
{
    "domain": "test456.volcimagextest.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "AddDomainV1",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Domain": "test456.volcimagextest.com"
    }
}

错误码

访问公共错误码和域名相关错误码获取详细信息。