检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
start_chat_codebreezetsbot_v1_devmind_tsbot_start_chat_post接口 功能介绍 开启对话:param data: example: {"user_type": "IDE"}:return: 调试 您可以在API Explorer
附录 状态码 错误码 获取项目ID 获取账号ID
async_chat_codebreezetsbot_v1_devmind_tsbot_async_chat_post接口 功能介绍 异步聊天请求:param data: ChatRequestMessage:return: 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权
应用示例 示例1:创建IDE实例 示例2:查询IDE实例列表 示例3:外部第三方集成商创建IDE实例 示例4:停止IDE实例
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 201
async_get_chat_result_codebreezetsbot_v1_devmind_tsbot_async_get_chat_result_post接口 功能介绍 异步聊天获取结果 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
概述 面向云原生的轻量级WebIDE,通过浏览器访问即可实现云端开发环境获取、代码编写、编译调试、运行预览、访问代码仓库、命令行执行等能力,同时支持丰富的插件扩展。 您可以使用本文档提供的API对CodeArts IDE Online进行相关操作,如:IDE实例管理、技术栈管理、模板管理等
文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第十九次正式发布,本次变更说明如下: 新增接口:查询插件分类 新增接口:插件发布 新增接口:获取插件检测结果 新增接口:获取当前用户下的发布商列表 新增接口:文件上传归一化
调用说明 CodeArts IDE Online提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 您可以在API Explorer中调用API,查看API请求和返回结果。此外,API
获取项目ID 调用API获取项目ID 项目ID还可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 图1 获取账号ID 父主题
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员
示例1:创建IDE实例 操作场景 本节指导用户通过API创建IDE实例。 API的调用方法请参见如何调用API,接口参数详情参考 创建IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 创建IDE实例 检查实例名是否重复。 GET https://{
权限策略和授权项 权限及授权项说明 公共查询权限 实例相关权限 策略及授权项说明 公共查询权限 实例相关权限
示例4:停止IDE实例 操作场景 用户通过调用停止IDE实例接口,停止运行中或启动中的实例。实例停止后,不会删除磁盘数据。 API的调用方法请参见如何调用API。接口参数详情参考停止IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 已经通过调用创建
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,CodeArts IDE Online的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 CodeArts IDE Online的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型
公共查询权限 表1 公共查询权限 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目(Enterprise Project) 查询指定IDE实例详情 GET /v2/instances/{instance_id} cloudIDE:
实例相关权限 表1 实例相关权限 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目(Enterprise Project) 创建IDE实例 POST /v2/{org_id}/instances cloudIDE:instance