CheckSiteName - 校验站点名称是否可用 - 边缘安全加速

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

esa:CheckSiteName

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SiteName	string	是	站点名称。	example.com

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
Passed	boolean	校验是否通过。 true：通过。 false：不通过。	true
Messeage	string	校验信息。	Site name is available.
Description	string	校验结果的描述。取值： success：成功。 Site.AlreadyExist: 该用户已添加过此站点。 Site.InvalidName：非法的站点名称。 Site.SubSiteUnavailable：子站点不可用。 Site.InternalError：其他错误。	success
IsSubSite	boolean	是否是一个子站点。取值： true：是子站点。 false：不是子站点。	false

示例

正常返回示例

JSON格式

{
  "RequestId": "CB1A380B-09F0-41BB-280B-72F8FD6DA2FE",
  "Passed": true,
  "Messeage": "Site name is available.",
  "Description": "success",
  "IsSubSite": false
}

错误码

HTTP status code	错误码	错误信息	描述
400	InternalException	Failed to call the service. Try again later or contact technical support.	调用服务失败，请稍后重试或联系客服咨询详情。
400	SubSiteUnavailable	Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.	仅企业版支持以子域名创建站点，请升级您的套餐。

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

变更历史

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