更新时间:2023-03-01 GMT+08:00
分享

API概览

应用管理

应用管理接口,包括应用的查询、应用部署、应用构建、应用软件包查询、项目列表查询、流水线模板列表查、流水线运行状态查询等。您可以通过这些接口完成应用的DevOps开发流程。

表1 应用管理

API

说明

查询应用关联资源删除状态

根据应用Id查询应用关联的代码仓、流水线删除状态 使用场景:用户删除应用关联的资源(如代码仓、流水线...)后,通过该接口实时查询代码仓、流水线删除状态。

获取应用详情

根据应用Id获取应用详情。

更新应用信息

根据应用Id更新对应有权限的应用信息,允许更新信息的信息包含 name,description,icon

获取应用依赖元数据资源

根据应用Id获取依赖元数据资源。

删除应用信息

根据应用Id删除应用,并可以选择删除其关联的代码仓、流水线资源。

获取应用列表

获取我创建的应用列表 当前只支持查询我创建的应用,其中请求参数is_created_by_self需为true。

查询应用环境部署任务详情

查询应用环境部署任务详情。

创建部署任务

创建部署任务,并触发任务执行,当前只支持函数部署。 其中,报文中file_id为查询软件版本包接口返回版本包id; handler为在函数部署方式下,入口函数名称,从应用代码中获取,格式为“包名.类名.函数名称”,例如:com.example.demo.APIGTrigger.handler。 也可以从应用详情接口返回结构template_deployment中直接获取。

流水线模板列表查询

流水线模板列表查询。

查询流水线最近一次运行状态查询接口

查询应用流水线最近一次运行状态查询接口。

根据流水线Id操作流水线启动

根据流水线Id操作流水线启动。

获取用户有权限的DevStar存量CodeArts项目列表

获取用户有权限的DevStar存量CodeArts项目列表。 来源包括:1.DevStar创建的CodeArts项目;2.DevStar应用有关联CodeArts项目。

检查仓库名称是否重名

检查仓库名称是否重名

  • 校验规则 同一个项目下的仓库名称不能存在重复,当结果为true时,校验通过,仓库名称可用,否则,校验不通过,当前项目下的仓库名称已存在,不可用。
  • 必传参数 project_id,name,region_id。

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

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

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

应用代码仓库统计信息

查询代码仓库的统计信息,包括代码仓的名称,代码行数等信息。

通过应用Id获取软件发布仓库列表

通过应用Id获取软件发布仓库列表。

模板管理

模板管理接口,包括查询模板列表查询模板详情等。

表2 模板管理

API

说明

读取模板文件

读取模板文件

同步模板浏览记录

未登录状态下,将用户浏览过的模板缓存在浏览器中,登录时,调用该接口同步模板浏览记录。

我浏览的模板记录

查询DevStar或者CodeLabs登录用户浏览过的模板(只返回最近浏览的5个模板)。

查询模板列表

查询模板列表。

查询模板详情(V3)

获取指定模板详情,包括模板id、名称、描述、作者、标签、上架时间等信息。

代码生成

代码生成接口,包括创建、下载和查询等。通过这些接口,您可以创建生成代码任务、下载生成代码、获取代码生成任务的信息。

表3 代码生成

API

说明

CodeArts Repo模板生成代码

通过 CodeArts Repo的模板进行应用代码创建。

Devstar 模板生成代码

通过 DevStar 的模板进行应用代码创建。

查询任务详情

查询任务执行状态,执行时间,执行结果详情。

下载模板产物

下载生成的应用代码压缩包。

分享:

    相关文档

    相关产品