创建IDE实例 - CreateInstance
功能介绍
根据租户ID以及IDE参数创建IDE实例。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
CodeArtsIDEOnline:instance:create |
Permission_management |
- |
- |
- |
- |
URI
POST /v2/{org_id}/instances
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
org_id |
是 |
String |
参数解释: 租户id(对应华为云账号的domainId)。 约束限制: 正则表达式:^[a-zA-Z0-9][-_.a-zA-Z0-9]{1,126}[a-zA-Z0-9]$。 取值范围: 长度为3~128。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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签名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
agent_id |
否 |
String |
参数解释: 代理商id,教程活动场景下使用。 约束限制: 正则表达式:[a-zA-Z0-9_-]*$。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
arch |
否 |
String |
参数解释: CPU架构类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
cpu_memory |
是 |
String |
参数解释: CPU规格,与技术栈配置的规格对应,可通过技术栈管理ListStacks接口获取。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
description |
否 |
String |
参数解释: 实例描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
display_name |
是 |
String |
参数解释: 实例名。 约束限制: 不涉及。 取值范围: 支持中文、数字、字母、下划线、点、破折号,长度介于3-100之间。 默认取值: 不涉及。 |
|
is_temporary |
否 |
Boolean |
参数解释: 是否页面显示(以标签配置为准)。 约束限制: 不涉及。 取值范围:
默认取值: 是 |
|
label_tag |
否 |
String |
参数解释: 实例标签(不同的第三方需要和CodeArtsIDEOnline服务共同设定标签)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
plugin_enable_list |
否 |
Array of strings |
参数解释: 预装插件列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
plugin_vars |
否 |
Map<String,String> |
参数解释: 预装插件参数,请注意敏感信息保护,若涉及敏感信息,请自行加密。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
port_id |
否 |
String |
参数解释: 云服务器对应的portId,小网连接ecs的场景下使用。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
private_ip |
否 |
String |
参数解释: 云服务器IP,小网连接ecs的场景下使用。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
pvc_quantity |
是 |
String |
参数解释: PVC规格。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
refresh_interval |
是 |
String |
参数解释: 自动休眠时长。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
repository_id |
否 |
Long |
参数解释: 解放号的仓库id,解放号场景下使用。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
stack_id |
是 |
String |
参数解释: 技术栈ID,通过技术栈管理ListStacks接口获取。 取值范围: 不涉及 |
|
task_type |
否 |
String |
参数解释: 任务类型,教程活动场景下使用。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
token |
否 |
String |
参数解释: 解放号的token,解放号场景下使用。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
vpc_id |
否 |
String |
参数解释: 云服务器对应的vpc ID,小网连接ecs的场景下使用。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
instance_domain_id |
否 |
String |
参数解释: 实例授权用户租户ID 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
instance_user_id |
否 |
String |
参数解释: 实例授权用户ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
Object |
参数解释: 参数返回值。 取值范围: 不涉及 |
|
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实例
POST https://{endpoint}/v2/6251b1ee539f4c02ad4b83daeda81633/instances
{
"display_name" : "testjava",
"stack_id" : "java",
"description" : "",
"cpu_memory" : "2U4G",
"pvc_quantity" : "5GB",
"refresh_interval" : "30"
}
响应示例
状态码:200
OK
{
"result" : {
"link" : "https://****/cloudide/loading?instanceId=mpdrao",
"arch" : "x86",
"id" : "mpdrao",
"private" : false
},
"status" : "success"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
403 |
Forbidden |
|
404 |
Not Found |
|
406 |
Not Acceptable |
|
500 |
Internal Server Error |
错误码
请参见错误码。