接口功能介绍
查询实例名称是否可用
接口约束
仅限企业版实例使用
URI
POST /v1/validateInstanceName
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Content-Type | 是 | String | 类型 | application/json | |
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceType | 是 | String | 实例类型(个人版:personal,一个租户只能有一个个人版实例;企业版:enterprise-basic) | enterprise-basic | |
instanceName | 是 | String | 实例名称(5-30个字符,只能包含小写字母、数字及分隔符("-"),且必须以小写字母开头,数字或小写字母结尾) | my-instance-name |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应码 | 0 | |
message | String | 返回信息 | ||
error | String | 错误信息 | ||
returnObj | Boolean | 校验结果 | true |
枚举参数
无
请求示例
请求url
POST https://[endpoint].ctapi.ctyun.cn/v1/validateInstanceName
请求头header
{
"Content-Type":"application/json"
}
请求体body
{
"instanceType":"enterprise-basic",
"instanceName":"my-instance-name"
}
响应示例
{
"message":"请求成功",
"returnObj":true,
"statusCode":0
}
状态码
请参考 状态码
错误码
请参考 错误码