查询实例名称是否可用
更新时间 2026-07-31 15:08:15
最近更新时间: 2026-07-31 15:08:15
接口功能介绍
校验实例名称
接口约束
仅限企业版实例使用(废弃,请使用 POST /v2/validateParameter)
URI
POST /v2/validateInstanceName
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | 类型 | application/json | |
| regionId | 是 | String | 资源池编码(资源池ID,您可以查看容器镜像服务资源池获取) | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| instanceType | 是 | String | 实例类型(企业版:enterprise-basic) | enterprise-basic | |
| instanceName | 是 | String | 实例名称(5-30个字符,只能包含小写字母、数字及分隔符("-"),且必须以小写字母开头,数字或小写字母结尾) | my-instance-name |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 (800为请求成功,900为失败 ) | 800 | |
| message | String | 返回信息 | ||
| error | String | 错误码 | ||
| returnObj | Boolean | 校验结果:true为校验通过,false为校验失败(实例名称不合法或者不可用) | true |
枚举参数
无
请求示例
请求url
POST https://crs-global.ctapi.ctyun.cn/v2/validateInstanceName
请求头header
{
"Content-Type": "application/json",
"regionId": "bb9fdb42056f11eda1610242ac110002"
}
请求体body
{
"instanceType": "enterprise-basic",
"instanceName": "my-instance-name"
}
响应示例
{
"message": "请求成功",
"returnObj": true,
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码