检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
DevStar是否收费? 计费说明 DevStar本身是免费的。如果您使用DevStar的模板创建代码工程,并将代码工程导入代码仓库,由于该功能涉及到项目管理和代码托管两个服务,因此可能由于超出这两个服务的免费范围而产生计费。关于这两个服务的计费请参见CodeArts计费说明。
查询模板列表。 查询模板详情(V3) 获取指定模板详情,包括模板id、名称、描述、作者、标签、上架时间等信息。 代码生成 代码生成接口,包括创建、下载和查询等。通过这些接口,您可以创建生成代码任务、下载生成代码、获取代码生成任务的信息。 表3 代码生成 API 说明 CodeArts Repo模板生成代码
命令使用 版本查询 查询模板 代码生成
历史API 模板管理
API 应用管理 模板管理 代码生成
应用管理 查询应用关联资源删除状态 获取应用详情 更新应用信息 获取应用依赖元数据资源 删除应用信息 获取应用列表 查询应用环境部署任务详情 创建部署任务 部署任务执行变更人工审核 流水线模板列表查询 查询流水线最近一次运行状态查询接口 根据流水线Id操作流水线启动 获取用户有权
代码生成 CodeArts Repo模板生成代码 Devstar 模板生成代码 查询任务详情 下载模板产物 父主题: API
应用示例 使用 Devstar 模板创建代码生成任务并将代码工程推送到 CodeArts Repo 使用 Devstar 模板创建代码生成任务并下载代码工程到本地
模板管理 查询模板列表(V1) 查询模板列表(V2) 查询模板详情(V1) 父主题: 历史API
模板管理 读取模板文件 同步模板浏览记录 我浏览的模板记录 查询模板列表 查询模板详情(V3) 父主题: API
总览”中,同时您可以在“我的应用”中找到这个应用。 应用创建成功后,会在CodeArts对应项目下创建一个代码仓库和一条流水线,您可以在DevStar对应应用中查看和操作他们,如下图。 在此应用中,切换到“应用部署”。 目前DevStar服务提供了“开发环境”、“预发环境”、“生
当任务结束时返回应用代码存放的位置。 接口鉴权方式 通过华为云服务获取的用户token。 代码生成位置 应用代码生成后的地址,目前支持CodeArts Repo地址和压缩包下载地址。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
查询相关任务状态。 接口鉴权方式 通过华为云服务获取的用户token。 代码生成位置 应用代码生成后的地址,目前支持CodeArts Repo地址和压缩包下载地址。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
修订记录 发布日期 修订记录 2022-04-29 新增API 部署任务执行变更人工审核 优化API 优化创建部署任务:增加CCI部署方式 2022-01-27 新增API 使用CodeArts IDE Online实例打开应用代码 查询模板列表 废弃API(仍可以访问,但不推荐使用,推荐使用最新版本接口)
附录 状态码 错误码 获取项目ID 获取账号ID
获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects":