CreateSite - 创建站点

让用户创建一个新的站点。

接口说明

  • 创建站点之前,您必须拥有可用的套餐实例。
  • 如果加速区域包含中国内地,站点必须完成备案。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
esa:CreateSitecreate
*全部资源
*

请求参数

名称类型必填描述示例值
SiteNamestring

站点名称。

example.com
Coveragestring

加速区域。取值:

  • domestic:仅中国内地。
  • global:全球。
  • overseas:全球(不包含中国内地)。
domestic
AccessTypestring

站点的接入类型。取值:

  • NS:表示使用托管 NS 的方式接入。
  • CNAME :表示使用配置 CNAME 的方式接入。
NS
InstanceIdstring

实例 ID,可通过调用 ListUserRatePlanInstances 接口获取。实例 ID 和站点 ID 至少填写一个,若两者都填,则以实例 ID 为准进行查询。

dbaudit-cn-nwy349jdb03
ResourceGroupIdstring

资源组 ID。不传该参数时,系统自动补全默认资源组 ID。

rg-acfmw4znnok****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE
SiteIdlong

站点 ID。

1234567890123
NameServerListstring

为站点分配的 NS 列表,用半角逗号(,)分隔。当站点的接入方式为 NS 接入时,该字段有值,需要将站点的 DNS 服务器修改成这些 NS。随后即可验证站点的归属权,激活站点。

ns1.example.com,ns2.example.com
VerifyCodestring

站点的校验码。当站点的接入方式为 CNAME 接入时,需要在站点的 DNS 服务器下配置一条记录名称为_esaauth.[站点名称] 、记录值为校验码的 TXT 记录。随后即可验证站点的归属权,激活站点。

verify_aah9dioasmov****

示例

正常返回示例

JSON格式

{
  "RequestId": "CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE",
  "SiteId": 1234567890123,
  "NameServerList": "ns1.example.com,ns2.example.com",
  "VerifyCode": "verify_aah9dioasmov****"
}

错误码

HTTP status code错误码错误信息描述
400ServiceInvokeFailedThe call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.调用服务失败,请稍后重试或联系客服咨询详情。
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。
400InvalidParameterThe specified parameter is invalid.输入参数规范校验失败。
400Instance.NotOnlineYour plan is unavailable due to an overdue payment. Complete the payment first.您的套餐实例因欠费当前处于非上线状态,请先完成续费操作以继续使用。
400InvalidParameter.SiteNameInvalid website name. Specify a valid name that contains letters and digits and does not contain special characters.站点名称无效,请重新输入站点名称,可以包含字母和数字,不能包含特殊字符。
400QuotaExceed.SiteCountThe maximum number of websites associated with your plan has been reached.站点数量超出配额限制。
400Site.ConflictDuplicate website names exist across multiple accounts. Rename or delete one and try again.站点冲突,多个账户下存在相同名称的站点,请删除或更名后重试。
400Site.AlreadyExistThe website name you specified already exists. Try with another name.您输入的站点已存在,请您重新设置。
400SubSiteUnavailableSubdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.仅企业版支持以子域名创建站点,请升级您的套餐。
400Site.InvalidCoverageThe selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.您选择的加速区域不在当前套餐支持范围内,请更换为套餐支持的加速区域后重试。
400InvalidSiteICPThe specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.您配置的站点未备案或ICP备案信息不合法,请确保站点已完成备案后重试。
400InvalidSiteNameInvalid website name. Check and try again.您配置的站点名称不正确,请确保传入正确的站点名称后重试。
400Site.InBlacklistThe site name is in the blacklist.站点名称在黑名单中。

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

变更历史

变更时间变更内容概要操作
2024-10-10OpenAPI 错误码发生变更查看变更详情
2024-10-08OpenAPI 错误码发生变更查看变更详情