调用CreateCustomHostname创建SaaS域名-边缘安全加速-阿里云-边缘安全加速(ESA)-阿里云帮助中心

在站点下创建一个 SaaS 域名。

接口说明

如果加速区域选择的是仅中国内地或者全球，则站点域名必须已完成备案。
每个用户每小时最多调用 100 次。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:CreateCustomHostname

create

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

无

请求参数

名称	类型	必填	描述	示例值
Hostname	string	是	SaaS 域名	custom.site.com
SiteId	integer	是	站点 ID，可通过调用 ListSites 接口获取。	1234567890123
RecordId	integer	是	待绑定记录的 ID，可以通过 ListRecords 获取。	1234567890123
SslFlag	string	是	SSL 开关。 on: 开启 SSL。 off: 关闭 SSL。	on
CertType	string	否	证书类型，SslFlag 为 on 时需要输入该参数。 free: 免费证书。 upload: 上传证书。 cas: 云盾证书。	free
Certificate	string	否	证书内容，CertType 为 upload 时需要输入该参数。	-----BEGIN CERTIFICATE-----
PrivateKey	string	否	证书私钥，CertType 为 upload 时需要输入该参数。	-----BEGIN PRIVATE KEY-----
CasId	integer	否	云盾证书 ID，CertType 为 cas 时需要输入该参数。	30000478
CasRegion	string	否	云盾证书地域，CertType 为 cas 时需要输入该参数。中国站账号传参数值：cn-hangzhou。国际站账号传参数值：ap-southeast-1。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID，阿里云为该请求生成的唯一标识符。	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
HostnameId	integer	SaaS 域名的 ID。	1234567890123
Hostname	string	SaaS 域名。	custom.site.com

示例

正常返回示例

JSON格式

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "HostnameId": 1234567890123,
  "Hostname": "custom.site.com"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is invalid.	输入参数规范校验失败。
400	InternalException	Failed to call the service. Try again later or contact technical support.	调用服务失败，请稍后重试或联系客服咨询详情。
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	您的套餐实例因欠费当前处于非上线状态，请先完成续费操作以继续使用。
400	Site.ServiceBusy	This website is being configured. Try again later.	该站点正在配置中，请稍后再试。
400	CustomHostname.ConflictWithExistingResource	The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.	自定义主机名和已有资源冲突，例如站点、记录、负载均衡器、源地址池、自定义主机名和四层代理等
400	CustomHostname.ApplyCertFailed	Fail to apply a free cert for custom hostname. Please try again later.	申请自定义主机名的免费证书失败，请稍后重试。
400	CustomHostname.SetCertFailed	Fail to deploy a cert for custom hostname. Please try again later.	自定义主机名的证书部署失败，请稍后重试。
400	CustomHostname.CheckQuotaFailed	Fail to check quota for custom hostname. Please try again later.	检查站点的自定义主机名配额失败，请稍后重试。
400	CustomHostname.OfflineForMultiReason	Unable to activate the custom hostname because it is offline due to multiple reasons.	该自定义主机名因多种原因下线，因此无法激活。
400	CustomHostname.WildcardDomainRequireEnterprisePlan	Wildcard custom hostnames require an Enterprise plan.	只有企业版套餐才能添加泛域名SaaS域名，请升级套餐后重试。
400	CustomHostname.QueryCasCertFailed	Fail to query CAS certificate details. Please try again later.	查询云盾证书详情失败，请稍后重试。
400	QuotaExceed.CustomHostname	The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.	自定义主机名的数量超限，请联系销售增加额度。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。