检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
CodeArts IDE Online提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 您可以在API Explorer中调用API,查看API请求和返回结果。此外,API Explorer
Online服务共同设定标签。 API的调用方法请参见如何调用API。接口参数详情参考 外部第三方集成商创建IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 创建IDE实例 创建指定技术栈及规格的IDE实例。 请求示例 POST https://{endpoint}/v2/instances
cheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 请求方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。
示例1:创建IDE实例 操作场景 本节指导用户通过API创建IDE实例。 API的调用方法请参见如何调用API,接口参数详情参考 创建IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 创建IDE实例 检查实例名是否重复。 GET https://
修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。 父主题: 如何调用API
示例2:查询IDE实例列表 操作场景 用户通过查询IDE实例列表接口,使用分页参数查询租户下所有IDE实例列表。API的调用方法请参见如何调用API。 本节示例操作包括分页查询,接口支持过滤和排序参数的操作,参数详情请参见查询IDE实例列表。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。
示例4:停止IDE实例 操作场景 用户通过调用停止IDE实例接口,停止运行中或启动中的实例。实例停止后,不会删除磁盘数据。 API的调用方法请参见如何调用API。接口参数详情参考停止IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 已经通过调用创建IDE实例接口创建过实例。
实例已停止 问题现象 页面中显示实例已停止。 原因分析 此类问题通常是由于资源不足造成。 处理方法 请稍等几分钟后,刷新页面,重新启动实例。
无法启动实例,重定向到了实例列表 问题现象 启动实例失败,页面自动重定向到了实例列表。 原因分析 浏览器缓存的错误可能导致无法正确加载实例。 处理方法 可以尝试清理或者禁用网站缓存,然后重新打开实例。
页面加载失败 问题现象 CodeArts IDE Online页面加载失败。 原因分析 页面加载失败通常是由于网络连接不稳定或被拦截导致。 处理方法 检查浏览器网络连接是否正常。若无网络连接,请修复网络连接。刷新页面重试,若仍加载失败,请参照2继续排查处理。 如果电脑使用的是无线网络环境,请确保连接的稳定。
Information 非授权信息,请求成功。 204 NoContent 请求完全成功,同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容,服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。
error_msg String 错误描述 error_code String 错误码 请求示例 回复评论ID为354的评论“回复评价” POST https://{endpoint}/v1/marketplace/extension/evaluation/reply { "evaluation_id"
求,则不需要创建独立的IAM用户,可以跳过本章节,不影响使用CodeArts IDE Online服务的其它功能。 本章节介绍对用户授权的方法,操作流程如示例流程所示。 前提条件 已了解用户组可以添加的CodeArts IDE Online系统策略,并结合实际需求进行选择。 CodeArts
错误码 请求示例 为插件ID为“7d7faebb-0def-480b-b2a2-7781318db893”的插件添加5星好评。 POST https://{endpoint}/v1/marketplace/star { "extension_id" : "7d7faebb-0d
String status error_message String error message 请求示例 async chat POST https://{endpoint}/v1/codebreezetsbot/devmind/tsbot/async-chat { "chat_id"
规格为“2U4G”、PVC规则为“5GB”、自动休眠时长为30分钟、不在页面显示,用户ID和租户ID为“test”的实例。 POST https://{endpoint}/v2/instances { "instance_name" : "testjava", "stack_id"
描述 error_msg String 错误描述 error_code String 错误码 请求示例 停止IDE实例 DELETE https://{endpoint}/v2/instances/zhkfjt/runtime 响应示例 状态码: 200 OK { "result"
error_msg String 错误描述 error_code String 错误码 请求示例 查询用户是否有权限访问某个IDE实例 GET https://{endpoint}/v2/instances/zhkfjt/access 响应示例 状态码: 200 OK { "result"
描述 error_msg String 错误描述 error_code String 错误码 请求示例 发布类型为10的插件。 POST https://{endpoint}/v1/marketplace/extension/4d56sa65d44d5sa6d4sa56/archiving
描述 error_msg String 错误描述 error_code String 错误码 请求示例 查询当前账号访问权限 GET https://{endpoint}/v2/permission/account/status 响应示例 状态码: 200 OK { "result"