创建Shell实例
功能介绍
根据传递场景参数创建Shell实例。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v3/shell/instances
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Sdk-Date |
否 |
String |
参数解释: 请求发起时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
host |
否 |
String |
参数解释: 请求host地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
x-security-token |
否 |
String |
参数解释: IAM5.0鉴权token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Authorization |
否 |
String |
参数解释: AK/SK签名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
agent_id |
否 |
String |
代理商id,教程活动场景下使用 |
arch |
否 |
String |
参数解释: CPU架构类型。 取值范围:
|
cpu_memory |
是 |
String |
参数解释: CPU规格,与技术栈配置的规格对应,可通过技术栈管理ListStacks接口获取。 取值范围:
|
description |
否 |
String |
参数解释: 实例描述。 取值范围: 不涉及 |
display_name |
是 |
String |
参数解释: 实例名。 取值范围: 支持中文、数字、字母、下划线、点、破折号,长度介于3-100之间。 |
is_temporary |
否 |
Boolean |
参数解释: 是否页面显示(以标签配置为准)。 取值范围:
|
label_tag |
否 |
String |
实例标签(不同的第三方需要和CodeArtsIDEOnline服务共同设定标签),不传默认为default |
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规格 5GB|10GB|20GB |
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 |
result object |
返回值 |
status |
String |
参数解释: 请求响应的状态,表明请求是否成功。 取值范围:
|
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误描述信息。详情请参见错误码。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。详情请参见错误码。 取值范围: 不涉及。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误描述信息。详情请参见错误码。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。详情请参见错误码。 取值范围: 不涉及。 |
状态码:406
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误描述信息。详情请参见错误码。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。详情请参见错误码。 取值范围: 不涉及。 |
状态码:500
请求示例
创建Shell实例
POST https://{endpoint}/v3/shell/instances { "display_name" : "testshell", "stack_id" : "cloudshell", "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 |
错误码
请参见错误码。