检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 应用管理 模板管理 代码生成
附录 状态码 错误码 获取项目ID 获取账号ID
优化API 优化创建部署任务:增加CCI部署方式 2022-01-27 新增API 使用CodeArts IDE Online实例打开应用代码 查询模板列表 废弃API(仍可以访问,但不推荐使用,推荐使用最新版本接口) 查询模板列表(V1) 查询模板列表(V2) 查询模板详情(V1)
应用管理接口,包括应用的查询、应用部署、应用构建、应用软件包查询、项目列表查询、流水线模板列表查、流水线运行状态查询等。您可以通过这些接口完成应用的DevOps开发流程。 表1 应用管理 API 说明 查询应用关联资源删除状态 根据应用Id查询应用关联的代码仓、流水线删除状态 使用场景:用户删除应用关联的资源(如代码仓、流水线
应用示例 使用 Devstar 模板创建代码生成任务并将代码工程推送到 CodeArts Repo 使用 Devstar 模板创建代码生成任务并下载代码工程到本地
部署任务执行变更人工审核 流水线模板列表查询 查询流水线最近一次运行状态查询接口 根据流水线Id操作流水线启动 获取用户有权限的DevStar存量CodeArts项目列表 检查仓库名称是否重名 使用CodeArts IDE Online实例打开应用代码 应用代码仓库统计信息 通过应用Id获取软件发布仓库列表
代码生成 CodeArts Repo模板生成代码 Devstar 模板生成代码 查询任务详情 下载模板产物 父主题: API
功能介绍 使用CodeArts Repo模板创建应用代码。 通过CodeArts Repo模板创建生成应用代码的任务,并将应用代码存储于指定的CodeArts Repo仓库中或者生成代码压缩包,可以通过返回的任务 ID 查询相关任务状态。 接口鉴权方式 通过华为云服务获取的用户token。
DevStar是否收费? 计费说明 DevStar本身是免费的。如果您使用DevStar的模板创建代码工程,并将代码工程导入代码仓库,由于该功能涉及到项目管理和代码托管两个服务,因此可能由于超出这两个服务的免费范围而产生计费。关于这两个服务的计费请参见CodeArts计费说明。
Devstar 模板生成代码 功能介绍 使用DevStar的模板创建应用代码。 通过 DevStar 模板创建生成应用代码的任务,并将应用代码存储于指定的CodeArts Repo仓库中,可以通过返回的任务 ID 查询相关任务状态。 接口鉴权方式 通过华为云服务获取的用户token。 代码生成位置
Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK
String 模板的名称。 description String 模板的描述信息。 region_id String 模板关联的region host id。 repostory_id String 模板关联的repo id。 code_url String 模板https下载路径。
200 表3 响应Body参数 参数 参数类型 描述 count Integer 返回模板的数量。 templates Array of TemplateSimpleInfo objects 返回模板的列表。 表4 TemplateSimpleInfo 参数 参数类型 描述 id String
请上架模板后重试 400 DEVSTAR.1061 The decompressed file is too large. 解压之后的文件过大 仅支持解压后200M的模板 400 DEVSTAR.1062 Decompression failed. Check whether the compressed
个资源特征与地址的列表用于用户终端(例如:浏览器)选择。 301 Moved Permanently 永久移动,请求的资源已被永久的移动到新的URI,返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。
描述 topic_id String topic的id。 topic_name String topic的名称。 category_id String topic对应的类别的id。 category_name String topic对应的类别的名称。 表7 TagInfo 参数 参数类型
查询任务详情 功能介绍 查询任务的详情。 通过任务ID可以查看任务的状态 当任务结束时返回应用代码存放的位置。 接口鉴权方式 通过华为云服务获取的用户token。 代码生成位置 应用代码生成后的地址,目前支持CodeArts Repo地址和压缩包下载地址。 调试 您可以在API
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
获取应用列表 功能介绍 获取我创建的应用列表 当前只支持查询我创建的应用,其中请求参数is_created_by_self需为true 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。