文档首页 > > API参考> API> IDE实例管理>

外部第三方集成商创建IDE实例

外部第三方集成商创建IDE实例

分享
更新时间:2021/03/01 GMT+08:00

功能介绍

创建IDE实例

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/instances

表1 Query参数

参数

是否必选

参数类型

描述

instance_label

String

实例标签(不同的第三方需要和CloudIDE服务共同设定标签)。不传默认为classroom

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

arch

String

cpu架构 x86|arm

枚举值:

  • x86

  • arm

cpu_memory

String

cpu规格.arm架构支持4U8G,x86架构支持1U1G,2U4G,2U8G 与技术栈配置的规格对应,可通过技术栈管理ListStacksByTag接口获取。如果标签不为空,以标签配置的技术栈规格为准。 quantum技术栈,x86架构cpu规格为2U8G;其他技术栈,x86架构cpu规格为1U1G,2U4G

枚举值:

  • 1U1G

  • 2U4G

  • 2U8G

  • 4U8G

description

String

描述。长度不操过100个字符

instance_name

String

实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间

instance_user_domain_id

String

组织id(对应华为云帐号的domainId)

instance_user_domain_name

String

用户组织名

instance_user_id

String

用户id

instance_user_name

String

用户名

is_temporary

Boolean

是否页面显示(以标签配置为准)

plugins

Array of Plugin objects

插件列表

pvc_quantity

String

PVC规格 5GB|10GB|20GB

枚举值:

  • 5GB

  • 10GB

  • 20GB

refresh_time

String

实例的生命周期。 arm架构,生命周期只能设置成30,60。x86架构可取值为30,60,240,1440和-1。除-1外,其它值的单位为“分钟”。实例在到达生命周期后,将会被暂停(已保存的数据不会被删除)。-1表示实例不会自动停止。

stack_id

String

技术栈ID,通过技术栈管理ListStacksByTag接口获取。

表4 Plugin

参数

是否必选

参数类型

描述

attribute

String

插件属性

name

String

插件名

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

result

result object

返回值

status

String

状态

表6 result

参数

参数类型

描述

link

String

链接

arch

String

cpu架构 x86|arm

枚举值:

  • x86

  • arm

id

String

实例id

private

Boolean

是否私有平台

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 406

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

外部第三方集成商创建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_name" : "test",
  "instance_user_domain_name" : "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

错误码

请参见错误码

分享:

    相关文档

    相关产品