检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询模板列表。 查询模板详情(V3) 获取指定模板详情,包括模板id、名称、描述、作者、标签、上架时间等信息。 代码生成 代码生成接口,包括创建、下载和查询等。通过这些接口,您可以创建生成代码任务、下载生成代码、获取代码生成任务的信息。 表3 代码生成 API 说明 CodeArts Repo模板生成代码
用户通过控制台访问DevStar,可以浏览和使用模板,以及对模板及应用的全生命周期管理。 API方式 如果用户需要将公有云平台上的DevStar集成到第三方系统,用于二次开发,请使用API方式访问。 CLI方式 支持用户通过CLI方式访问DevStar,提供模板浏览和按模板生成框架代码的能力。
region_id 否 String 区域id,从控制台获取方法请参见: 获取区域ID keyword 否 String 搜索关键字,支持按名称和描述搜索,默认null project_id 否 String 所属CodeArts项目id,从 项目列表接口 查询。 topic_id 否
查询流水线最近一次运行状态查询接口 功能介绍 查询应用流水线最近一次运行状态查询接口 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/pipeline
应用名称 description String 应用描述 region_id String 区域id region_name String 区域名称 project_id String 所属项目id project_name String 项目名称 icon String 应用图标
URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint:指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud
/v1/templates 表1 Query参数 参数 是否必选 参数类型 描述 keyword 否 String 搜索关键字,支持按名称和描述搜索,默认null。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 limit 否 Integer
Array of strings 模板分类数组。 keyword 否 String 搜索关键字,支持按名称和描述搜索,默认null。 sort_by 否 String 排序字段和排序顺序指定。比如: desc(created_at):根据创建时间降序 desc(usage_count):根据引用次数降序
获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects":
GET /v4/projects 表1 Query参数 参数 是否必选 参数类型 描述 keyword 否 String 搜索关键字,支持按名称和描述搜索,默认null limit 否 Integer 每页显示的条目数量,默认100 offset 否 Integer 偏移量,表示从此偏移量开始查询
查询模板详情(V1) 功能介绍 查询模板详情,推荐使用V3版本接口。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String
使用 Devstar 模板创建代码生成任务并下载代码工程到本地 概述 本文通过调用一系列模板服务的 API 介绍使用 Devstar 模板创建应用代码并下载到本地的基本流程。 其中,模板使用Devstar官方SpringBoot模板。 API 的调用方法请参见如何调用API。 创建流程
of the region is not found. 没有找到region的域名 请联系技术支持 400 DEVSTAR.1021 Invalid keyword. 非法关键词 请检查字段填写是否和接口定义一致 400 DEVSTAR.1022 The application information
查询应用关联资源删除状态 功能介绍 根据应用Id查询应用关联的代码仓、流水线删除状态 使用场景:用户删除应用关联的资源(如代码仓、流水线...)后,通过该接口实时查询代码仓、流水线删除状态 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explor
同步模板浏览记录 功能介绍 未登录状态下,将用户浏览过的模板缓存在浏览器中,登录时,调用该接口同步模板浏览记录。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST
使用 Devstar 模板创建代码生成任务并将代码工程推送到 CodeArts Repo 概述 本文通过调用一系列模板服务的 API 介绍使用 Devstar模板服创建应用代码到CodeArts Repo的基本流程。 其中,模板使用Devstar官方SpringBoot模板。 API
读取模板文件 功能介绍 该接口可以用于模板作者或模板维护人读取模板文件内容。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/templates/{template_id}/files
终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询服务的终端节点。 模板服务的终端节点如下表所示,请您根据业务需要选择对应区域的终端节点。 表1 模板服务的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京一 cn-north-1
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
当任务结束时返回应用代码存放的位置。 接口鉴权方式 通过华为云服务获取的用户token。 代码生成位置 应用代码生成后的地址,目前支持CodeArts Repo地址和压缩包下载地址。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。