外部第三方集成商创建IDE实例
功能介绍
外部第三方集成商创建IDE实例。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_label |
否 |
String |
参数解释: 实例标签。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: classroom。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Sdk-Date |
是 |
String |
参数解释: 请求发起时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
host |
是 |
String |
参数解释: 请求host地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
x-security-token |
是 |
String |
参数解释: IAM5.0鉴权token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Authorization |
是 |
String |
参数解释: AK/SK签名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
arch |
否 |
String |
参数解释: CPU架构。 取值范围:
|
cpu_memory |
是 |
String |
参数解释: cpu规格。 取值范围:
|
description |
否 |
String |
参数解释: 实例描述,长度不超过100个字符。 取值范围: 不涉及 |
instance_name |
是 |
String |
参数解释: 实例名。 取值范围: 输入中文、数字、字母、下划线、点、破折号,长度介于3~100之间。 |
instance_user_domain_id |
否 |
String |
参数解释: 租户id(对应华为云账号的domainId)。 取值范围: 不涉及 |
instance_user_id |
否 |
String |
参数解释: 用户ID。 取值范围: 不涉及 |
is_temporary |
否 |
Boolean |
参数解释: 是否页面显示(以标签配置为准)。 取值范围: 不涉及 |
plugins |
否 |
Array of Plugin objects |
参数解释: 插件列表。 取值范围: 不涉及 |
pvc_quantity |
是 |
String |
参数解释: PVC规格。 取值范围:
|
refresh_time |
否 |
String |
参数解释: 自动休眠时长。实例无操作超过自动休眠时长后,将会被暂停(已保存的数据不会被删除)。 取值范围:
|
stack_id |
是 |
String |
参数解释: 技术栈ID,通过技术栈管理ListStacks接口获取。 取值范围: 不涉及 |
响应参数
状态码: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
请求示例
外部第三方集成商创建IDE实例
POST https://{endpoint}/v2/instances { "instance_name" : "testjava", "stack_id" : "java", "description" : "", "cpu_memory" : "2U4G", "pvc_quantity" : "5GB", "refresh_time" : "30", "is_temporary" : false, "instance_user_id" : "test", "instance_user_domain_id" : "test" }
响应示例
状态码: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 |
错误码
请参见错误码。