文档首页/ DevStar/ API参考/ API/ 应用管理/ 使用CodeArts IDE Online实例打开应用代码
更新时间：2024-07-04 GMT+08:00
查看PDF
分享

使用CodeArts IDE Online实例打开应用代码

功能介绍

使用CodeArts IDE Online实例打开应用代码。CodeArts IDE Online会保存用户项目数据，相同用户使用同一个IDE，使用要求：

  • 用户需为登录状态。
  • 拥有仓库权限。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/repositories/{repository_id}/show/cloudide

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

String

仓库id。
表2 Query参数

参数

是否必选

参数类型

描述

repository_ssh_url

是

String

仓库下载地址。

region_id

否

String

区域ID，目前仅支持北京四：cn-north-4及北京一：cn-north-1。

space_prefix

否

String

工作空间名称前缀，仅在is_open_last为false时生效，由用户自定义，支持大小写字母、中文、_、-，长度1-256。

is_open_last

否

Boolean

是否打开上一次的工作空间，true表示打开上一次工作空间，如果没有上一次工作空间会返回空，false代表打开一个全新的工作空间。

is_free

否

Boolean

是否创建CodeArts IDE Online免费实例链接，true表示创建一个IDE免费实例链接，false表示创建一个IDE收费实例链接。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

X-Language

否

String

语言类型 中文:zh-cn 英文:en-us

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

url

String

CodeArts IDE Online打开链接:https://xxx/cloudide/loading?instanceId=xxx&scmUrl=xxx

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

请求示例

GET https://{endpoint}/v1/repositories/9f5533ec708d412884652afea13302f2/show/cloudide?repository_ssh_url=git@codehub.XXX.inhuawei.com:ssdsd00001%2Fsadfasdfa.git&is_open_last=true&space_prefix=MyApplication-MyRepo&is_free=false

响应示例

状态码： 200

ok

{
  "url" : "https://***/cloudide/loading?instanceId=xxx&scmUrl=xxx"
}

状态码： 400

Bad Request

{
  "error_code" : "DEVSTAR.1001",
  "error_msg" : "repository_id : 非法参数"
}

状态码： 401

Unauthorized

{
  "error_code" : "DEV.00000001",
  "error_msg" : "未识别到用户认证信息"
}

状态码： 403

Forbidden

{
  "error_code" : "DEVSTAR.1034",
  "error_msg" : "无操作权限"
}

状态码： 404

Not Found

{
  "error_code" : "DEVSTAR.1038",
  "error_msg" : "仓库不存在"
}

状态码

状态码

描述

200

ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 应用管理

相关文档