CLI Command Reference

Adding a host cluster - 2

hcloud CodeArtsDeploy CreateDeploymentGroup

Create a host cluster in the project. This interface will no longer be maintained after September 30, 2024. You are advised to use the CreateHostCluster interface of the new version.

Go debug

Query the list of host clusters.

hcloud CodeArtsDeploy ListHostGroups

This interface is used to query the host cluster list based on conditions. This interface will no longer be maintained after September 30, 2024. You are advised to use the ListHostClusters interface of the new version.

Go debug

Deletes a host cluster.

hcloud CodeArtsDeploy DeleteDeploymentGroup

This interface is used to delete a host cluster based on the host cluster ID. This interface will no longer be maintained after September 30, 2024.

Go debug

Querying Host Clusters

hcloud CodeArtsDeploy ShowDeploymentGroupDetail

This interface is used to query details about a host cluster based on the host cluster ID. This interface will no longer be maintained after September 30, 2024. You are advised to use the ShowHostClusterDetail interface of the new version.

Go debug

Modifying a Host Cluster

hcloud CodeArtsDeploy UpdateDeploymentGroup

This interface is used to modify host cluster information based on the host cluster ID. This interface will no longer be maintained after September 30, 2024.

Go debug

Create Host Cluster

hcloud CodeArtsDeploy CreateHostCluster

Create a host cluster in the project.

Go debug

Query the list of host clusters.

hcloud CodeArtsDeploy ListHostClusters

This interface is used to query the host cluster list based on conditions.

Go debug

Querying a Host Cluster

hcloud CodeArtsDeploy ShowHostClusterDetail

Query host cluster detail by host cluster ID.

Go debug

Editing a Host Cluster

hcloud CodeArtsDeploy UpdateHostCluster

This API is used to edit a host cluster.

Go debug

Deleting a Host Cluster

hcloud CodeArtsDeploy DeleteHostCluster

This API is used to delete a host cluster.

Go debug

Querying Information About the Environment Associated with a Host Cluster

hcloud CodeArtsDeploy ListAssociateEnvironmentsInfos

This API is used to query information about the environment associated with a host cluster.

Go debug

Querying the Basic Environment Information List of an Application

hcloud CodeArtsDeploy ListHostGroupBaseInfos

This API is used to query the basic environment information list of an application.

Go debug

Creating a host

hcloud CodeArtsDeploy CreateDeploymentHost

Create a host in a specified host cluster. This interface will no longer be maintained after September 30, 2024. You are advised to use the CreateHost interface of the new version.

Go debug

Querying a host list

hcloud CodeArtsDeploy ListHosts

This interface is used to query the list of hosts in a specified host cluster based on the host cluster ID. This interface will no longer be maintained after September 30, 2024. You are advised to use the ListNewHosts interface of the new version.

Go debug

Querying Host Details

hcloud CodeArtsDeploy ShowDeploymentHostDetail

This interface is used to query host details based on the host ID. This interface will no longer be maintained after September 30, 2024. You are advised to use the ShowHostDetail interface of the new version.

Go debug

Modify attributes of a host

hcloud CodeArtsDeploy UpdateDeploymentHost

This interface is used to modify host information based on the host ID. This interface will no longer be maintained after September 30, 2024.

Go debug

Deleting a Host

hcloud CodeArtsDeploy DeleteDeploymentHost

This interface is used to delete a host based on the host ID. This interface will no longer be maintained after September 30, 2024.

Go debug

Creat host

hcloud CodeArtsDeploy CreateHost

Create a host in host cluster.

Go debug

Querying a host list

hcloud CodeArtsDeploy ListNewHosts

Query host list by host cluster ID.

Go debug

Querying Host Details

hcloud CodeArtsDeploy ShowHostDetail

Query host details by host ID.

Go debug

Editing Host Information in a Host Cluster

hcloud CodeArtsDeploy UpdateHostInfo

This API is used to edit host information in a host cluster by ID.

Go debug

Deleting a Host from a Host Cluster

hcloud CodeArtsDeploy DeleteHost

This API is used to delete a host from a host cluster by ID.

Go debug

Cloning Hosts to the Target Host Cluster in Batches

hcloud CodeArtsDeploy CopyHostsToTarget

This API is used to clone hosts to the target host cluster in batches.

Go debug

Deleting Hosts from a Host Cluster in Batches

hcloud CodeArtsDeploy BatchDeleteHosts

This API is used to delete hosts from a host cluster in batches.

Go debug

Obtain Application List

hcloud CodeArtsDeploy ListDeployTasks

Querying the application list in a project. This interface will no longer be maintained after September 30, 2024. You are advised to use the ListAllApp interface of the new version.

Go debug

Customizing a Template to Create an Application

hcloud CodeArtsDeploy CreateDeployTaskByTemplate

Customizes a template to create an application. This interface will no longer be maintained after September 30, 2024. You are advised to use the CreateApp interface of the new version.

Go debug

Deploying an Application

hcloud CodeArtsDeploy StartDeployTask

Deploys an application based on the deployment task ID.

Go debug

Obtaining Application Details

hcloud CodeArtsDeploy ShowDeployTaskDetail

Obtains application details based on the deployment task ID. This interface will no longer be maintained after September 30, 2024. You are advised to use the ShowAppDetailById interface of the new version.

Go debug

Deleting an Application

hcloud CodeArtsDeploy DeleteDeployTask

Deletes an application based on the deployment task ID. This interface will no longer be maintained after September 30, 2024. You are advised to use the DeleteApplication interface of the new version.

Go debug

Querying Historical Execution Records

hcloud CodeArtsDeploy ListDeployTaskHistoryByDate

Queries the historical execution records of a specified task in a project based on the start time and end time.

Go debug

Querying the Application List in a Project

hcloud CodeArtsDeploy ListAllApp

Querying the Application List in a Project.

Go debug

Create an application.

hcloud CodeArtsDeploy CreateApp

Create an application.

Go debug

Update an application.

hcloud CodeArtsDeploy UpdateAppInfo

This API is used to update an application.

Go debug

Query application detail

hcloud CodeArtsDeploy ShowAppDetailById

Query application detail by application ID.

Go debug

Deleting an application

hcloud CodeArtsDeploy DeleteApplication

Deleting an application by application ID.

Go debug

Querying execution parameters of a deployment record

hcloud CodeArtsDeploy ShowExecutionParams

Querying execution parameters of a deployment record.

Go debug

Cloning an Application

hcloud CodeArtsDeploy CopyApplication

This API is used to clone an application.

Go debug

Deleting Applications from a Project in Batches

hcloud CodeArtsDeploy BatchDeleteApp

This API is used to delete applications from a project in batches.

Go debug

Checking Whether an Application with the Same Name Exists in a Project

hcloud CodeArtsDeploy CheckIsDuplicateAppName

This API is used to check whether an application with the same name exists in a project.

Go debug

Disabling and Enabling an Application

hcloud CodeArtsDeploy UpdateAppDisableStatus

This API is used to disable or enable an application.

Go debug

Querying a Group List

hcloud CodeArtsDeploy ListAppGroups

This API is used to query a group list.

Go debug

Creating a Group

hcloud CodeArtsDeploy CreateAppGroups

This API is used to create a group.

Go debug

Modifying a Group

hcloud CodeArtsDeploy UpdateAppGroups

This API is used to modify a group.

Go debug

Deleting a Group

hcloud CodeArtsDeploy DeleteAppGroups

This API is used to delete a group.

Go debug

Moving a Group

hcloud CodeArtsDeploy MoveAppGroups

This API is used to move a group up or down to adjust the position of the group on the page.

Go debug

Moving an Application to a Specified Group

hcloud CodeArtsDeploy MoveAppToGroup

This API is used to move applications to a specified group (batch operations are supported).

Go debug

Querying the Instance-Level/Project-Level Permission Matrix of an Application

hcloud CodeArtsDeploy ListApplicationPermissions

This API is used to query the instance-level or project-level permission matrix of an application. If app_id is transferred, the instance-level permission matrix is queried. If project_id is transferred while app_id is not transferred, the project-level permission matrix is queried.

Go debug

Modifying Application Permissions in Batches

hcloud CodeArtsDeploy BatchUpdateApplicationPermissions

This API is used to modify application permissions in batches.

Go debug

Configuring Authentication Levels for Applications in Batches

hcloud CodeArtsDeploy BatchUpdatePermissionLevel

This API is used to configure the authentication level to project-level or instance-level for applications in batches.

Go debug

Checking whether the current user has the permission to create applications in a project.

hcloud CodeArtsDeploy CheckCanCreate

This API is used to check whether the current user has the permission to create applications in a project.

Go debug

Obtaining the Application Deployment Success Rate

hcloud CodeArtsDeploy ShowProjectSuccessRate

Obtains the application deployment success rate of a specified project.

Go debug

Obtaining the Application Deployment Success Rate

hcloud CodeArtsDeploy ListTaskSuccessRate

Obtains the application deployment success rate of a specified application.

Go debug

Creating an Environment in an Application

hcloud CodeArtsDeploy CreateEnvironment

Creating an Environment in an Application.

Go debug

Querying the Environment List of an Application

hcloud CodeArtsDeploy ListEnvironments

Querying the Environment List of an Application.

Go debug

Editing an Environment in an Application

hcloud CodeArtsDeploy UpdateEnvironment

This API is used to edit an environment in an application.

Go debug

Deleting an Environment from an Application

hcloud CodeArtsDeploy DeleteEnvironment

Deleting an Environment from an Application.

Go debug

Querying environment details

hcloud CodeArtsDeploy ShowEnvironmentDetail

Querying environment details.

Go debug

Importing Hosts to an Environment

hcloud CodeArtsDeploy ImportHostToEnvironment

Importing Hosts to an Environment.

Go debug

Deleting a Host From Environment

hcloud CodeArtsDeploy DeleteHostFromEnvironment

Deleting a Host From Environment.

Go debug

Querying a Host List in an Environment

hcloud CodeArtsDeploy ListEnvironmentHosts

This API is used to query a host list in an environment.

Go debug

Querying the Host Cluster Permission Matrix

hcloud CodeArtsDeploy ListHostGroupPermissions

This API is used to query the permission matrix of a host cluster by ID.

Go debug

Modifying the Host Cluster Permission Matrix

hcloud CodeArtsDeploy UpdateHostGroupPermissions

This API is used to modify the permission matrix of a host cluster by ID.

Go debug

Checking Whether the Current User Has Permissions to Create a Host Cluster in a Project

hcloud CodeArtsDeploy CheckWhetherHostGroupCanBeCreated

This API is used to check whether the current user has permissions to create a host cluster in a project.

Go debug

Querying Environment Permissions

hcloud CodeArtsDeploy ListEnvironmentPermissions

This API is used to query environment permissions.

Go debug

Editing Environment Permission

hcloud CodeArtsDeploy UpdateEnvironmentPermission

This API is used to edit the environment permission.

Go debug