华为云用户手册

响应参数 状态码： 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 任务类型

错误码说明 当您调用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参数 参数 参数类型 描述 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.cn-north-7.ulanqab.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"}

查询IDE实例列表 指定limit查询IDE实例列表。 GET: https://{endpoint}/v2/instances?limit=10 { "instances" : { "items_before" : 0, "size" : 10, "total_items_count" : 1, "items" : [ { "is_private" : false, "updated_time" : "2020-03-17 15:21:36", "private" : false, "role" : { "role" : "owner", "id" : "1" }, "owner_id" : "0dc311a468024ad5bf18591c8361272a", "description" : "ddd", "cpu_memory" : "2U4G", "domain_name" : "devcloud_cloudide_name_g01", "role_id" : "1", "is_temporary" : false, "stack_id" : "java", "id" : "instancewrqztsgn12imjq7e", "created_time" : "2020-01-06 15:25:04", "owner_name" : "devcloud_cloudide_pwx501764_g01", "refresh_interval" : 30, "display_name" : "test001", "organization_id" : "6251b1ee539f4c02ad4b83daeda81633", "name" : "cloudide-instance4xceoej8vvpn32lx", "platform_id" : 1, "attributes" : { "cpu_limit" : "2", "pvc_quantity" : "5Gi", "memory_limit_bytes" : "4294967296" }, "pvc_quantity" : "5GB", "arch" : "x86", "region" : "cn-north-7", "actions" : [ { "role_id" : "1", "action_cname" : "创建实例", "id" : "166", "actions" : "CREATE_INSTANCE" }, { "role_id" : "1", "action_cname" : "删除实例", "id" : "167", "actions" : "DELETE_INSTANCE" }, { "role_id" : "1", "action_cname" : "更新实例", "id" : "168", "actions" : "UPDATE_INSTANCE" }, { "role_id" : "1", "action_cname" : "查询实例列表", "id" : "169", "actions" : "QUERY_INSTANCE" }, { "role_id" : "1", "action_cname" : "运行实例", "id" : "170", "actions" : "RUN_INSTANCE" } ], "status" : "STOPPED" } ], "empty" : false }, "status" : "success"} 通过limit和关键字过滤查询实例。 如：查询实例名称或描述中含test的实例列表。 GET: https://{endpoint}/v2/instances?limit=10&search=test

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。 CodeArts IDE Online支持的自定义策略授权项如下所示： 公共查询权限 实例相关权限

响应参数 状态码： 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 错误码 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

请求参数 表1 请求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必传一个 表2 FormData参数 参数 是否必选 参数类型 描述 file 是 File 文件 publisher_id 否 String 传用户token时，此字段为必传项 chunk_index 是 Long 分片索引，第几个分片 取值范围：1-100 merge 是 Boolean 是否合并已上传的分片（包含本次分片内容）,true total_chunk_num 是 Long 总分片数 0-100 parent_file_size 是 Long 父文件大小 parent_file_name 是 String 父文件名称 override 是 Boolean 是否覆盖原有文件 chunk_md5 是 String 文件分片的md5,用于校验文件分片是否完整 parent_file_sha256 否 String 父文件hash，用于校验合并后的文件 task_id 否 String 上传任务的唯一标识，第一次上传分片时可不传

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 stack StacksTag object 技术栈 status String 状态 表4 StacksTag 参数 参数类型 描述 stack_list Array of Stacks objects 技术栈列表 tags Array of strings 技术栈tag集合 表5 Stacks 参数 参数类型 描述 arm_config StacksConfig object arm配置 config StacksConfig object x86配置 creator String 创建人 description String 描述 disable Boolean 是否可用 id Long id label String 标签 logo String 图标 name String 技术栈名称 scope String 范围 stack_id String 技术栈ID，通过技术栈管理ListStacks接口获取。 tags Array of strings tags 表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 错误码 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表11 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "stack" : { "tags" : [ "Java", "Maven", "CPP", "Vue", "ServiceComb", "Blockchain", "GO", "Node.js", "Quantum", "JavaScript", "Ruby", "Python" ], "stack_list" : [ { "id" : 1, "stack_id" : "all", "creator" : "ide", "name" : "All in One", "description" : "支持Java、Python、JS/TS等多种语言", "scope" : "general", "config" : { "recipe" : { "content" : "hishell-all-in-one:alpha", "type" : "dockerimage" }, "attributes" : { "specs" : [ "2U4G" ], "volumes" : [ "5GB", "10GB", "20GB" ] } }, "tags" : [ "Java", "Maven", "CPP", "JavaScript", "Vue", "GO", "Node.js", "Ruby", "Python", "ServiceComb" ], "disable" : false, "arm_config" : { "recipe" : { "content" : "hishell-all-in-one:alpha", "type" : "dockerimage" }, "attributes" : { "specs" : [ "4U8G" ], "volumes" : [ "5GB", "10GB", "20GB" ] } } } ] }, "status" : "success"}

创建IDE实例 创建指定技术栈及规格的IDE实例。 请求示例 POST https://{endpoint}/v2/instances?instance_label=classroom { "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"} 响应示例 { "result" : { "link" : "https://*****/cloudide/loading?instanceId=mpdrao", "arch" : "x86", "id" : "mpdrao" }, "status" : "success"}

响应示例 状态码： 200 OK { "instance" : { "created_time" : "2020-01-07 11:25:56", "updated_time" : "2020-03-20 17:14:00", "private" : false, "owner_name" : "ide_owner_name", "refresh_interval" : 30, "owner_id" : "d78cbac186b744899480f25bd022f468...", "description" : "aaa", "cpu_memory" : "1U1G", "display_name" : "chen002", "domain_name" : "IAM_DOMAIN_NAME_A", "is_temporary" : false, "organization_id" : "6251b1ee539f4c02ad4b83daeda81633...", "stack_id" : "python", "name" : "ide-instance8bmjgqx6vfrb9e9n", "platform_id" : 1, "attributes" : { "cpu_limit" : "1", "pvc_quantity" : "5Gi", "memory_limit_bytes" : "1073741824" }, "pvc_quantity" : "5GB", "arch" : "x86", "id" : "instancewc0yk05c8y6jov0v", "region" : "cn-north-7", "status" : "STOPPED", "visitor_id" : "c78cbac186b744899480f25bd022f468...", "visitor_name" : "ide_visitor_name", "visitor_domain_name" : "IAM_DOMAIN_NAME_B" }, "status" : "success"}

响应示例 状态码： 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" } ] } ] } ]}

概述 面向云原生的轻量级WebIDE，通过浏览器访问即可实现云端开发环境获取、代码编写、编译调试、运行预览、访问代码仓库、命令行执行等能力，同时支持丰富的插件扩展。 您可以使用本文档提供的API对CodeArts IDE Online进行相关操作，如：IDE实例管理、技术栈管理、模板管理等。支持的全部操作请参见API概览。 在调用CodeArts IDE Online的API之前，请确保已经充分了解CodeArts IDE Online的相关概念，详细信息请参见产品介绍。 父主题： 使用前必读

响应示例 状态码： 200 OK { "result" : { "security" : { "status" : "success" }, "file" : { "status" : "success" }, "basicInformation" : { "status" : "success", "extension_version_compare" : "NULL_VERSION", "extension_brief_info" : { "publisherSnake" : { "publisher_id" : "c45c552c14b94e0889e0346090688ad9", "publisher_name" : "lemontree", "display_name" : "lemontree" }, "identifier" : "lemontree.big-file-test", "logUrl" : "https://cnnorth6-dev-cloudide.obs.cn-north-6.myhuaweicloud.com:443/upload/d6cbb007-4071-4bce-921f-538e78ce4859/icon.png?AccessKeyId=7JLQBTJ2B3TEYUIF00FF&Expires=1676272349&Signature=lT9YyiqQddPYYmaVoJ9hgvdGed8%3D", "displayName" : "bigfile upload test", "platform" : "codearts ide online", "version" : "0.0.1", "description" : "Debug for AOC SSP" } } }, "status" : "success"}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String iam x-auth-token Content-Type 否 String content enum - application/json 枚举值： application/json 表2 请求Body参数 参数 是否必选 参数类型 描述 case 否 String case chat_id 是 String chat id message 是 String message infer_end 否 Boolean infer end meta_prompt 否 Array of strings prompt need_preprocess 否 Boolean need or not user_id 否 String user id task_parameters 否 Object task parameters

响应参数 状态码： 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 错误码 状态码： 404 表6 响应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必传一个

文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第十九次正式发布，本次变更说明如下： 新增接口：查询插件分类 新增接口：插件发布 新增接口：获取插件检测结果 新增接口：获取当前用户下的发布商列表 新增接口：文件上传归一化 新增接口：CreateLogin接口 新增接口：CreateJoinRequest接口 新增接口：CreateEvent接口 2023-04-11 第十八次正式发布，本次变更说明如下： CloudIDE服务更名为CodeArts IDE Online 2023-02-16 第十七次正式发布，本次变更说明如下： 新增接口：CreateAcceptance接口 新增接口：Create Request接口 新增接口：Show Result接口 2022-12-05 第十六次正式发布，本次变更说明如下： 新增接口：添加插件评论 新增接口：添加评论回复、回复评论回复 新增接口：添加新评星 新增接口：举报评论,举报回复 新增接口：删除评论 新增接口：删除回复 新增接口：查询插件列表 新增接口：查询插件详细信息 新增接口：查询插件评价 新增接口：查询插件评星 2022-11-23 第十五次正式发布，本次变更说明如下： 接口查询某个IDE实例更新：响应示例中删掉instance.is_private。 接口启动IDE实例更新：新增请求示例。 接口查询某个租户下的IDE实例列表更新：响应示例参数删除 instances.count、instances.items.is_private。 接口查询IDE实例列表更新：响应示例参数删除 instances.count、instances.items.is_private。 接口查询技术栈模板工程更新：响应参数中新增arch参数。 2022-08-24 第十四次正式发布，本次变更说明如下： 新增接口：查询某个IDE实例的状态。 接口创建IDE实例更新：删除参数instance_user_domain_name、instance_user_name。 接口外部第三方集成商创建IDE实例更新：删除参数instance_user_domain_name、instance_user_name。 2022-07-22 第十三次正式发布，本次变更说明如下： 新增接口：上传插件。 2022-07-01 第十二次正式发布，本次变更说明如下： 接口创建IDE实例更新：新增请求Body参数instance_domain_id和instance_user_id。 参数描述中“组织”修改改成“租户”。 2022-03-01 第十一次正式发布，本次变更说明如下： 刷新refresh_interval参数。 2022-01-26 第十次正式发布，本次变更说明如下： 新增接口：按region获取标签所有技术栈。 废弃接口：获取标签所有技术栈。 2022-01-11 第九次正式发布，本次变更说明如下： 修改接口查询某个IDE实例的响应参数。 修改接口查询某个租户下的IDE实例列表的响应参数。 修改接口查询IDE实例列表的响应参数。 更新部分接口的参数描述。 2021-12-20 第八次正式发布，本次变更说明如下： 新增接口：查询用户是否有权限访问某个IDE实例 新增接口：刷新IDE实例活跃状态 新增接口：查询ide实例对插件的授权情况 新增接口：设置ide实例对插件的授权 2021-12-13 第七次正式发布，本次变更说明如下： 新增权限策略和授权项相关内容。 2021-08-24 第六次正式发布，本次变更说明如下： 接口创建IDE实例更新：新增请求Body参数。 更新部分接口参数描述。 2021-01-27 第五次正式发布，本次变更说明如下： 错误码更新：错误响应Body体格式示例更新。 接口启动IDE实例更新：新增请求body参数。 接口创建IDE实例更新：请求Body参数新增port_id、private_ip、vpc_id三个参数。 新增接口：查询当前账号访问权限。 2020-12-29 第四次正式发布，本次变更说明如下： 接口创建IDE实例返回值更新。 接口外部第三方集成商创建IDE实例返回值更新。 2020-11-09 第三次正式发布，本次变更说明如下： 更新终端节点，新增北京一和大连。 2020-09-17 第二次正式发布，本次变更说明如下： 新增应用示例。 2020-07-31 第一次正式发布。 2020-07-07

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应参数 状态码： 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 错误码 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 successful operation { "result" : { "size" : 30, "total_items_count" : 3, "items_before" : 0, "items" : [ { "id" : 74, "extension_id" : "17c341ee-797e-4824-aec5-6fafb3c0eced", "comment" : "1111111", "stars" : 5, "create_time" : "2022-02-17 09:35:31", "last_updated" : "2022-04-11 16:52:12", "status" : "VALIDATED", "commentator" : { "domainId" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "domainName" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "deletedTime" : 0 } }, { "id" : 75, "extension_id" : "17c341ee-797e-4824-aec5-6fafb3c0eced", "comment" : "4分", "stars" : 4, "create_time" : "2022-02-17 09:41:24", "last_updated" : "2022-02-17 09:41:24", "status" : "VALIDATED", "commentator" : { "domainId" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "domainName" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "deletedTime" : 0 } } ], "empty" : false }, "status" : "success"}

响应示例 状态码： 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" } ] } ] } ]}

请求参数 表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 过滤类型对应字段名称

实例相关权限 表1 实例相关权限 权限 对应API接口 授权项（Action） 依赖的授权项 IAM项目 (Project) 企业项目(Enterprise Project) 创建IDE实例 POST /v2/{org_id}/instances cloudIDE:instance:create - √ × 删除IDE实例 DELETE /v2/instances/{instance_id} cloudIDE:instance:delete - √ × 启动IDE实例 PUT /v2/instances/{instance_id}/runtime cloudIDE:instance:start - √ × 停止IDE实例 DELETE /v2/instances/{instance_id}/runtime cloudIDE:instance:stop - √ × 访问IDE实例 仅支持CodeArts IDE Online内部调用，API方式不支持 cloudIDE:instance:access - √ × 修改IDE实例（仅修改描述和名称） PUT /v2/instances/{instance_id} cloudIDE:instance:update - √ × 分发实例给访问者 POST /v2/instances/{instance_id}/visitor cloudIDE:instance:assign - √ × 授权实例给用户 POST /v2/instance/{instance_id}/user cloudIDE:instance:auth - √ × 重置实例 POST /v2/instance/{instance_id}/reset cloudIDE:instance:reset - √ × 父主题： 权限策略和授权项

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 返回值 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 错误码

响应示例 状态码： 200 Successful Response { "tasks" : [ { "request_id" : "d980c2b5242eb97aa07a1f6645a6793a", "task_id" : 0, "language" : "python", "snippet" : "def add(x, y):\n return x + y", "generated_snippet" : "", "docker_id" : "02:55:ac:10:00:36", "start_time" : "2022-11-21T19:48:30", "record_time" : "2022-11-21T19:48:30", "time_consuming" : 0.022447, "status" : "success", "exception" : null, "model_id" : "300M" } ], "request_status" : "completed", "request_type" : "function"}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 request_status String the status of the request 枚举值： created dispatched completed timeout unknown tasks Array of TaskModel objects task list request_type String the type of the request 表3 TaskModel 参数 参数类型 描述 docker_id String the docker_id exception String exception generated_snippet String the generated_snippet language String code language model_id String model_id record_time String record_time request_id String the unique id of request snippet String the snippet of code start_time String start_time status String status task_id Integer task_id time_consuming Number the time_consuming