检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用说明 CodeArts IDE Online提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 您可以在API Explorer中调用API,查看API请求和返回结果。此外,API
如何调用API 构造请求 认证鉴权 返回结果
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987
体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户
来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 To
示例2:查询IDE实例列表 操作场景 用户通过查询IDE实例列表接口,使用分页参数查询租户下所有IDE实例列表。API的调用方法请参见如何调用API。 本节示例操作包括分页查询,接口支持过滤和排序参数的操作,参数详情请参见查询IDE实例列表。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。
示例4:停止IDE实例 操作场景 用户通过调用停止IDE实例接口,停止运行中或启动中的实例。实例停止后,不会删除磁盘数据。 API的调用方法请参见如何调用API。接口参数详情参考停止IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 已经通过调用创建IDE实例接口创建过实例。
示例1:创建IDE实例 操作场景 本节指导用户通过API创建IDE实例。 API的调用方法请参见如何调用API,接口参数详情参考 创建IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。 创建IDE实例 检查实例名是否重复。 GET https://
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题。
示例3:外部第三方集成商创建IDE实例 操作场景 第三方集成商通过调用接口,创建IDE实例。不同的第三方需要和CodeArts IDE Online服务共同设定标签。 API的调用方法请参见如何调用API。接口参数详情参考 外部第三方集成商创建IDE实例。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 图1 获取账号ID 父主题:
查询ide实例对插件的授权情况 功能介绍 查询ide实例对插件的授权情况,同意授权的插件能在ide实例内携带登录用户的token调用第三方服务 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
IDE Online支持直接运行Java的main函数。支持手动编译,或等待自动编译完成。手动编译操作步骤如下: 双击文件名称,打开文件,等待“Run | Debug”按钮显示在main函数上方。 单击“Run”,运行main函数。 添加断点 双击文件名称,打开文件。 将鼠标移到
获取项目ID 调用API获取项目ID 项目ID还可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
调试”,可打开调试视图。 单击调试视图中的,开始调试代码。 查看变量,可使用以下3种方式进行查看。 将鼠标停留在变量上直接查看。 在调试控制台输入框中输入变量进行查看。 在调试视图中VARIABLES状态栏进行查看。 代码格式检查 CodeArts IDE Online默认采用的是go-lint工具进行格式检查。
开发调试微服务代码 代码编写完毕,单击左侧Debug页签中的“Start Debug”或Main函数中的“Debug”启动工程,在代码文件行号前鼠标左键单击打上断点,完成监听端口的外部访问权开通即可边调试边在浏览器中查看代码修改的应用效果。 动图演示如下: 父主题: 基于CodeArts IDE Online快速开发、部署微服务
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,CodeArts IDE Online的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 CodeArts IDE Online的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型
查询插件评价 功能介绍 查询插件评价 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/marketplace/feedback/evaluation 表1
查询IDE实例名是否重复 功能介绍 查询IDE实例名是否重复 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/instances/duplicate 表1
查询当前账号访问权限 功能介绍 查询当前账号访问权限 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/permission/account/status