检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,CodeArts IDE Online的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 CodeArts IDE Online的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型
支持通过以下两种方式新建文件: 选择目录节点,单击鼠标右键,单击“新建文件”。 选择目录节点,在键盘上敲击快捷键“Alt+N”。 编辑文件 选择文件节点,双击鼠标左键,在编辑区打开的文件中修改内容并保存,保存的快捷键为“Ctrl+S”。 文件/目录重命名 有以下两种方式可以实现: 选择文件/目录节点,单击鼠标右键,单击“重命名”。
获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects":
本节示例操作包括分页查询,接口支持过滤和排序参数的操作,参数详情请参见查询IDE实例列表。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 查询IDE实例列表 指定limit查询IDE实例列表。 GET: https://{endpoint}/v2/instances?limit=10
本节指导用户通过API创建IDE实例。 API的调用方法请参见如何调用API,接口参数详情参考 创建IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 创建IDE实例 检查实例名是否重复。 GET https://{endpoint}/v2/instances/duplicate?display_name=test
API的调用方法请参见如何调用API。接口参数详情参考 外部第三方集成商创建IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 创建IDE实例 创建指定技术栈及规格的IDE实例。 请求示例 POST https://{endpoint}/v2/instances
API的调用方法请参见如何调用API。接口参数详情参考停止IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 已经通过调用创建IDE实例接口创建过实例。 停止IDE实例 实例ID可通过查询IDE实例列表接口或创建IDE实例接口返回的id获取。 请求示例
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从终端节点中获取。例如,IAM服务在华北-北京一区域的Endpoint为iam.cn-north-1.myhuaweicloud.com。 resource-path
接口创建IDE实例返回值更新。 接口外部第三方集成商创建IDE实例返回值更新。 2020-11-09 第三次正式发布,本次变更说明如下: 更新终端节点,新增北京一和大连。 2020-09-17 第二次正式发布,本次变更说明如下: 新增应用示例。 2020-07-31 第一次正式发布。 2020-07-07
API概览 表1 CodeArts IDE Online接口说明 分类 接口 IDE实例管理 查询IDE实例名是否重复 查询某个IDE实例 修改IDE实例 删除IDE实例 启动IDE实例 停止IDE实例 创建IDE实例 查询某个租户下的IDE实例列表 查询IDE实例列表 外部第三方集成商创建IDE实例
CreateJoinRequest接口 功能介绍 create a join-request 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/aim
CreateEvent接口 功能介绍 create an event 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/aims/codemodels
CreateLogin接口 功能介绍 create a login 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/aims/codemodelse
删除回复 功能介绍 删除回复 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v1/marketplace/evaluation/reply/{reply_id}
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 图1 获取账号ID 父主题:
删除评论 功能介绍 删除评论 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v1/marketplace/evaluation/{evaluation_id}
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题。
插件发布 功能介绍 插件发布 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v1/marketplace/extension/{task_id}/archiving