检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
安装命令行工具 前提条件 操作系统为 Linux、Windows或Mac OS。 安装 node.js 10以上版本。 操作步骤 下载命令行工具。 npm install -g @huaweicloud/hcloud 验证命令行工具安装结果。 执行如下命令,显示版本号则安装成功。
查询模板列表 功能介绍 查询模板列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v1/templates/query 请求参数 表1 请求Header参数
获取应用列表 功能介绍 获取我创建的应用列表 当前只支持查询我创建的应用,其中请求参数is_created_by_self需为true 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
流水线模板列表查询 功能介绍 流水线模板列表查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/pipeline-templates 表1 Query参数
查询模板列表(V1) 功能介绍 查询模板列表,推荐使用/v1/templates/query接口。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/templates 表1 Query参数 参数 是否必选 参数类型 描述 keyword 否 String
查询模板列表(V2) 功能介绍 查询模板列表。 调试 您可以在API Explorer中调试该接口。 URI POST /v2/templates/action 表1 Query参数 参数 是否必选 参数类型 描述 action_id 是 String 请填写固定值“query”。
通过应用Id获取软件发布仓库列表 功能介绍 通过应用Id获取软件发布仓库列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/applications
获取用户有权限的DevStar存量CodeArts项目列表 功能介绍 获取用户有权限的DevStar存量CodeArts项目列表。 来源包括:1.DevStar创建的CodeArts项目;2.DevStar应用有关联CodeArts项目。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API
状态码 状态码如表1所示 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。
API概览 应用管理 应用管理接口,包括应用的查询、应用部署、应用构建、应用软件包查询、项目列表查询、流水线模板列表查、流水线运行状态查询等。您可以通过这些接口完成应用的DevOps开发流程。 表1 应用管理 API 说明 查询应用关联资源删除状态 根据应用Id查询应用关联的代码仓、流水线删除状态
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
使用 Devstar 模板创建代码生成任务并将代码工程推送到 CodeArts Repo 概述 本文通过调用一系列模板服务的 API 介绍使用 Devstar模板服创建应用代码到CodeArts Repo的基本流程。 其中,模板使用Devstar官方SpringBoot模板。 API
使用 Devstar 模板创建代码生成任务并下载代码工程到本地 概述 本文通过调用一系列模板服务的 API 介绍使用 Devstar 模板创建应用代码并下载到本地的基本流程。 其中,模板使用Devstar官方SpringBoot模板。 API 的调用方法请参见如何调用API。 创建流程
查询模板 功能 查看系统当前可使用的模板列表。 语法 hcloud DevStar ListTemplates --cli-region="cn-north-1" [--keyword=template_name] 参数说明 表1 请求参数说明 参数名称 是否必选 参数描述 template_name
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面中查看账号ID。 图1 获取账号ID 父主题: 附录
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需
修订记录 发布日期 修订记录 2022-04-29 新增API 部署任务执行变更人工审核 优化API 优化创建部署任务:增加CCI部署方式 2022-01-27 新增API 使用CodeArts IDE Online实例打开应用代码 查询模板列表 废弃API(仍可以访问,但不推荐使用,推荐使用最新版本接口)
使用CodeArts IDE Online实例打开应用代码 功能介绍 使用CodeArts IDE Online实例打开应用代码。CodeArts IDE Online会保存用户项目数据,相同用户使用同一个IDE,使用要求: 用户需为登录状态。 拥有仓库权限。 调试 您可以在API
删除应用信息 功能介绍 根据应用Id删除应用,并可以选择删除其关联的代码仓、流水线资源 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v4/appl