CLI命令参考
租户相关
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查内置执行机规格 | hcloud CodeArtsBuild ShowAvailableInnerSpec | 查内置执行机规格 | |
| 获取套餐临期信息 | hcloud CodeArtsBuild ShowPackageSpecCountDown | 获取套餐临期信息 | |
| 查询租户状态 | hcloud CodeArtsBuild ShowDomainStatus | 查询租户状态 | |
| 查询当前租户（计费）类型 | hcloud CodeArtsBuild ShowUserChargeType | 查询当前租户（计费）类型 | |
| 获取用户权限 | hcloud CodeArtsBuild ShowProjectPermission | 获取用户权限 | |
| 获取当前用户的项目信息列表 | hcloud CodeArtsBuild ShowRelatedProject | 获取当前用户的项目信息列表 | |
| 获取项目列表 | hcloud CodeArtsBuild ListRelatedProjectInfo | 获取项目列表 | |
| 获取租户任务总数和成功率接口 | hcloud CodeArtsBuild ShowSummaryBuildJobInfo | 获取租户任务总数和成功率接口 | |
| 当前用户所在项目所属租户的包周期每月时长是否超额 | hcloud CodeArtsBuild ShowUserOverPackageQuota | 当前用户所在项目所属租户的包周期每月时长是否超额 |
镜像模板
构建任务管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 收藏任务 | hcloud CodeArtsBuild AddFavouriteTask | 收藏任务 | |
| 取消收藏任务 | hcloud CodeArtsBuild RemoverFavouriteTask | 取消收藏任务 | |
| 任务是否使用项目级权限 | hcloud CodeArtsBuild ApplyProjectPermission | 任务是否使用项目级权限 | |
| 批量修改任务权限 | hcloud CodeArtsBuild BatchUpdateJobRolePermission | 批量修改任务权限 | |
| 是否已开启内网安全访问 | hcloud CodeArtsBuild CheckJobInternal | 是否已开启内网安全访问 | |
| 查询私有依赖仓库列表 | hcloud CodeArtsBuild ListEndPoints | 查询私有依赖仓库列表 | |
| 更新通知配置 | hcloud CodeArtsBuild UpdateNewNoticeNew | 更新通知配置 | |
| 获取通知信息 | hcloud CodeArtsBuild ShowJobNoticeConfigInfo | 获取通知信息 | |
| 根据持续构建名称，获取任务构建状态、百分比、剩余时间 | hcloud CodeArtsBuild ShowBuildDetails | 根据持续构建名称，获取任务构建状态、百分比、剩余时间 | |
| 查询跨租户场景下其他租户的状态 | hcloud CodeArtsBuild ShowDomainsStatuses | 查询跨租户场景下其他租户的状态 | |
| 流水线查看构建任务信息 | hcloud CodeArtsBuild ShowJobPipelineInfo | 流水线查看构建任务信息 | |
| 停止构建任务v1 | hcloud CodeArtsBuild StopTheJob | 停止构建任务 | |
| 获取任务权限矩阵 | hcloud CodeArtsBuild ShowProjectJobPermission | 获取任务权限矩阵 | |
| 创建构建任务 | hcloud CodeArtsBuild CreateNewJob | 创建构建任务 | |
| 恢复回收站中的任务 | hcloud CodeArtsBuild RestoreRecyclingJobs | 恢复回收站中的任务 | |
| 设置回收站中的任务保留时间 | hcloud CodeArtsBuild SetKeepTime | 设置回收站中的任务保留时间,该接口需要租户账号才能访问，租户子账号无权限访问 | |
| 更新构建任务 | hcloud CodeArtsBuild UpdateNewJob | 更新构建任务 | |
| 检查webhook地址参数 | hcloud CodeArtsBuild CheckWebhookUrl | 检查webhook地址参数 | |
| 执行构建 | hcloud CodeArtsBuild ExecuteJob | 执行构建任务 | |
| 禁用任务 | hcloud CodeArtsBuild DisableTheJob | 禁用任务 | |
| 删除任务 | hcloud CodeArtsBuild DeleteTheJob | 删除任务 | |
| 复制构建任务 | hcloud CodeArtsBuild CopyJob | 复制构建任务 | |
| 删除回收站中的任务 | hcloud CodeArtsBuild DeleteRecyclingJobs | 删除回收站中的任务 | |
| 清空回收站中的任务 | hcloud CodeArtsBuild ClearRecyclingJobs | 清空回收站中的任务 | |
| 查询任务是否已禁用 | hcloud CodeArtsBuild ShowDisable | 查询任务是否已禁用 | |
| 复制任务名 | hcloud CodeArtsBuild ShowCopyName | 复制任务名 | |
| 查询任务状态 | hcloud CodeArtsBuild ShowJobStepStatus | 查询任务状态 | |
| 获取当前项目默认角色权限矩阵信息 | hcloud CodeArtsBuild ShowDefaultProjectPermission | 获取当前项目默认角色权限矩阵信息 | |
| 获取修改历史 | hcloud CodeArtsBuild ListUpdateJobHistory | 获取修改历史 | |
| 查看任务是否在构建 | hcloud CodeArtsBuild ShowRunningStatus | 查看任务是否在构建 | |
| 查看回收站中删除的构建任务列表 | hcloud CodeArtsBuild ListRecyclingJob | 查看回收站中删除的构建任务列表 | |
| 查看系统预定义参数 | hcloud CodeArtsBuild ShowJobSystemParameters | 查看系统预定义参数 | |
| 查看构建任务构建信息 | hcloud CodeArtsBuild ShowJobInfo | 查看构建任务构建信息 | |
| 编辑页获取参数类型的接口 | hcloud CodeArtsBuild ShowBuildParamsList | 编辑页获取参数类型的接口 | |
| 获取构建任务配置的对比差异 | hcloud CodeArtsBuild ShowJobConfigDiff | 获取构建任务配置的对比差异 | |
| 获取构建任务的角色权限矩阵信息 | hcloud CodeArtsBuild ShowJobRolePermission | 获取构建任务的角色权限矩阵信息 | |
| 查询项目任务列表 | hcloud CodeArtsBuild ListProjectJobs | 查询项目任务列表 | |
| 获取构建任务详情 | hcloud CodeArtsBuild ShowJobConfig | 获取构建任务详情 | |
| 获取编译构建默认参数 | hcloud CodeArtsBuild ShowDefaultBuildParameters | 获取编译构建默认参数 | |
| 查看项目下任务名是否存在 | hcloud CodeArtsBuild CheckJobNameIsExists | 查看项目下任务名是否存在 | |
| 查看用户全部的构建任务列表 | hcloud CodeArtsBuild ListJob | 查看用户全部的构建任务列表 | |
| 检查任务数量是否上限 | hcloud CodeArtsBuild CheckJobCountIsTopLimit | 检查任务数量是否上限 | |
| 详情页获取构建参数 | hcloud CodeArtsBuild ListBuildParameter | 详情页获取构建参数 |
构建记录
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取指定工程的简要构建信息 | hcloud CodeArtsBuild ListBriefRecord | 获取指定工程的简要构建信息 | |
| 获取任务各阶段信息 | hcloud CodeArtsBuild ShowBuildRecordFullStages | 获取任务各阶段信息 | |
| 查询指定构建记录详情 | hcloud CodeArtsBuild ShowBuildRecord | 查询指定构建记录详情 | |
| 获取构建记录的构建脚本 | hcloud CodeArtsBuild ShowBuildRecordBuildScript | 获取构建记录的构建脚本 | |
| 获取任务构建记录列表v1 | hcloud CodeArtsBuild ListBuildInfoRecordByJobId | 获取任务构建记录列表 | |
| 获取指定工程的构建记录列表 | hcloud CodeArtsBuild ListRecords | 获取指定工程的构建记录列表 | |
| 获取任务构建记录列表 | hcloud CodeArtsBuild ShowBuildInfoRecord | 获取任务构建记录列表 | |
| 获取构建记录的有向无环图 | hcloud CodeArtsBuild ShowBuildRecordFlowGraph | 获取构建记录的有向无环图 | |
| 获取构建记录信息 | hcloud CodeArtsBuild ShowJobBuildRecordDetail | 获取构建记录信息 | |
| 构建历史页获取构建次数 | hcloud CodeArtsBuild ShowJobTotal | 构建历史页获取构建次数 |
构建报告
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询构建成功率 | hcloud CodeArtsBuild ShowJobBuildSuccessRatio | 查询构建成功率 | |
| 获取覆盖率接口 | hcloud CodeArtsBuild ShowReportSummary | 获取覆盖率接口 | |
| 洞察构建时长 | hcloud CodeArtsBuild ShowJobBuildTime | 洞察构建时长 | |
| 获取单元测试覆盖率报告列表 | hcloud CodeArtsBuild ListJunitCoverageSummary | 获取单元测试覆盖率报告列表 | |
| 查看仓库 | hcloud CodeArtsBuild ListRepository | 查看仓库 | |
| 获取该任务所有分支信息 | hcloud CodeArtsBuild ListRepoBranch | 获取该任务所有分支信息 | |
| 获取单元测试覆盖率报告压缩包 | hcloud CodeArtsBuild DownloadJunitCoverageZip | 获取单元测试覆盖率报告压缩包 |
模板管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 收藏官方模板 | hcloud CodeArtsBuild AddFavouriteOfficialTemplate | 收藏官方模板 | |
| 取消收藏官方模板 | hcloud CodeArtsBuild RemoverFavouriteOfficialTemplate | 取消收藏官方模板 | |
| 收藏自定义模板 | hcloud CodeArtsBuild AddFavouriteCustomTemplate | 收藏自定义模板 | |
| 取消收藏自定义模板 | hcloud CodeArtsBuild RemoverFavouriteCustomTemplate | 取消收藏自定义模板 | |
| 根据模板uuid查询特定模板 | hcloud CodeArtsBuild ShowTemplate | 根据模板uuid查询特定模板 | |
| 保存模板使用记录 | hcloud CodeArtsBuild SaveTemplateUsedInfo | 保存模板使用记录 | |
| 创建构建模板 | hcloud CodeArtsBuild CreateTemplate | 创建构建模板 | |
| 获取官方推荐模板 | hcloud CodeArtsBuild ListRecommendOfficialTemplate | 获取官方推荐模板 | |
| 删除构建模板 | hcloud CodeArtsBuild DeleteTemplate | 删除构建模板 | |
| 获取代码化构建默认模板 | hcloud CodeArtsBuild ShowYamlTemplate | 获取代码化构建默认模板 | |
| 查询官方模板 | hcloud CodeArtsBuild ListOfficialTemplate | 查询官方模板 | |
| 根据条件查询特定模板 | hcloud CodeArtsBuild ListCustomTemplate | 根据条件查询特定模板 |
文件管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 配置文件权限 | hcloud CodeArtsBuild UpdateKeystorePermission | 配置文件权限 | |
| 添加文件权限 | hcloud CodeArtsBuild AddKeystorePermission | 添加文件权限 | |
| 上传文件 | hcloud CodeArtsBuild UploadKeystore | 上传文件 | |
| 更新文件信息 | hcloud CodeArtsBuild UpdateKeystore | 更新文件信息 | |
| 删除文件管理文件 | hcloud CodeArtsBuild DeleteKeystore | 删除文件管理文件 | |
| 文件管理删除权限 | hcloud CodeArtsBuild DeleteKeystorePermission | 文件管理删除权限 | |
| 文件管理文件下载 | hcloud CodeArtsBuild DownloadKeystoreByName | 文件管理文件下载 | |
| 文件管理查询权限 | hcloud CodeArtsBuild ShowKeystorePermission | 文件管理查询权限 | |
| 查询用户可使用文件 | hcloud CodeArtsBuild ListKeystore | 查询用户可使用文件 | |
| 查询租户下文件列表 | hcloud CodeArtsBuild ListKeystoreSearch | 查询租户下文件列表 |
编译构建(旧)
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量删除构建任务 | hcloud CodeArtsBuild BatchDeleteBuildJobs | 批量删除构建任务 | |
| 根据开始时间和结束时间查看构建任务的构建历史列表 | hcloud CodeArtsBuild ShowListPeriodHistory | 根据开始时间和结束时间查看构建任务的构建历史列表 | |
| 查看构建任务的构建历史列表 | hcloud CodeArtsBuild ShowListHistory | 查看构建任务的构建历史列表 | |
| KeyStore文件下载 | hcloud CodeArtsBuild DownloadKeystore | 下载指定租户下的KeyStore文件 | |
| 查看任务运行状态 | hcloud CodeArtsBuild ShowJobStatus | 查看任务运行状态 | |
| 查看项目下用户的构建任务列表 | hcloud CodeArtsBuild ShowJobListByProjectId | 查看项目下用户的构建任务列表 | |
| 执行构建任务 | hcloud CodeArtsBuild RunJob | 执行构建任务,可传自定义参数 | |
| 查询指定代码仓库最近一次成功的构建历史 | hcloud CodeArtsBuild ShowLastHistory | 查询指定代码仓库最近一次成功的构建历史 | |
| 获取构建历史详情信息接口 | hcloud CodeArtsBuild ShowHistoryDetails | 获取构建历史详情信息接口 | |
| 根据开始时间和结束时间查看构建任务的构建成功率 | hcloud CodeArtsBuild ShowJobSuccessRatio | 根据开始时间和结束时间查看构建任务的构建成功率 | |
| 下载全量构建日志 | hcloud CodeArtsBuild DownloadBuildLog | 下载全量构建日志 | |
| 下载构建步骤日志 | hcloud CodeArtsBuild DownloadTaskLog | 下载构建步骤日志 | |
| 获取构建记录信息 | hcloud CodeArtsBuild ShowRecordDetail | 获取构建记录信息 | |
| 获取构建产物详情信息 | hcloud CodeArtsBuild ShowOutputInfo | 获取构建产物详情信息 | |
| 停止构建任务 | hcloud CodeArtsBuild StopBuildJob | 停止构建任务 | |
| 删除构建任务 | hcloud CodeArtsBuild DeleteBuildJob | 删除构建任务 | |
| 禁用构建任务 | hcloud CodeArtsBuild DisableBuildJob | 禁用构建任务 | |
| 恢复构建任务 | hcloud CodeArtsBuild EnableBuildJob | 恢复构建任务 | |
| 创建构建任务 | hcloud CodeArtsBuild CreateBuildJob | 创建构建任务 | |
| 更新构建任务 | hcloud CodeArtsBuild UpdateBuildJob | 更新构建任务 | |
| 查询构建模板 | hcloud CodeArtsBuild ListTemplates | 查询构建模板 | |
| 创建构建模板 | hcloud CodeArtsBuild CreateTemplates | 创建构建模板 | |
| 删除构建模板 | hcloud CodeArtsBuild DeleteTemplates | 删除构建模板 | |
| 查询通知 | hcloud CodeArtsBuild ListNotice | 查询通知 | |
| 更新通知 | hcloud CodeArtsBuild UpdateNotice | 更新通知 | |
| 取消通知 | hcloud CodeArtsBuild DisableNotice | 取消通知 | |
| 获取构建任务详情 | hcloud CodeArtsBuild ListJobConfig | 获取构建任务详情 | |
| 下载构建实时日志 | hcloud CodeArtsBuild DownloadRealTimeLog | 下载构建实时日志 | |
| 获取任务构建记录列表 | hcloud CodeArtsBuild ListBuildInfoRecord | 获取任务构建记录列表 |
编译构建(待下线)
日志管理
分组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 修改分组信息 | hcloud CodeArtsBuild UpdateJobGroup | 修改分组信息 | |
| 查询分组树 | hcloud CodeArtsBuild ListGroupTree | 查询分组树 | |
| 交换分组顺序 | hcloud CodeArtsBuild SwitchedPacket | 交换分组顺序 | |
| 移动构建任务至指定分组 | hcloud CodeArtsBuild MoveGroup | 移动构建任务至指定分组 | |
| 删除分组 | hcloud CodeArtsBuild DeleteGroup | 删除分组 | |
| 创建构建任务分组 | hcloud CodeArtsBuild CreateJobGroup | 创建构建任务分组 |
