文档中心

新增域名

最近更新时间：2024.01.31 15:03:35

首次发布时间：2021.02.23 10:42:23

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

请求说明

接口名称：AddDomainV1
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=AddDomainV1&Version=2018-08-01
请求频率限制：10 次/秒
超时时间：5 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必选描述

Action String 是接口名称。

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

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

ServiceId

String

是

服务 ID。

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

Body

参数	类型	是否必选	描述
domain	String	是	域名，您可以通过调用获取服务下全部域名获取当前服务下所有域名。
https	Array of HTTPSConfigT	否	证书配置，海外加速或者全球加速为必选，否则审核不通过。
access_control	Array of AccessControlConfigT	否	访问控制配置
resp_hdrs	Array of HdrT	否	请求需要添加的响应头

HTTPSConfigT

参数类型是否必选描述

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

enable_https

Bool

否

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

true：开启
false：关闭

force_https

Bool

否

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

true：强制
false：不强制

cert_id String 否证书 ID，若enable_https为true，则为必选。

AccessControlConfigT

参数	类型	是否必填	描述
refer_link	Array of ReferLinkConfigT	否	Refer 配置

ReferLinkConfigT

参数	类型	是否必填	描述
enabled	Bool	是	是否开启黑白名单配置，取值如下所示： true：开启 false：关闭
is_white_mode	Bool	否	是否选择白名单，取值如下所示： true：选择 false：不选择
values	Array of String	否	根据是否为白名单，为对应的白/黑名单的值。
allow_empty_refer	Bool	否	是否允许空 Refer，取值如下所示： true：允许空 Refer false：不允许空 Refer

HdrT

参数	类型	是否必填	描述
key	String	是	Header Key
value	String	否	Header Value

返回参数

正确新增返回 Ok，否则错误在 Err 中返回。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=AddDomainV1&Version=2018-08-01&ServiceId=ji***28
{
        "domain": "s.imagex.com"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "AddDomainV1",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": "ok"
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "AddDomainV1",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "DomainNotRecord",
            "Message": "Domain name not registered"
        }
    }
}

错误码

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