CLI Command Reference

Obtaining AZs Where CBH Is Available

hcloud CBH ListAvailableZones

This API is used to query AZs where CBH is available.

Go debug

Obtaining the ECS Resource Quota Required for Creating a CBH Instance

hcloud CBH ShowEcsQuota

Check whether the ECS specifications can be used for the CBH instance in the selected region.

Go debug

Obtaining the CBH Instance Quota

hcloud CBH ShowQuota

This API is used to obtain the CBH instance quota.

Go debug

Querying CBH Instance Specifications

hcloud CBH ListSpecifications

This API is used to query CBH instance specifications.

Go debug

Obtaining the CBH Instance List

hcloud CBH ListInstances

This API is used to obtain the CBH instance list of the current account.

Go debug

Obtaining the Status of a CBH Instance

hcloud CBH ShowInstanceStatus

This API is used to obtain the instance of CBH instances that have not been deleted.

Go debug

Starting a CBH Instance

hcloud CBH StartInstance

This API is used to start a CBH instance.

Go debug

Stopping a CBH Instance

hcloud CBH StopInstance

This API is used to stop a CBH instance.

Go debug

Restarting a CBH Instance

hcloud CBH RebootInstance

This API is used to restart a CBH instance.

Go debug

Upgrading a CBH Instance

hcloud CBH UpgradeInstance

This API is used to upgrade a CBH instance.

Go debug

Log In to a CBH Instance Console as an IAM User

hcloud CBH LoginInstance

This API is used to log in to a CBH instance console as an IAM user.

Go debug

Resetting the admin Password of a CBH Instance

hcloud CBH ResetInstancePassword

This API is used to reset the password of user admin, which is used for logging in to the CBH instance over a web client.

Go debug

Resetting the Login Mode for User Admin for a CBH Instance

hcloud CBH ResetInstanceLoginMethod

This API is used to reset the login mode for user Admin for a CBH instance.

Go debug

Obtaining an O&M URL

hcloud CBH ShowOmUrl

This API is used to obtain an O&M URL.

Go debug

Deleting a Faulty CBH Instance

hcloud CBH DeleteInstance

This API is used to delete a faulty CBH instance.

Go debug

Changing a CBH Instance

hcloud CBH ResizeInstance

This API is used to change a CBH instance.

Go debug

Rolling Back a CBH Instance

hcloud CBH RollbackInstance

This API is used to roll back a CBH instance after an upgrade.

Go debug

Logging In to a CBH Instance Console as User admin

hcloud CBH LoginInstanceAdmin

This API is used to log in to a CBH instance console as user admin.

Go debug

Changing the Type of a Single-Node CBH Instance

hcloud CBH ChangeInstanceType

This API is used to change the type of a single-node CBH instance.

Go debug

Obtaining the Backend Switch Control Information List

hcloud CBH ListSwitchConfigInfo

This API is used to obtain the switch control information list of the current version.

Go debug

Binding an EIP to a CBH Instance

hcloud CBH InstallInstanceEip

This API is used to bind an EIP to a CBH instance.

Go debug

Unbinding an EIP from a CBH Instance

hcloud CBH UninstallInstanceEip

This API is used to unbind an EIP from a CBH instance.

Go debug

Changing the Security Group for a CBH Instance

hcloud CBH UpdateInstanceSecurityGroup

This API is used to change the security group for a CBH instance.

Go debug

Changing the VPC A CBH Instance Belongs To

hcloud CBH SwitchInstanceVpc

This API is used to change the VPC a CBH instance belongs to.

Go debug

Querying Resource Tags of an Account in a Project

hcloud CBH ListTags

This API is used to query the resource tags of an account in a project.

Go debug

Querying the Tag Information of a CBH Instance

hcloud CBH ShowInstanceTags

This API is used to query the tag information of a CBH instance.

Go debug

Counting the Number of Instances with a Specified Tag

hcloud CBH CountInstancesByTag

This API is used to count the number of instances with a specified tag.

Go debug

Querying Instances by Tags

hcloud CBH ListInstancesByTag

This API is used to query instance by tags.

Go debug

Performing Operations on a CBH Instance Tag

hcloud CBH BatchCreateInstanceTag

This API is used to perform operations on a CBH tag.

Go debug

Creating a CBH Instance

hcloud CBH CreateInstance

Creating a CBH Instance

Go debug

Authorizing CBH

hcloud CBH ShowAuthorization

This API is used to authorize CBH.

Go debug

Creating or Canceling an Agency Authorization for CBH.

hcloud CBH RegisterAuthorization

This API is used to create or cancel an agency authorization for CBH.

Go debug

Obtaining the CBH Instance List

hcloud CBH ListCbhInstance

This API is used to query the list of CBH instances.

Go debug

Obtaining the ECS Quota

hcloud CBH ListQuotaStatus

This API is used to obtain the details about the specifications and AZ of the selected ECS so as to determine whether the ECS can be used.

Go debug

Checking CBH Instance Network Connection

hcloud CBH ShowNetworkConfiguration

This API is used to check network connection of a CBH instance.

Go debug

Obtaining the AZ Where CBH Is Deployed

hcloud CBH ShowAvailableZoneInfo

This API is used to obtain AZ where a CBH instance is deployed.

Go debug

Querying CBH Quota

hcloud CBH SearchQuota

This API is used to query CBH quota.

Go debug

Obtaining the IAM Login Instance Link

hcloud CBH LoginCbh

Obtain the login-free link for the current IAM user to log in to the bastion host.

Go debug

Stopping a CBH Instance

hcloud CBH StopCbhInstance

This API is used to stop a CBH instance.

Go debug

Upgrading a CBH Instance

hcloud CBH UpgradeCbhInstance

This API is used to upgrade a CBH instance.

Go debug

Restarting a CBH Instance

hcloud CBH RestartCbhInstance

This API is used to restart a CBH instance.

Go debug

Binding an EIP to a CBH Instance

hcloud CBH InstallCbhEip

This API is used to bind an EIP to a CBH instance.

Go debug

Unbinding an EIP from a CBH Instance

hcloud CBH UninstallCbhEip

This API is used to unbind an EIP from a CBH instance.

Go debug

Changing the Password of the admin User

hcloud CBH ResetPassword

This API is used to change the password of user **admin**.

Go debug

Starting a CBH Instance

hcloud CBH StartCbhInstance

This API is used to start a CBH instance.

Go debug

Configuring MFA for User admin

hcloud CBH ResetLoginMethod

This API is used to configure MFA for user **admin**.

Go debug

Modifying CBH Instance Network Settings

hcloud CBH ChangeInstanceNetwork

This API is used to modify CBH instance network settings.

Go debug

Creating a CBH Instance Subscription Order

hcloud CBH CreateInstanceOrder

This API is used to create a CBH Instance subscription order.

Go debug

Creating a CBH Instance

hcloud CBH CreateCbh

This API is used to create a CBH instance. Before creating a CBH instance subscription order, call this API to create a CBH instance.

Go debug

Creating a CBH Instance Specification Change Order

hcloud CBH ChangeInstanceOrder

This API is used to create a CBH instance specification change order. Before calling this API, call the API for creating a CBH instance. This API is not supported currently.

Go debug