检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
准备工作 在使用CodeArts IDE Online前,您需要完成以下两项准备工作。 注册华为云并实名认证 为账户充值 注册华为云并实名认证 如果您已有一个华为云帐号,请忽略这一步。如果您还没有华为云帐号,请参考以下步骤创建。 登录华为云官网,单击右上角“注册”。 根据提示信息
查询插件分类 功能介绍 查询插件分类 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/marketplace/extension/category 表1
查询插件评价 功能介绍 查询插件评价 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/marketplace/feedback/evaluation 表1
公共查询权限 表1 公共查询权限 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目(Enterprise Project) 查询指定IDE实例详情 GET /v2/instances/{instance_id} cloudIDE:instance:get
查询插件评星 功能介绍 查询插件评星 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/marketplace/feedback/star 表1 Query参数
查询某个IDE实例 功能介绍 查询某个IDE实例 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/instances/{instance_id} 表1
查询插件列表 功能介绍 查询插件列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v1/marketplace/extension/extensionquery
查询插件详细信息 功能介绍 查询插件详细信息 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v1/marketplace/extension/public/detail
示例2:查询IDE实例列表 操作场景 用户通过查询IDE实例列表接口,使用分页参数查询租户下所有IDE实例列表。API的调用方法请参见如何调用API。 本节示例操作包括分页查询,接口支持过滤和排序参数的操作,参数详情请参见查询IDE实例列表。 前提条件 确定调用API的Endpoint,详细信息请参见终端节点。
查询技术栈模板工程 功能介绍 查询技术栈模板工程 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/templates 表1 Query参数 参数 是否必选
查询IDE实例名是否重复 功能介绍 查询IDE实例名是否重复 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/instances/duplicate 表1
查询某个IDE实例的状态 功能介绍 查询某个IDE实例的状态 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/instances/{instance_id}/status
offset 否 Long 偏移量,表示从此偏移量开始查询 is_temporary 否 Boolean 是否页面显示(以标签配置为准) label 否 String 标签 search 否 String 关键字查询(根据实例名,描述模糊查询) sort_dir 否 String 排序方式
00000005 suspended 您的账户已欠费冻结 账户充值 403 IDE.00000007 not verified 账号未实名认证,请认证后再试 账号实名认证 403 IDE.00000010 account is not normal 账号状态异常,请稍后再试 检查账号是否异常
查询当前账号访问权限 功能介绍 查询当前账号访问权限 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/permission/account/status
查询ide实例对插件的授权情况 功能介绍 查询ide实例对插件的授权情况,同意授权的插件能在ide实例内携带登录用户的token调用第三方服务 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
查询用户是否有权限访问某个IDE实例 功能介绍 查询用户是否有权限访问某个IDE实例 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/instance
IDE Online的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 CodeArts IDE Online的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 cloudide.cn-north-4.myhuaweicloud
Long 每页显示的条目数量 10/15/30 offset 否 Long 偏移量,表示从此偏移量开始查询 search 否 String 关键字查询(根据实例名,描述模糊查询) 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需