查询IDE实例名是否重复 - CheckName
功能介绍
在使用CodeArts IDE Online时，确保IDE实例名的唯一性，需要查询IDE实例名是否重复。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
CodeArtsIDEOnline:instance:get |
Permission_management |
- |
- |
- |
- |
URI
GET /v2/instances/duplicate
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
display_name |
是 |
String |
参数解释： IDE实例名称。 约束限制： 不涉及。 取值范围： 支持中文、数字、字母、下划线、点、破折号，且长度为3~100。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 约束限制： 不涉及。 取值范围： 长度为1~100000。 默认取值： 不涉及。 |
|
X-Sdk-Date |
否 |
String |
参数解释： 请求发起时间。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
host |
否 |
String |
参数解释： 请求host地址。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
x-security-token |
否 |
String |
参数解释： IAM 5.0鉴权token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
Authorization |
否 |
String |
参数解释： AK/SK签名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
Boolean |
参数解释： 返回IDE实例名，查看实例名状态。 取值范围：
|
|
status |
String |
参数解释： 请求响应的状态，表明请求是否成功。 取值范围：
|
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释： 错误描述信息。详情请参见错误码。 取值范围： 长度为0~255。 |
|
error_code |
String |
参数解释： 错误码。详情请参见错误码。 取值范围： 长度为0~100。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释： 错误描述信息。详情请参见错误码。 取值范围： 长度为0~255。 |
|
error_code |
String |
参数解释： 错误码。详情请参见错误码。 取值范围： 长度为0~100。 |
状态码：406
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释： 错误描述信息。详情请参见错误码。 取值范围： 长度为0~255。 |
|
error_code |
String |
参数解释： 错误码。详情请参见错误码。 取值范围： 长度为0~100。 |
状态码：500
请求示例
查询IDE实例名是否重复。
GET https://{endpoint}/v2/instances/duplicate?display_name=test
响应示例
状态码：200
OK
{
"result" : true,
"status" : "success"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
403 |
Forbidden |
|
404 |
Not Found |
|
406 |
Not Acceptable |
|
500 |
Internal Server Error |
错误码
请参见错误码。
