检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
产品名。 home_link String 首页链接。 api_link String api调试链接。 sdk_link String sdk下载链接。 doc_link String 文档链接。 logo_link String logo链接。 表6 TopicCategory 参数
js-v3 终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询服务的终端节点。 模板服务的终端节点如下表所示,请您根据业务需要选择对应区域的终端节点。 表1 模板服务的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京一
Repo模板创建生成应用代码的任务,并将应用代码存储于指定的CodeArts Repo仓库中或者生成代码压缩包,可以通过返回的任务 ID 查询相关任务状态。 接口鉴权方式 通过华为云服务获取的用户token。 代码生成位置 应用代码生成后的地址,目前支持CodeArts Repo地址和压缩包下载地址。
项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。
说明 读取模板文件 读取模板文件 同步模板浏览记录 未登录状态下,将用户浏览过的模板缓存在浏览器中,登录时,调用该接口同步模板浏览记录。 我浏览的模板记录 查询DevStar或者CodeLabs登录用户浏览过的模板(只返回最近浏览的5个模板)。 查询模板列表 查询模板列表。 查询模板详情(V3)
查询任务详情 功能介绍 查询任务的详情。 通过任务ID可以查看任务的状态 当任务结束时返回应用代码存放的位置。 接口鉴权方式 通过华为云服务获取的用户token。 代码生成位置 应用代码生成后的地址,目前支持CodeArts Repo地址和压缩包下载地址。 调试 您可以在API
优化创建部署任务:增加CCI部署方式 2022-01-27 新增API 使用CodeArts IDE Online实例打开应用代码 查询模板列表 废弃API(仍可以访问,但不推荐使用,推荐使用最新版本接口) 查询模板列表(V1) 查询模板列表(V2) 查询模板详情(V1) 2021-12-29
查询应用关联资源删除状态 功能介绍 根据应用Id查询应用关联的代码仓、流水线删除状态 使用场景:用户删除应用关联的资源(如代码仓、流水线...)后,通过该接口实时查询代码仓、流水线删除状态 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explor
返回模板的数量。 templates Array of TemplateSimpleInfo objects 返回模板的列表。 表4 TemplateSimpleInfo 参数 参数类型 描述 id String 模板id。 title String 模板名。 description
Boolean 是否删除代码仓 pipeline_ids 否 String 删除流水线ID,多流水线逗号隔开 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应
Integer 每页显示的条目数量 offset 否 Integer 偏移量,表示从此偏移量开始查询 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
application_id 是 String 应用id environment_tag 是 String 环境标识,从 应用详情接口 返回报文中的环境信息获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Language 否 String 语言类型 中文:zh-cn
DevStar是否收费? 计费说明 DevStar本身是免费的。如果您使用DevStar的模板创建代码工程,并将代码工程导入代码仓库,由于该功能涉及到项目管理和代码托管两个服务,因此可能由于超出这两个服务的免费范围而产生计费。关于这两个服务的计费请参见CodeArts计费说明。
application_id 是 String 应用id environment_tag 是 String 环境标识,从 应用详情接口 返回报文中的环境信息获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Language 否 String 语言类型 中文:zh-cn
Online免费实例链接,true表示创建一个IDE免费实例链接,false表示创建一个IDE收费实例链接。 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口
应用代码仓库统计信息 功能介绍 查询代码仓库的统计信息,包括代码仓的名称,代码行数等信息 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/reposi
同步模板浏览记录 功能介绍 未登录状态下,将用户浏览过的模板缓存在浏览器中,登录时,调用该接口同步模板浏览记录。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST