检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询ide实例对插件的授权情况 功能介绍 查询ide实例对插件的授权情况,同意授权的插件能在ide实例内携带登录用户的token调用第三方服务 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
查询用户是否有权限访问某个IDE实例 功能介绍 查询用户是否有权限访问某个IDE实例 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/instances
获取标签所有技术栈(废弃) 功能介绍 获取标签所有技术栈。替换API请参见按region获取标签所有技术栈。 URI GET /v2/stacks 表1 Query参数 参数 是否必选 参数类型 描述 tags 否 Array 技术栈标签。默认为空值,查询全部。 例如:Java,CPP
获取当前用户下的发布商列表 功能介绍 获取当前用户下的发布商列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/marketplace/publishers
示例2:查询IDE实例列表 操作场景 用户通过查询IDE实例列表接口,使用分页参数查询租户下所有IDE实例列表。API的调用方法请参见如何调用API。 本节示例操作包括分页查询,接口支持过滤和排序参数的操作,参数详情请参见查询IDE实例列表。 前提条件 确定调用API的Endpoint
按region获取标签所有技术栈 功能介绍 按region获取标签所有技术栈 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/stacks/tag 表1
示例3:外部第三方集成商创建IDE实例 操作场景 第三方集成商通过调用接口,创建IDE实例。不同的第三方需要和CodeArts IDE Online服务共同设定标签。 API的调用方法请参见如何调用API。接口参数详情参考 外部第三方集成商创建IDE实例。 前提条件 确定调用API
查询某个租户下的IDE实例列表 功能介绍 查询某个租户下的IDE实例列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{org_id}/instances
附录 状态码 错误码 获取项目ID 获取账号ID
外部第三方集成商创建IDE实例 功能介绍 创建IDE实例 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/instances 表1 Query参数 参数
应用示例 示例1:创建IDE实例 示例2:查询IDE实例列表 示例3:外部第三方集成商创建IDE实例 示例4:停止IDE实例
获取项目ID 调用API获取项目ID 项目ID还可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题
文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第十九次正式发布,本次变更说明如下: 新增接口:查询插件分类 新增接口:插件发布 新增接口:获取插件检测结果 新增接口:获取当前用户下的发布商列表 新增接口:文件上传归一化
状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 201
概述 面向云原生的轻量级WebIDE,通过浏览器访问即可实现云端开发环境获取、代码编写、编译调试、运行预览、访问代码仓库、命令行执行等能力,同时支持丰富的插件扩展。 您可以使用本文档提供的API对CodeArts IDE Online进行相关操作,如:IDE实例管理、技术栈管理、模板管理等
调用说明 CodeArts IDE Online提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 您可以在API Explorer中调用API,查看API请求和返回结果。此外,API
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 图1 获取账号ID 父主题
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读