CLI命令参考
主机集群管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 新建主机集群 | hcloud CodeArtsDeploy CreateDeploymentGroup | 在项目下新建主机集群。该接口于2024年09月30日后不再维护，推荐使用新版CreateHostCluster接口。 | |
| 查询主机集群列表 | hcloud CodeArtsDeploy ListHostGroups | 按条件查询主机集群列表。该接口于2024年09月30日后不再维护，推荐使用新版ListHostClusters接口。 | |
| 删除主机集群 | hcloud CodeArtsDeploy DeleteDeploymentGroup | 根据主机集群id删除主机集群。该接口于2024年9月30日后不再维护。 | |
| 查询主机集群详情 | hcloud CodeArtsDeploy ShowDeploymentGroupDetail | 根据主机集群id查询主机集群详情。该接口于2024年09月30日后不再维护，推荐使用新版ShowHostClusterDetail接口。 | |
| 修改主机集群 | hcloud CodeArtsDeploy UpdateDeploymentGroup | 根据主机集群id修改主机集群信息。该接口于2024年9月30日后不再维护。 | |
| 新建主机集群 | hcloud CodeArtsDeploy CreateHostCluster | 在项目下新建主机集群。 | |
| 查询主机集群列表 | hcloud CodeArtsDeploy ListHostClusters | 按条件查询主机集群列表。 | |
| 查询主机集群详情 | hcloud CodeArtsDeploy ShowHostClusterDetail | 根据主机集群id查询主机集群详情。 | |
| 编辑主机集群 | hcloud CodeArtsDeploy UpdateHostCluster | 编辑主机集群。 | |
| 删除主机集群 | hcloud CodeArtsDeploy DeleteHostCluster | 根据主机集群id删除主机集群。 | |
| 查询主机集群关联环境信息 | hcloud CodeArtsDeploy ListAssociateEnvironmentsInfos | 查询主机集群关联环境信息。 | |
| 查询应用下环境基本信息列表 | hcloud CodeArtsDeploy ListHostGroupBaseInfos | 查询应用下环境基本信息列表。 |
主机管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 新建主机 | hcloud CodeArtsDeploy CreateDeploymentHost | 在指定主机集群下新建主机。该接口于2024年09月30日后不再维护，推荐使用新版CreateHost接口。 | |
| 查询主机列表 | hcloud CodeArtsDeploy ListHosts | 根据主机集群id查询指定主机集群下的主机列表。该接口于2024年09月30日后不再维护，推荐使用新版ListNewHosts接口。 | |
| 查询主机详情 | hcloud CodeArtsDeploy ShowDeploymentHostDetail | 根据主机id查询主机详情。该接口于2024年09月30日后不再维护，推荐使用新版ShowHostDetail接口。 | |
| 修改主机 | hcloud CodeArtsDeploy UpdateDeploymentHost | 根据主机id修改主机信息。该接口于2024年9月30日后不再维护。 | |
| 删除主机 | hcloud CodeArtsDeploy DeleteDeploymentHost | 根据主机id删除主机。该接口于2024年9月30日后不再维护。 | |
| 新建主机 | hcloud CodeArtsDeploy CreateHost | 在指定主机集群下新建主机。 | |
| 查询主机列表 | hcloud CodeArtsDeploy ListNewHosts | 根据主机集群id查询指定主机集群下的主机列表。 | |
| 查询主机详情 | hcloud CodeArtsDeploy ShowHostDetail | 根据主机id查询主机详情。 | |
| 编辑主机集群下主机信息 | hcloud CodeArtsDeploy UpdateHostInfo | 根据主机id编辑主机集群下主机信息。 | |
| 删除主机集群下主机 | hcloud CodeArtsDeploy DeleteHost | 根据主机id删除主机集群下主机。 | |
| 批量复制主机至目标主机集群 | hcloud CodeArtsDeploy CopyHostsToTarget | 批量复制主机至目标主机集群。 | |
| 批量删除主机集群下的主机 | hcloud CodeArtsDeploy BatchDeleteHosts | 批量删除主机集群下的主机。 |
应用管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取应用列表 | hcloud CodeArtsDeploy ListDeployTasks | 查询项目下应用列表。该接口于2024年09月30日后不再维护，推荐使用新版ListAllApp接口。 | |
| 通过模板新建应用 | hcloud CodeArtsDeploy CreateDeployTaskByTemplate | 通过模板新建应用。该接口于2024年09月30日后不再维护，推荐使用新版CreateApp接口。 | |
| 部署应用 | hcloud CodeArtsDeploy StartDeployTask | 根据部署任务id部署应用。 | |
| 获取应用详情 | hcloud CodeArtsDeploy ShowDeployTaskDetail | 根据部署任务id获取应用详情。该接口于2024年09月30日后不再维护，推荐使用新版ShowAppDetailById接口。 | |
| 删除应用 | hcloud CodeArtsDeploy DeleteDeployTask | 根据部署任务id删除应用。该接口于2024年09月30日后不再维护，推荐使用新版DeleteApplication接口。 | |
| 根据开始时间和结束时间查询项目下指定应用的历史部署记录列表 | hcloud CodeArtsDeploy ListDeployTaskHistoryByDate | 根据开始时间和结束时间查询项目下指定应用的历史部署记录列表。 | |
| 获取应用列表 | hcloud CodeArtsDeploy ListAllApp | 查询项目下应用列表。 | |
| 新建应用 | hcloud CodeArtsDeploy CreateApp | 新建应用。 | |
| 更新应用 | hcloud CodeArtsDeploy UpdateAppInfo | 更新应用。 | |
| 获取应用详情 | hcloud CodeArtsDeploy ShowAppDetailById | 根据应用id获取应用详情。 | |
| 删除应用 | hcloud CodeArtsDeploy DeleteApplication | 根据应用id删除应用。 | |
| 查询部署记录的执行参数 | hcloud CodeArtsDeploy ShowExecutionParams | 查询部署记录的执行参数。 | |
| 复制应用 | hcloud CodeArtsDeploy CopyApplication | 复制应用。 | |
| 批量删除项目下应用 | hcloud CodeArtsDeploy BatchDeleteApp | 批量删除项目下应用。 | |
| 查询项目下是否存在同名应用 | hcloud CodeArtsDeploy CheckIsDuplicateAppName | 查询项目下是否存在同名应用。 | |
| 禁用/取消禁用应用 | hcloud CodeArtsDeploy UpdateAppDisableStatus | 禁用/取消禁用应用。 |
应用分组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询分组列表 | hcloud CodeArtsDeploy ListAppGroups | 查询分组列表。 | |
| 创建分组 | hcloud CodeArtsDeploy CreateAppGroups | 创建分组。 | |
| 修改分组 | hcloud CodeArtsDeploy UpdateAppGroups | 修改分组。 | |
| 删除分组 | hcloud CodeArtsDeploy DeleteAppGroups | 删除分组。 | |
| 移动分组 | hcloud CodeArtsDeploy MoveAppGroups | 往上或者往下移动单个分组,用来在页面上调整分组位置。 | |
| 移动应用至指定分组 | hcloud CodeArtsDeploy MoveAppToGroup | 将应用移动至指定分组（支持批量）。 |
应用权限管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询应用实例级/项目级权限矩阵 | hcloud CodeArtsDeploy ListApplicationPermissions | 查询应用实例级/项目级权限矩阵，传递app_id时，查询应用实例级权限矩阵；未传app_id，传递project_id时，查询应用项目级权限矩阵。 | |
| 批量修改应用权限 | hcloud CodeArtsDeploy BatchUpdateApplicationPermissions | 批量修改应用权限。 | |
| 批量配置应用下鉴权级别 | hcloud CodeArtsDeploy BatchUpdatePermissionLevel | 批量配置应用下鉴权级别为项目级或实例级。 | |
| 查询当前用户是否有项目下创建应用权限 | hcloud CodeArtsDeploy CheckCanCreate | 查询当前用户是否有项目下创建应用权限。 |
部署记录度量
环境管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 应用下创建环境 | hcloud CodeArtsDeploy CreateEnvironment | 应用下创建环境。 | |
| 查询应用下环境列表 | hcloud CodeArtsDeploy ListEnvironments | 查询应用下环境列表。 | |
| 应用下编辑环境 | hcloud CodeArtsDeploy UpdateEnvironment | 应用下编辑环境。 | |
| 删除应用下的环境 | hcloud CodeArtsDeploy DeleteEnvironment | 删除应用下的环境。 | |
| 查询环境详情 | hcloud CodeArtsDeploy ShowEnvironmentDetail | 查询环境详情。 | |
| 环境下导入主机 | hcloud CodeArtsDeploy ImportHostToEnvironment | 环境下导入主机。 | |
| 环境下删除主机 | hcloud CodeArtsDeploy DeleteHostFromEnvironment | 环境下删除主机。 | |
| 查询环境内的主机列表 | hcloud CodeArtsDeploy ListEnvironmentHosts | 查询环境内的主机列表。 |
