创建自定义域名。

请求说明

API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://apig.cn-beijing.volcengineapi.com?Action=CreateCustomDomain&Version=2021-03-03

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：CreateCustomDomain

要执行的操作，取值：CreateCustomDomain。

Version string 必选示例值：2021-03-03

API的版本，取值：2021-03-03。

ServiceId string 必选示例值：sd84****

服务 ID。您可以通过 ListGatewayServices 查询服务 ID。

Domain string 必选示例值：example.com

自定义域名。长度限制为 0~253 个字符。

Protocol string[] 必选示例值：["HTTP","HTTPS"]

协议类型，取值：

HTTP。

HTTPS。

CertificateId string 可选示例值：cert-c88****

证书 ID。您可以通过 QuickApplyCertificate 创建证书。

ResourceType string 可选示例值：Console

资源类型，取值：

Console（默认值）：从控制台创建。

Ingress：同步自Ingress。

Comments string 可选示例值：example

自定义域名备注信息。

SSLRedirect boolean 可选示例值：true

是否重定向到 HTTPS。取值：

true：是。

false：（默认值）否。

Tags object[] 可选示例值：-

标签。长度限制为 0~10 个。

Key string 必选示例值：example-key

标签键。长度限制为 1~256 个字符。

Value string 可选示例值：example-value

标签值。长度限制为 0~256 个字符。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Id string 示例值：d****

自定义域名 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	DomainCertificateInvalid	The certificate is invalid.	自定义域名证书不合法。请确认参数后重试。
400	DomainPending	A custom domain is creating or deleting.	自定义域名正在创建或删除。请稍后重试。
400	InvalidParameter	The specified parameter %s is invalid.	请求参数值不合法。请确认参数后重试。
400	MissingParameter	The required parameter %s is missing.	缺少必要的请求参数。请确认参数后重试。
400	QuotaExceeded	%s has exceeded the quota.	指定资源的配额达到上限。请提升相关资源配额或删除无用资源，预留出配额后重试。
403	OperationDenied	Operation is denied because %s.	操作不合法。请修改后重试。
404	ResourceNotFound	The specified resource %s %s cannot be found.	指定资源找不到。请确认参数后重试。
409	DomainConflict	Domain %s conflicts with existing domain.	自定义域名与服务内其他自定义域名冲突。请确认参数后重试。
409	DomainDuplicated	Domain %s already exists.	自定义域名已重复。请确认参数后重试。
409	DuplicatedResource	Resource %s %s already exists.	资源已重复。请确认参数后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。