- 最新动态
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
-
IDE实例管理
- 查询IDE实例名是否重复 - CheckName
- 查询某个IDE实例 - ShowInstance
- 修改IDE实例 - UpdateInstance
- 删除IDE实例 - DeleteInstance
- 启动IDE实例 - StartInstance
- 停止IDE实例 - StopInstance
- 创建IDE实例 - CreateInstance
- 查询某个租户下的IDE实例列表 - ListOrgInstances
- 创建IDE实例 - CreateIDEInstance
- 创建Shell实例 - CreateShellInstance
- 查询IDE实例列表 - ListInstances
- 外部第三方集成商创建IDE实例 - CreateInstanceBy3rd
- 查询用户是否有权限访问某个IDE实例 - CheckInstanceAccess
- 查询用户是否有权限创建IDE实例 - CheckCreateInstancePermission
- 刷新IDE实例活跃状态 - UpdateInstanceActivity
- 查询某个IDE实例的状态 - ShowInstanceStatusInfo
- 分发实例给访问者 - AssociateInstance
- 技术栈管理
- 模板管理
- 帐号权限管理
- 插件管理
-
插件市场
- 获取指定文件下载地址 - DownloadExtensionFile
- 上传插件 - UploadExtensionFile
- 查询插件列表 - ListExtensions
- 查询插件详细信息 - ShowExtensionDetail
- 查询插件评价 - ShowExtensionEvaluation
- 查询插件评星 - ShowExtensionEvaluationStar
- 添加插件评论 - AddExtensionEvaluation
- 添加评论回复、回复评论回复 - AddExtensionEvaluationReply
- 举报评论,举报回复 - CheckMaliciousExtensionEvaluation
- 删除回复 - DeleteEvaluationReply
- 删除评论 - DeleteEvaluation
- 添加新评星 - AddExtensionStar
- 查询插件分类 - ShowCategoryList
- 获取当前用户下的发布商列表 - ListPublisher
- 文件上传归一化 - UploadFilePublisher
- 获取插件检测结果 - ShowExtensionTestingResult
- 插件发布 - PublishExtension
-
IDE实例管理
- 应用示例
- 权限策略和授权项
- 附录
- 历史API
- 文档修订记录
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
外部第三方集成商创建IDE实例 - CreateInstanceBy3rd
功能介绍
创建IDE实例
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_label |
否 |
String |
实例标签(不同的第三方需要和CodeArtsIDEOnline服务共同设定标签)。不传默认为classroom |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
X-Sdk-Date |
否 |
String |
请求发起时间。 |
host |
否 |
String |
请求host地址。 |
x-security-token |
否 |
String |
The security token that users must pass to the service API to use the temporary credentials. |
Authorization |
否 |
String |
AK/SK签名。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
arch |
否 |
String |
cpu架构 x86|arm |
cpu_memory |
是 |
String |
cpu规格.arm架构支持4U8G,x86架构支持1U1G,2U4G,2U8G 与技术栈配置的规格对应,可通过技术栈管理ListStacks接口获取。如果标签不为空,以标签配置的技术栈规格为准。 quantum技术栈,x86架构cpu规格为2U8G;其他技术栈,x86架构cpu规格为1U1G,2U4G |
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规格 5GB|10GB|20GB |
refresh_time |
否 |
String |
自动休眠时长。arm架构,自动休眠时长只能设置成30,60。x86架构可取值为30,60,240,1440和-1。除-1外,其它值的单位为“分钟”。实例无操作超过自动休眠时长后,将会被暂停(已保存的数据不会被删除)。-1表示实例不会自动停止。 |
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
参数 |
参数类型 |
描述 |
---|---|---|
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_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 |
错误码
请参见错误码。