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