华为云用户手册

响应示例 状态码： 200 OK { "results" : [ { "extensions" : [ { "extension_id" : "d45648941sadsadsa_hdsa", "extension_name" : "plugin_for_CodeArtsIDEOnline", "display_name" : "backgroudcolor_setting", "flags" : 8, "last_updated" : "2022-08-31 00:00:00", "published_date" : "2022-08-29 00:00:00", "release_date" : "2022-09-06 00:00:00", "short_description" : "插件的简要描述", "tags" : [ "color", "extention" ], "tag_all_list" : [ "color", "extension", "enhancer" ], "publisher" : { "publisher_id" : 123456, "publisher_name" : "code-huawei", "display_name" : "color-modify", "publisher_status" : "VERIFIED", "email" : "xxx@huawei.com", "web_url" : "www.xxx.huawei.com", "open" : true }, "arch" : [ "x86", "arm" ], "target" : "CodeArts IDE Online", "categories" : [ "backgroud", "color" ], "category_all_list" : [ "backgroud", "color", "script" ], "publish_manager" : { "publisher_id" : 123456, "publisher_name" : "code-huawei", "display_name" : "color-modify", "publisher_status" : "VERIFIED", "email" : "xxx@huawei.com", "web_url" : "www.xxx.huawei.com", "open" : true }, "status" : "NORMAL", "validate_status" : "NONE", "install_count" : 5000, "average_star" : 4.6, "identifier" : "marketplace_plugin", "support_os" : [ "win", "mac os", "linux" ], "support_ide" : 3, "support_ide_info" : "CodeArts IDE Online", "versions" : [ { "id" : "d45648132313", "version" : "version_one", "version_ranking" : 10000, "status" : "PUBLISHED", "version_status" : "PUBLISHED", "asset_uri" : "www.example.com", "last_updated" : "2022-08-31 00:00:00" } ], "extension_statistics" : { "install" : 10000, "stars" : 5 }, "preview" : false, "ext_info" : { "extension_id" : "d45648941sadsadsa_hdsa", "repo_url" : "www.xxxcodehub.com", "help_page" : "www.help.page.com", "website" : "www.index.com", "issue_link" : "www.problem.com", "show_previews" : false }, "platform" : "/opt/**", "check_result" : { "status" : "success" }, "extension_owner" : "huaweistaff" } ], "result_metadata" : [ { "metadata_type" : ".ts", "metadata_items" : [ { "key" : "value" }, { "uuid" : "uuid" } ] } ] } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "result" : { "identifier" : "redhat.java", "instance_id" : "***", "extension_version" : "1.0.1", "status" : "AGREE" }, "status" : "success" } 状态码： 403 Forbidden { "error_msg" : "Instance does not belong to the user or tenant", "error_code" : "IDE.00010129" }

响应示例 状态码： 200 OK { "result" : { "size" : 100, "total_items_count" : 20, "items_before" : 0, "items" : [ { "id" : 17, "category" : "Programming Languages", "scene_name" : "cloudide", "type" : 0, "support_ide" : 48 }, { "id" : 18, "category" : "Snippets", "scene_name" : "cloudide", "type" : 0, "support_ide" : 16 } ], "empty" : false }, "status" : "success" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 401 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 result AccountStatus object 返回值 status String 状态 表3 AccountStatus 参数 参数类型 描述 cur_org_create_role Boolean 是否有创建实例权限 cur_org_open Boolean 账号所属租户是否开通服务 has_free_trial Boolean 免费试用 show_manage Boolean 是否有管理入口的权限 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 x-publisher-token和X-Auth-Token必传一个 x-publisher-token 否 String 发布商凭证,x-publisher-token和X-Auth-Token必传一个 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 Integer 任务类型

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 stack StacksTags object 技术栈 status String 状态 表4 StacksTags 参数 参数类型 描述 stack_list Array of StackInfo objects 技术栈列表 tags Array of strings 技术栈tag集合 表5 StackInfo 参数 参数类型 描述 arm_config StacksConfig object ARM配置 bundle_url String bundleUrl config StacksConfig object X86配置 created_time String 创建时间 delete Boolean 是否删除 description String 描述 disable Boolean 是否可用 display_name String 显示名称 id Long id label String 标签 logo String 图标 region String region show Boolean 是否显示 stack_name String 技术栈名称 tags Array of strings tags updated_time String 修改时间 users Array of strings 使用者 表6 StacksConfig 参数 参数类型 描述 attributes StacksAttribute object 属性值 recipe Recipe object 镜像 表7 StacksAttribute 参数 参数类型 描述 specs Array of strings 规格列表 suggest String 提示id suggest_title String 提示信息 volumes Array of strings 卷容量列表 表8 Recipe 参数 参数类型 描述 content String 镜像内容 type String 镜像类型 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "stack" : { "tags" : [ "Quantum", "Java", "Maven", "CPP", "JavaScript", "Vue", "ServiceComb", "GO", "Node.js", "Ruby", "Python" ], "stack_list" : [ { "id" : 6, "stack_name" : "python", "display_name" : "Python", "tags" : [ "Python" ], "region" : "cn-north-7", "users" : [ "ide" ], "description" : "支持Python开发，集成pypi", "disable" : false, "show" : true, "arm_config" : { "recipe" : { "content" : "hishell-python:x86_64_inner_latest_fuxi", "type" : "dockerimage" }, "attributes" : { "specs" : [ "4U8G" ], "volumes" : [ "5GB", "10GB", "20GB" ] } }, "config" : { "recipe" : { "content" : "hishell-python:x86_64_inner_latest_fuxi", "type" : "dockerimage" }, "attributes" : { "specs" : [ "1U1G", "2U4G" ], "volumes" : [ "5GB", "10GB", "20GB" ] } }, "created_time" : "2021-10-15 14:28:40", "updated_time" : "2021-12-27 16:01:22", "bundle_url" : "https://test-static-resource.obs.{region}.huawei.com/CloudIDEStatic/1.0.33.20211227153454/bundle.js", "delete" : false } ] }, "status" : "success" } 状态码： 403 Forbidden { "error_msg" : "not subscribe codeArts ide online", "error_code" : "IDE.00000004" }

响应示例 状态码： 200 OK { "result" : [ { "id" : "cc809483-21b8-473b-bd65-ff87efb261fa", "name" : "Spring Boot Extension Pack", "identifier" : "huawei", "description" : "Spring Boot Extension Pack", "email" : "xuhui80@huawei.com", "status" : true, "publisher_review" : false, "system_review" : false, "official" : false, "is_open" : false, "created_time" : "2022-04-01 09:54:26", "updated_time" : "2023-02-15 15:29:12", "role" : "Owner" }, { "id" : "6251b1ee539f4c02ad4b83daeda81633", "name" : "fast-run-app", "identifier" : "devcloud_cloudide_name_g0", "description" : "fast-run-appc", "email" : "test@qq.com", "web_url" : "", "status" : true, "publisher_review" : false, "system_review" : false, "official" : false, "is_open" : false, "created_time" : "2022-04-01 09:54:26", "updated_time" : "2022-09-08 11:01:10", "role" : "Owner" } ], "status" : "success" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Array of PublisherVO objects 返回值 status String 状态 表4 PublisherVO 参数 参数类型 描述 code_repo String 代码地址 created_time String 创建时间 description String 发布商描述 eamap_info String EAMAP注册信息 email String 邮箱 espase_group String espase交流群号 extension_count Long 插件数量 id String 发布商ID identifier String 唯一标志 is_open Boolean 开源发布商,0:非开源; 1:开源; is_org Boolean 发布商或组织,0:发布商; 1:组织; logo_url String 发布商logo member_count Long 成员数量 name String 发布商名称 official Boolean 是否是官方发布商 owners Array of MemberRoleVo objects 成员角色 publisher_review Boolean 是否开启发布商审核,1:开启；0:关闭 role String 角色 status Boolean 状态,0:禁用; 1:正常; suite_count Long 匹配数量 support_url String 支持地址 system_review Boolean 是否忽略系统审核,1:忽略；0:不忽略 updated_time String 更新时间 web_url String 官网地址 表5 MemberRoleVo 参数 参数类型 描述 domain_id String 租户ID extension_count Integer 插件数量 role String 角色名称 role_id Long 角色ID role_value String 发布商或插件ID user_id String 用户ID user_name String 用户名 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "templates" : [ { "template_id" : 5, "name" : "web-java-spring", "source" : { "location" : "git@codehub.alpha.devcloud.inhuawei.com:Demo00226/JavaWeb.git", "type" : "git", "parameters" : { } }, "display_name" : "web-java-spring", "path" : "/web-java-spring", "description" : "A basic example using Spring servlets. The app returns\nvalues entered into a submit form.", "project_type" : "maven", "region" : "cn-north-7", "tags" : [ "maven", "spring", "java", "web" ], "arch" : "x86,arm" } ], "status" : "success" }

响应示例 状态码： 200 OK { "instances" : { "items_before" : 0, "size" : 10, "items" : [ { "updated_time" : "2020-03-17 15:21:36", "private" : false, "owner_id" : "d78cbac186b744899480f25bd022f...", "description" : "ddd", "cpu_memory" : "2U4G", "domain_name" : "IAM_DOMAIN_NAME_A", "is_temporary" : false, "stack_id" : "java", "id" : "instancewrqztsgn12imjq7e", "created_time" : "2020-01-06 15:25:04", "owner_name" : "ide_owner_name", "refresh_interval" : 30, "display_name" : "test001", "organization_id" : "6251b1ee539f4c02ad4b83daeda81633...", "name" : "ide_instance8bmjgqx6vfrb9e9n", "platform_id" : 1, "attributes" : { "cpu_limit" : "2", "pvc_quantity" : "5Gi", "memory_limit_bytes" : "4294967296" }, "pvc_quantity" : "5GB", "arch" : "x86", "region" : "cn-north-7", "status" : "STOPPED", "visitor_id" : "c78cbac186b744899480f25bd022f...", "visitor_name" : "ide_visitor_name", "visitor_domain_name" : "IAM_DOMAIN_NAME_B" } ], "empty" : false }, "status" : "success" }

URI GET /v2/{org_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 租户id（对应华为云账号的domainId） 表2 Query参数 参数 是否必选 参数类型 描述 is_temporary 否 Boolean 是否页面显示（以标签配置为准） limit 否 Long 每页显示的条目数量 10/15/30 offset 否 Long 偏移量，表示从此偏移量开始查询 search 否 String 关键字查询(根据实例名，描述模糊查询)

响应示例 状态码： 200 OK { "instances" : { "items_before" : 0, "size" : 10, "items" : [ { "updated_time" : "2020-03-17 15:21:36", "private" : false, "owner_id" : "d78cbac186b744899480f25bd022f...", "description" : "ddd", "cpu_memory" : "2U4G", "domain_name" : "IAM_DOMAIN_NAME_A", "is_temporary" : false, "stack_id" : "java", "id" : "instancewrqztsgn12imjq7e", "created_time" : "2020-01-06 15:25:04", "owner_name" : "ide_owner_name", "refresh_interval" : 30, "display_name" : "test001", "organization_id" : "6251b1ee539f4c02ad4b83daeda81633...", "name" : "ide_instance8bmjgqx6vfrb9e9n", "platform_id" : 1, "attributes" : { "cpu_limit" : "2", "pvc_quantity" : "5Gi", "memory_limit_bytes" : "4294967296" }, "pvc_quantity" : "5GB", "arch" : "x86", "region" : "cn-north-7", "status" : "STOPPED", "visitor_id" : "c78cbac186b744899480f25bd022f...", "visitor_name" : "ide_visitor_name", "visitor_domain_name" : "IAM_DOMAIN_NAME_B" } ], "empty" : false }, "status" : "success" }

URI GET /v2/instances 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Long 每页显示的条目数量最大值为100,最小值为1 offset 否 Long 偏移量，表示从此偏移量开始查询 is_temporary 否 Boolean 是否页面显示（以标签配置为准） label 否 String 标签 search 否 String 关键字查询(根据实例名，描述模糊查询) sort_dir 否 String 排序方式 asc/desc sort_key 否 String 排序字段。 display_name 实例名、status状态、pvc_quantity 存储容量、created_time 创建时间、stack_id 技术栈

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 filters 是 Array of FilterSnake objects 过滤字段 flags 是 Integer 插件flag;通过传递flag参数来进行过滤或其他操作。flag的基础数字是2\4\8\16;传递的参数只能是这四个数字加法组合而成数字 利用它们之间二进制的运算获取的值进行其他操作.比如6=0110=0010+0100也就是2和4的集合flags 表3 FilterSnake 参数 是否必选 参数类型 描述 criteria 否 Array of CriteriaSnake objects 过滤集合 page_number 是 Long 页码 page_size 是 Long 分页大小 sort_by 否 Long 排序字段. 1 修改日期 2 插件名称 3 插件作者名称 枚举值： 1 2 3 sort_order 否 Long 排序顺序. 1 升序 2 降序 枚举值： 1 2 表4 CriteriaSnake 参数 是否必选 参数类型 描述 filter_type 否 Integer 过滤类型 1 按插件Tag过滤 2 按diplayName过滤 3 按publisherId过滤 4 按插件Id过滤 5 按插件分类过滤 7 按照作者名.插件名过滤 8 按Target（客户端）过滤 10 按关键字（客户端输入的）过滤 12 根据flags传入的值来进行过滤,eg:flags=2name就排除flags=2的插件. 13 根据flags传入的值来进行过滤,eg:flags=2name就查询出flags=2的插件 18 按publisherName过滤 19 按publisherDisplayName过滤 102 按照插件状态排除插件 103 按照插件状态过滤出插件 107 supportIdeInfo 108 根据插件ids查询 枚举值： 1 2 3 4 5 7 8 10 12 13 18 19 102 103 107 108 value 否 String 过滤类型对应字段名称

响应示例 状态码： 200 successful operation { "results" : [ { "extensions" : [ { "extension_id" : "d45648941sadsadsa_hdsa", "extension_name" : "plugin_for_CodeArtsIDEOnline", "display_name" : "backgroudcolor_setting", "flags" : 8, "last_updated" : "2022-08-31 00:00:00", "published_date" : "2022-08-29 00:00:00", "release_date" : "2022-09-06 00:00:00", "short_description" : "插件的简要描述", "tags" : [ "color", "extention" ], "tag_all_list" : [ "color", "extension", "enhancer" ], "publisher" : { "publisher_id" : 123456, "publisher_name" : "code-huawei", "display_name" : "color-modify", "publisher_status" : "VERIFIED", "email" : "xxx@huawei.com", "web_url" : "www.xxx.huawei.com", "open" : true }, "arch" : [ "x86", "arm" ], "target" : "CodeArts IDE Online", "categories" : [ "backgroud", "color" ], "category_all_list" : [ "backgroud", "color", "script" ], "publish_manager" : { "publisher_id" : 123456, "publisher_name" : "code-huawei", "display_name" : "color-modify", "publisher_status" : "VERIFIED", "email" : "xxx@huawei.com", "web_url" : "www.xxx.huawei.com", "open" : true }, "status" : "NORMAL", "validate_status" : "NONE", "install_count" : 5000, "average_star" : 4.6, "identifier" : "marketplace_plugin", "support_os" : [ "win", "mac os", "linux" ], "support_ide" : 3, "support_ide_info" : "CodeArts IDE Online", "versions" : [ { "id" : "d45648132313", "version" : "version_one", "version_ranking" : 10000, "status" : "PUBLISHED", "version_status" : "PUBLISHED", "asset_uri" : "www.example.com", "last_updated" : "2022-08-31 00:00:00" } ], "extension_statistics" : { "install" : 10000, "stars" : 5 }, "preview" : false, "ext_info" : { "extension_id" : "d45648941sadsadsa_hdsa", "repo_url" : "www.xxxcodehub.com", "help_page" : "www.help.page.com", "website" : "www.index.com", "issue_link" : "www.problem.com", "show_previews" : false }, "platform" : "/opt/**", "check_result" : { "status" : "success" }, "extension_owner" : "huaweistaff" } ], "result_metadata" : [ { "metadata_type" : ".ts", "metadata_items" : [ { "key" : "value" }, { "uuid" : "uuid" } ] } ] } ] }

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 IDE.00010070 Free user limit not Found! 免费资源的配置无法找到，请稍后再试 请稍后再试 403 IDE.00000004 not subscribe cloudide 未开通CloudIDE服务 开通CloudIDE服务 403 IDE.00000005 suspended 您的账户已欠费冻结 账户充值 403 IDE.00000007 not verified 账号未实名认证，请认证后再试 账号实名认证 403 IDE.00000010 account is not normal 账号状态异常，请稍后再试 检查账号是否异常 403 IDE.00010000 OPERATE LIMIT 操作受限，请确认后再操作 请确认是否有权限 403 IDE.00010085 User already exists 用户已经存在，请确认后再试 确认用户是否已存在 403 IDE.00010086 blackList user 黑名单用户不能添加 使用白名单用户 403 IDE.00010092 no such action 没有这样的动作 请确认是否有权限 406 IDE.00000011 unusual limit 15 minute 15分钟内累计输入用户名错误5次，请15分钟后再试 请15分钟后再试 406 IDE.00000097 parameter is null or error 参数错误 参数规格：参考相应的API文档 406 IDE.00010027 Instance name is exist 实例已经存在 修改实例名 406 IDE.00010028 Instance is Starting, Can't remove it now 实例正在启动，不能被删除，请稍后再试 实例停止后再删除 406 IDE.00010029 Instance has been deleted or is in deleting 实例已经被删除或正在删除，请勿重复删除 等待操作完成 406 IDE.00010030 instance not exist 实例不存在，请确认后操作 确认实例是否存在 406 IDE.00010048 active error:instance status error 实例状态异常 请稍后再试 406 IDE.00010054 Could not stop the ide, instance status is not running or starting 实例不在运行状态，无法停止，请稍后再试 实例运行后在停止 406 IDE.00010058 current user is not subUser in Domain 当前用户不是该组织下的子账号，请确认后操作 确认用户是否为组织下子账号 406 IDE.00010071 Free resource not enough! 免费资源不足，请稍后再试 使用其他免费技术栈资源或购买cloudide服务 406 IDE.00010087 not whiteList user 您不是白名单用户，请确认后操作 确认是否为白名单用户 406 IDE.00010091 Organization already existed 组织已经存在，请确认后操作 确认组织是否存在 406 IDE.00010101 INSTANCE_START_ERROR 实例启动失败，请稍后再试 请稍后再试 406 IDE.00010103 instance number limit 实例数量已经超过上限，请删除旧有实例后再试 删除旧实例 406 IDE.00010104 instance resource limit 实例资源受限，请稍后再试 请稍后再试 406 IDE.00010105 instance arm number limit arm实例数量已经超过上限，请删除旧有实例后再试 删除旧实例 406 IDE.00040001 config error 配置错误 检查配置 406 IDE.00040002 label is not correct 标签不正确 参数规格：参考相应的API文档 406 IDE.00040004 The character string length is incorrect. 字符串长度不匹配 检查字符串 406 IDE.00040005 Unsupported for spec platform or stack 不支持的平台或技术栈规格 参数规格：参考相应的API文档 500 IDE.00000040 outer http request error 外部HTTP请求错误 请稍后再试 500 IDE.00000100 Internal Server Error 服务异常，请稍后再试 服务异常，请稍后再试 500 IDE.00020001 get Repository By ProjectId error 获取仓库失败 请稍后再试 500 IDE.00020002 get Branches By RepoName error 获取分支失败 请稍后再试 500 IDE.00020003 get Related Project error 获取工程失败，请稍后再试 请稍后再试 500 IDE.00020004 get Project user error 获取工程用户信息失败，请稍后再试 请稍后再试

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Boolean 返回值 status String 状态 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code 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 错误码

请求示例 创建名为“testjava”、Java技术栈、CPU规格为“2U4G”、PVC规则为“5GB”、自动休眠时长为30分钟、不在页面显示，用户ID和租户ID为“test”的实例。 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" }

请求参数 表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 与技术栈配置的规格对应，可通过技术栈管理ListStacks接口获取。如果标签不为空，以标签配置的技术栈规格为准。 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_id 否 String 用户id 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，通过技术栈管理ListStacks接口获取。 表4 Plugin 参数 是否必选 参数类型 描述 attribute 否 String 插件属性 name 否 String 插件名

请求示例 创建IDE实例 POST https://{endpoint}/v2/6251b1ee539f4c02ad4b83daeda81633/instances { "display_name" : "testjava", "stack_id" : "java", "description" : "", "cpu_memory" : "2U4G", "pvc_quantity" : "5GB", "refresh_interval" : "30" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result result object 返回值 status String 状态 表5 result 参数 参数类型 描述 link String 链接 arch String cpu架构 x86|arm 枚举值： x86 arm id String 实例id private Boolean 是否私有平台 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Boolean 返回值 status String 状态 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 extension_version 是 String 插件版本 identifier 是 String 插件标识(发布者.插件名) instance_id 否 String CodeArtsIDEOnline实例ID status 是 String 插件状态。 AGREE 同意 REJECT 不同意 UNKNOWN 未知（下次重新询问） 枚举值： AGREE REJECT UNKNOWN