CLI Command Reference

Listing API Versions

hcloud ECS NovaListVersions

This API is used to list all available Nova versions.

Debug

Querying an API Version

hcloud ECS NovaShowVersion

This API is used to query information about a specified version.

Debug

Creating ECSs

hcloud ECS CreateServers

This API is used to create one or more ECSs.

Debug

Creating ECSs (Pay-per-Use)

hcloud ECS CreatePostPaidServers

This API is used to create one or more pay-per-use ECSs.

Debug

Deleting ECSs

hcloud ECS DeleteServers

This API is used to delete ECSs with specified IDs.

Debug

Querying Details About an ECS

hcloud ECS ShowServer

This API is used to query details about an ECS.

Debug

Modifying an ECS

hcloud ECS UpdateServer

This API is used to modify an ECS, including the ECS name, description, and hostname.

Debug

Listing Details About ECSs

hcloud ECS ListServersDetails

This API is used to filter ECSs from the database based on request conditions and obtain the ECS details.

Debug

Listing ECSs

hcloud ECS ListCloudServers

This API is used to list ECSs.

Debug

Listing ECSs

hcloud ECS NovaListServers

This API is used to list ECSs.

Debug

Creating an ECS

hcloud ECS NovaCreateServers

This API is used to create an ECS.

Debug

Displaying Details About an ECS

hcloud ECS NovaShowServer

This API is used to query details about an ECS based on the ECS ID.

Debug

Modifying an ECS

hcloud ECS NovaUpdateServer

This API is used to modify an ECS. Currently, the ECS name and description can be modified.

Debug

Deleting an ECS

hcloud ECS NovaDeleteServer

This API is used to delete an ECS.

Debug

Listing Details About ECSs

hcloud ECS NovaListServersDetails

This API is used to list details about ECSs.

Debug

Reinstalling an ECS OS (Using an Image with Cloud-Init Installed)

hcloud ECS ReinstallServerWithCloudInit

This API is used to reinstall an ECS OS. During the system disk reinstallation using the original image, the data disks of the ECS remain unchanged.

Debug

Changing an ECS OS (Using an Image Without Cloud-Init Installed)

hcloud ECS ChangeServerOsWithCloudInit

This API is used to change the OS of an ECS. During the system disk reinstallation using a new image, the data disks of the ECS remain unchanged.

Debug

Reinstalling an ECS OS (Using an Image Without Cloud-Init Installed)

hcloud ECS ReinstallServerWithoutCloudInit

This API is used to reinstall an ECS OS.

Debug

Changing an ECS OS (Using an Image Without Cloud-Init Installed)

hcloud ECS ChangeServerOsWithoutCloudInit

This API is used to change the OS of an ECS.

Debug

Cold Migrating an ECS

hcloud ECS MigrateServer

An ECS deployed on a DeH can be migrated to another DeH.

Debug

Obtaining the VNC Login Address

hcloud ECS ShowServerRemoteConsole

This API is used to obtain the address for remotely logging in to an ECS using VNC.

Debug

Modifying the Specifications of an ECS

hcloud ECS ResizeServer

This API is used to modify the specifications of an ECS.

Debug

Modifying the Specifications of an ECS (Pay-per-Use)

hcloud ECS ResizePostPaidServer

You can modify ECS specifications, such as vCPUs and memory, to meet service requirements.

Debug

Changing the ECS Billing Mode

hcloud ECS ChangeServerChargeMode

This API is used to change the ECS billing mode.

Debug

Redeploying an ECS

hcloud ECS ExecuteServerRedeploy

This API is used to redeploy an ECS.

Debug

Starting an ECS

hcloud ECS NovaStartServer

This API is used to start an ECS.

Debug

Restarting an ECS

hcloud ECS NovaRebootServer

This API is used to restart an ECS.

Debug

Stopping an ECS

hcloud ECS NovaStopServer

This API is used to stop an ECS.

Debug

Locking an ECS

hcloud ECS NovaLockServer

This API is used to lock an ECS.

Debug

Unlocking an ECS

hcloud ECS NovaUnlockServer

This API is used to unlock an ECS.

Debug

Adding an ECS to the Monitoring List

hcloud ECS RegisterServerMonitor

This API is used to add an ECS to the monitoring list.

Debug

Triggering an ECS Kernel Dump

hcloud ECS ExecuteServerDump

This API is used to trigger an ECS kernel dump.

Debug

Starting ECSs in a Batch

hcloud ECS BatchStartServers

This API is used to start ECSs in a batch based on the specified ECS IDs. A maximum of 1,000 ECSs can be started at a time.

Debug

Restarting ECSs in a Batch

hcloud ECS BatchRebootServers

This API is used to restart ECSs in a batch based on the specified ECS IDs. A maximum of 1,000 ECSs can be restarted at a time.

Debug

Stopping ECSs in a Batch

hcloud ECS BatchStopServers

This API is used to stop ECSs in a batch based on the specified ECS IDs. A maximum of 1,000 ECSs can be stopped at a time.

Debug

Modifying ECSs in a Batch

hcloud ECS BatchUpdateServersName

This API is used to modify ECSs in a batch.

Debug

Resetting the Passwords for Logging In to ECSs in a Batch

hcloud ECS BatchResetServersPassword

This API is used to reset the passwords of ECS management accounts, root or Administrator, in a batch.

Debug

Attaching a Specified Shared EVS Disk to Multiple ECSs in a Batch

hcloud ECS BatchAttachSharableVolumes

This API is used to attach a specified shared EVS disk to multiple ECSs.

Debug

Modifying Specifications of Multiple ECSs in a Batch

hcloud ECS BatchResizeServers

This API is used to modify specifications of multiple ECSs in a batch.

Debug

Detaching Disks in a Batch

hcloud ECS BatchDetachVolumes

This API is used to detach disks in a batch.

Debug

Adding NICs to an ECS in a Batch

hcloud ECS BatchAddServerNics

This API is used to add one or multiple NICs to an ECS.

Debug

Batch Deleting NICs from an ECS

hcloud ECS BatchDeleteServerNics

This API is used to detach and delete one or multiple NICs from an ECS.

Debug

Updating Attributes of a Specified NIC for an ECS

hcloud ECS ChangeServerNetworkInterface

This API is used to update the attributes of a specified NIC for an ECS. Currently, only the NIC IP address can be updated.

Debug

Binding a Virtual IP Address to an ECS NIC

hcloud ECS AssociateServerVirtualIp

A virtual IP address provides another IP address for one or multiple ECS NICs, improving high availability between the ECSs.

Debug

Unbinding a Virtual IP Address from an ECS NIC

hcloud ECS DisassociateServerVirtualIp

A virtual IP address provides another IP address for one or multiple ECS NICs, improving high availability between the ECSs.

Debug

Listing NICs of an ECS

hcloud ECS ListServerInterfaces

This API is used to list NICs of an ECS.

Debug

Changing a VPC for an ECS

hcloud ECS ChangeVpc

This API is used to change a VPC for an ECS.

Debug

Updating NIC Attachment Information of an ECS

hcloud ECS UpdateServerInterface

This API is used to update NIC attachment information of an ECS.

Debug

Listing NICs of an ECS

hcloud ECS NovaListServerInterfaces

This API is used to list NICs of an ECS.

Debug

Adding a NIC to an ECS

hcloud ECS NovaAttachInterface

This API is used to add a NIC to an ECS.

Debug

Querying Details About an ECS NIC

hcloud ECS NovaShowServerInterface

This API is used to query details about an ECS NIC based on the specified NIC ID.

Debug

Deleting an ECS NIC

hcloud ECS NovaDetachInterface

This API is used to delete a NIC from an ECS based on the specified port ID.

Debug

Querying the NICs That Can Be Attached to an ECS

hcloud ECS ShowServerAttachableNicNum

This API is used to query the NICs that can be attached to an ECS.

Debug

Querying Details About a Single Disk Attached to an ECS

hcloud ECS ShowServerBlockDevice

This API is used to query details about a single disk attached to an ECS.

Debug

Modifying a Single Disk Attached to an ECS

hcloud ECS UpdateServerBlockDevice

This API is used to modify information about a single disk attached to an ECS. Currently, only the delete_on_termination parameter can be modified.

Debug

Listing Disks Attached to an ECS

hcloud ECS ListServerVolumeAttachments

This API is used to list disks attached to an ECS.

Debug

Listing Details About Disks Attached to an ECS

hcloud ECS ListServerBlockDevices

This API is used to list details about disks attached to an ECS.

Debug

Attaching a Disk to an ECS

hcloud ECS AttachServerVolume

This API is used to attach a disk to an ECS.

Debug

Detaching a Disk from an ECS

hcloud ECS DetachServerVolume

This API is used to detach a disk from an ECS.

Debug

Listing Details About Disks Attached to an ECS

hcloud ECS NovaListServerVolumes

This API is used to list details about disks attached to an ECS.

Debug

Attaching an ECS Disk

hcloud ECS NovaAttachVolume

This API is used to attach a disk to an ECS.

Debug

Querying a Disk Attached to an ECS

hcloud ECS NovaShowServerVolume

This API is used to query a disk attached to an ECS based on the disk ID.

Debug

Detaching an ECS Disk

hcloud ECS NovaDetachVolume

This API is used to detach a disk from an ECS.

Debug

Querying the Number of Disks That Can Be Added to a Yearly/Monthly ECS

hcloud ECS ShowAppendableVolumeQuota

This API is used to query the number of disks that can be added to a yearly/monthly ECS.

Debug

Adding a Security Group

hcloud ECS NovaAssociateSecurityGroup

This API is used to add an ECS to a security group.

Debug

Removing a Security Group

hcloud ECS NovaDisassociateSecurityGroup

This API is used to remove an ECS from a security group.

Debug

Listing Security Groups of a Specified ECS

hcloud ECS NovaListServerSecurityGroups

This API is used to list security groups of a specified ECS.

Debug

Listing Flavor Details and Extended Information

hcloud ECS ListFlavors

This API is used to list flavor details and extended information.

Debug

Listing Flavor Sales Policies

hcloud ECS ListFlavorSellPolicies

This API is used to list flavor sales policies.

Debug

Listing Supported Flavor Changes

hcloud ECS ListResizeFlavors

An ECS flavor cannot be changed to certain flavors. This API is used to query the target flavors to which a specified ECS flavor can be changed.

Debug

Listing ECS Flavors

hcloud ECS NovaListFlavors

This API is used to list available ECS flavors.

Debug

Listing Details About ECS Flavors

hcloud ECS NovaListFlavorsDetails

This API is used to list details about ECS flavors.

Debug

Querying Details About an ECS Flavor

hcloud ECS NovaShowFlavor

This API is used to query details about an ECS flavor based on the flavor ID.

Debug

Querying the extra_specs Value for an ECS Flavor

hcloud ECS NovaShowFlavorExtraSpecs

This API is used to query the extra_specs value for a specified ECS flavor.

Debug

Querying the Capacity of a Flavor

hcloud ECS ShowFlavorCapacity

This API is used to query the capacity of a flavor.

Debug

Updating ECS Metadata

hcloud ECS UpdateServerMetadata

This API is used to update ECS metadata.

Debug

Deleting Specified ECS Metadata

hcloud ECS DeleteServerMetadata

This API is used to delete specified ECS metadata.

Debug

Querying ECS Metadata

hcloud ECS NovaShowServerMetadata

This API is used to query ECS metadata.

Debug

Updating ECS Metadata

hcloud ECS NovaUpdateServerMetadata

This API is used to update ECS metadata.

Debug

Configuring ECS Metadata

hcloud ECS NovaCreateServerMetadata

This API is used to configure ECS metadata.

Debug

Obtaining ECS Metadata with a Specified Key

hcloud ECS NovaShowServerMetadataItem

This API is used to obtain ECS metadata with a specified key.

Debug

Modifying ECS Metadata with a Specified Key

hcloud ECS NovaUpdateServerMetadataItem

This API is used to modify ECS metadata with a specified key.

Debug

Deleting Specified ECS Metadata

hcloud ECS NovaDeleteServerMetadataItem

This API is used to delete specified ECS metadata.

Debug

Updating ECS Metadata Configuration

hcloud ECS UpdateMetadataOptions

This API is used to update the metadata configuration of an ECS. You can enable or disable the IMDS service and select the IMDS version.

Debug

Querying ECS Metadata Configuration

hcloud ECS ShowMetadataOptions

This API is used to query the metadata configuration of an ECS.

Debug

Querying Tenant Quotas

hcloud ECS ShowServerLimits

This API is used to query tenant quotas.

Debug

Querying Job Execution Status

hcloud ECS ShowJob

This API is used to query the execution status of a job.

Debug

Adding Tags to an ECS in a Batch

hcloud ECS BatchCreateServerTags

This API is used to add tags to a specified ECS in a batch.

Debug

Deleting Tags from an ECS in a Batch

hcloud ECS BatchDeleteServerTags

This API is used to delete tags from a specified ECS in a batch.

Debug

Querying Project Tags

hcloud ECS ListServerTags

Projects are used to group and isolate OpenStack resources, which include computing, storage, and network resources. A project can be a department or a team. Multiple projects can be created for the same account.

Debug

Querying Tags of an ECS

hcloud ECS ShowServerTags

This API is used to query tags of a specified ECS.

Debug

Querying Whether One-Click Password Reset Is Supported

hcloud ECS ShowResetPasswordFlag

This API is used to query whether an ECS supports one-click password reset.

Debug

Resetting the Password of an ECS with a Few Clicks (Enterprise Project)

hcloud ECS ResetServerPassword

This API is used to reset the password of the ECS management account, root or Administrator.

Debug

Obtaining the Password of an ECS (Enterprise Project)

hcloud ECS ShowServerPassword

This API is used to obtain the random password generated for the Administrator account or the account configured using Cloudbase-Init during initial installation of a Windows ECS created using an image that supports Cloudbase-Init.

Debug

Deleting the Password of an ECS (Enterprise Project)

hcloud ECS DeleteServerPassword

This API is used to delete the password generated during initial installation of a Windows ECS. After a password is deleted, you can still use it to log in to your ECS. However, you cannot use the Get Password function to obtain it.

Debug

Listing SSH Key Pairs

hcloud ECS NovaListKeypairs

This API is used to list SSH key pairs.

Debug

Creating and Importing an SSH Key Pair

hcloud ECS NovaCreateKeypair

This API is used to create an SSH key pair or import a public key to generate a key pair.

Debug

Querying Details About an SSH Key Pair

hcloud ECS NovaShowKeypair

This API is used to query details about a specified SSH key pair based on the key pair name.

Debug

Deleting an SSH Key Pair

hcloud ECS NovaDeleteKeypair

This API is used to delete a specified SSH key pair based on the key pair name.

Debug

Adding ECSs to an ECS Group in a Batch

hcloud ECS BatchAddServerGroupMember

This API is used to add ECSs to an ECS group. ECSs in the same group are automatically deployed on different hosts if possible.

Debug

Removing ECSs from an ECS Group in a Batch

hcloud ECS BatchDeleteServerGroupMember

This API is used to remove ECSs from an ECS group. The anti-affinity policy will not be applied to the ECSs after they are removed from the group.

Debug

Listing ECS Groups

hcloud ECS ListServerGroups

This API is used to list ECS groups.

Debug

Creating an ECS Group

hcloud ECS CreateServerGroup

This API is used to create an ECS group.

Debug

Displaying Details About an ECS Group

hcloud ECS ShowServerGroup

This API is used to query details about an ECS group.

Debug

Deleting an ECS Group

hcloud ECS DeleteServerGroup

This API is used to delete an ECS group.

Debug

Listing ECS Groups

hcloud ECS NovaListServerGroups

This API is used to list ECS groups.

Debug

Creating an ECS Group

hcloud ECS NovaCreateServerGroup

This API is used to create an ECS group.

Debug

Querying Details About an ECS Group

hcloud ECS NovaShowServerGroup

This API is used to query details about an ECS group.

Debug

Deleting an ECS Group

hcloud ECS NovaDeleteServerGroup

This API is used to delete an ECS group.

Debug

Listing ECS Operations

hcloud ECS NovaListServerActions

This API is used to list all historical ECS operations.

Debug

Querying an ECS Operation by Request ID

hcloud ECS NovaShowServerAction

This API is used to query an ECS operation in a request.

Debug

Listing AZs

hcloud ECS ListServerAzInfo

This API is used to list AZs.

Debug

Listing AZs

hcloud ECS NovaListAvailabilityZones

This API is used to list AZs.

Debug

Listing Scheduled Events

hcloud ECS ListScheduledEvents

This API is used to list scheduled events.

Debug

Updating a Scheduled Event

hcloud ECS UpdateScheduledEvent

This API is used to update the execution start time of a scheduled event.

Debug

Accepting and Authorizing the Execution of a Scheduled Event

hcloud ECS AcceptScheduledEvent

When the system reports a system maintenance event, you need to authorize maintenance for ECSs (including bare metal ECSs).

Debug

Querying the Recycle Bin Configuration

hcloud ECS ShowRecycleBin

This API is used to query the recycle bin configuration.

Debug

Updating the Recycle Bin Configuration

hcloud ECS UpdateRecycleBin

This API is used to update the recycle bin configuration.

Debug

Deleting a Server from the Recycle Bin

hcloud ECS DeleteRecycleBinServer

This API is used to delete a server from the recycle bin.

Debug

Listing Servers in the Recycle Bin

hcloud ECS ListRecycleBinServers

This API is used to list servers in the recycle bin.

Debug

Updating the Recycle Bin Policy

hcloud ECS UpdateRecycleBinPolicy

This API is used to update the recycle bin policy.

Debug

Recovering a Server from the Recycle Bin

hcloud ECS RevertRecycleBinServer

This API is used to recover a server from the recycle bin.

Debug

Listing Template Versions

hcloud ECS ListLaunchTemplateVersions

This API is used to filter and list the launch template versions based on the request conditions. You can filter templates by image_id and flavor_id.

Debug

Deleting a Template

hcloud ECS DeleteLaunchTemplates

This API is used to delete a launch template. All versions of the template are deleted.

Debug

Listing Templates

hcloud ECS ListTemplates

This API is used to filter and list launch templates from the database based on the request conditions.

Debug

Creating a Template

hcloud ECS CreateLaunchTemplate

This API is used to create a launch template. The automatically-generated version 1 is the default version.

Debug