CLI Command Reference (V3)

Querying API Versions

hcloud ELB ListApiVersions/v3

This API is used to query all available ELB API versions. Generally, APIs of a later version (v3 is the latest version) support more features than those of an earlier version.

Go debug

Upgrading a Load Balancer

hcloud ELB UpgradeLoadbalancer/v3

This API is used to upgrade a shared load balancer to a dedicated load balancer. Shared load balancers can be upgraded to dedicated load balancers, but dedicated load balancers cannot be downgraded to shared load balancers.

Go debug

Creating a Load Balancer

hcloud ELB CreateLoadBalancer/v3

[This API is used to create a dedicated load balancer.

Go debug

Querying Load Balancers

hcloud ELB ListLoadBalancers/v3

This API is used to query all load balancers.

Go debug

Batch Creating Load Balancers

hcloud ELB BatchCreateLoadBalancers/v3

This API is used to create pay-per-use or yearly/monthly load balancers in batches.

Go debug

Batch Deleting Load Balancers

hcloud ELB BatchDeleteLoadbalancers/v3

This API is used to batch delete load balancers.

Go debug

Viewing the Details of a Load Balancer

hcloud ELB ShowLoadBalancer/v3

This API is used to view the details of a load balancer.

Go debug

Updating a Load Balancer

hcloud ELB UpdateLoadBalancer/v3

This API is used to update a load balancer.

Go debug

Deleting a Load Balancer

hcloud ELB DeleteLoadBalancer/v3

This API is used to delete a load balancer.

Go debug

Querying the Status Tree of a Load Balancer

hcloud ELB ShowLoadBalancerStatus/v3

This API is used to query the status tree of a load balancer and to show information about all resources associated with the load balancer.

Go debug

Querying the Topology of a Load Balancer

hcloud ELB ShowLoadBalancerTopology/v3

This API is used to query the topology of a load balancer. The topology includes the load balancer and its listeners and backend server groups.

Go debug

Querying the IP Addresses Used by a Load Balancer to Forward Internal Requests

hcloud ELB ShowLoadBalancerPorts/v3

This API is used to query the IP addresses used by a load balancer to forward requests within a private network.

Go debug

Deploying a Load Balancer in Additional AZs

hcloud ELB BatchAddAvailableZones/v3

This API is used to deploy a load balancer in additional AZs.

Go debug

Removing a Load Balancer from AZs

hcloud ELB BatchRemoveAvailableZones/v3

This API is used to remove a load balancer from one or more AZs where it is working.

Go debug

Deleting a Load Balancer and Its Associated Resources

hcloud ELB DeleteLoadBalancerForce/v3

This API is used to delete a load balancer and its associated resources, including the listeners, backend server groups, and backend servers.

Go debug

Deleting a Load Balancer and Its Associated Resources (Including EIPs)

hcloud ELB DeleteLoadBalancerCascade/v3

This API is used to delete a load balancer and its associated resources, including the listeners, backend server groups, backend servers, and EIPs.

Go debug

Copying a Load Balancer

hcloud ELB CloneLoadbalancer/v3

This API is used to copy a load balancer.

Go debug

Configuring User-defined Domain Name Resolution for a Load Balancer

hcloud ELB UpdateUserDefinedDomainConfig/v3

This API is used to configure user-defined domain name resolution for a load balancer.

Go debug

Configuring System-defined Domain Name Resolution for a Load Balancer

hcloud ELB UpdateSystemDefaultDomainConfig/v3

This API is used to configure system-defined domain name resolution for a load balancer.

Go debug

Enabling Domain Name Resolution for IP Addresses

hcloud ELB BatchEnableDomainIPs/v3

This API is used to enable domain name resolution for IP addresses.

Go debug

Disabling Domain Name Resolution for IP Addresses

hcloud ELB BatchDisableDomainIPs/v3

This API is used to disable domain name resolution for IP addresses.

Go debug

Querying the Domain Name Resolution Information of a Load Balancer

hcloud ELB ListDomainIPs/v3

This API is used to query the domain name resolution configuration of all IP addresses of a load balancer. This includes whether the IP addresses of the load balancer are mapped to domain names and their corresponding domain names.

Go debug

Creating a Custom Security Policy

hcloud ELB CreateSecurityPolicy/v3

This API is used to create a custom security policy. If you need a custom security policy, you need to specify **security_policy_id** when you add an HTTPS or TLS listener to your load balancer.

Go debug

Querying Custom Security Policies

hcloud ELB ListSecurityPolicies/v3

This API is used to query custom security policies.

Go debug

Querying the Details of a Custom Security Policy

hcloud ELB ShowSecurityPolicy/v3

This API is used to query the details of a custom security policy.

Go debug

Updating a Custom Security Policy

hcloud ELB UpdateSecurityPolicy/v3

This API is used to update a custom security policy.

Go debug

Deleting a Custom Security Policy

hcloud ELB DeleteSecurityPolicy/v3

This API is used to delete a custom security policy.

Go debug

Querying System Security Policies

hcloud ELB ListSystemSecurityPolicies/v3

This API is used to query system security policies.

Go debug

Querying Quotas

hcloud ELB ShowQuota/v3

This API is used to query the quotas of load balancers and related resources in a specific project. The API returns only the total quota, not the used quota. To query the used quota, you can call the API (GET /v3/{project_id}/elb/quotas/details) to query quota usage details.

Go debug

Querying Quota Usage

hcloud ELB ListQuotaDetails/v3

This API is used to query the current and used quotas of resources related to a load balancer.

Go debug

Querying AZs

hcloud ELB ListAvailabilityZones/v3

This API is used to query all available AZs when you create a load balancer.

Go debug

Querying Flavors

hcloud ELB ListFlavors/v3

This API is used to query all available load balancer flavors in a specific region. You can specify these Layer 4 or Layer 7 flavors when creating a dedicated load balancer.

Go debug

Viewing the Details of a Flavor

hcloud ELB ShowFlavor/v3

This API is used to view the details of a flavor.

Go debug

Calculating the Number of Reserved IP Addresses

hcloud ELB CountPreoccupyIpNum/v3

This API is used to calculate the number of reserved IP addresses in the following scenarios:

Go debug

Querying Load Balancers in the Recycle Bin

hcloud ELB ListRecycleBinLoadBalancers/v3

This API is used to query load balancers in the recycle bin.

Go debug

Restoring a Load Balancer from the Recycle Bin

hcloud ELB RestoreLoadbalancer/v3

This API is used to restore a load balancer from the recycle bin.

Go debug

Permanently Deleting a Load Balancer from the Recycle Bin

hcloud ELB DeleteRecycleLoadBalancer/v3

This API is used to permanently delete a load balancer from the recycle bin. After the deletion, the load balancer cannot be restored.

Go debug

Querying the Recycle Bin Policy

hcloud ELB ShowRecycleBin/v3

This API is used to query the recycle bin policy.

Go debug

Enabling or Disabling Recycle Bin

hcloud ELB UpdateRecycleBinEnable/v3

This API is used to enable or disable recycle bin. Once this option is enabled, deleted load balancers will be kept in the recycle bin. If this option is not enabled, deleted load balancers will be permanently deleted and cannot be restored. Before disabling recycle bin, restore or permanently delete load balancers from the recycle bin.

Go debug

Updating the Recycle Bin Policy

hcloud ELB UpdateRecycleBinPolicy/v3

This API is used to update the recycle bin policy. If recycle bin is not enabled, an error is reported.

Go debug

Creating a Certificate

hcloud ELB CreateCertificate/v3

This API is used to add a certificate for an HTTPS, TLS, or QUIC listener. You can use a certificate from Cloud Certificate & Manager (CCM) or use your own certificate.

Go debug

Querying Certificates

hcloud ELB ListCertificates/v3

This API is used to query the certificates used by the load balancer.

Go debug

Querying the Details of a Certificate

hcloud ELB ShowCertificate/v3

This API is used to query the details of a certificate used by the load balancer.

Go debug

Updating a Certificate

hcloud ELB UpdateCertificate/v3

This API is used to update a certificate used by the load balancer. You can update the certificate content and private key, but not the certificate type.

Go debug

Deleting a Certificate

hcloud ELB DeleteCertificate/v3

This API is used to delete a certificate. If you delete a certificate from CCM, the certificate will only be deleted from the ELB console, but not from the CCM console. To delete a certificate associated with a listener, you need to unbind the certificate from the listener first.

Go debug

Batch Deleting Certificates

hcloud ELB BatchDeleteCertificates/v3

This API is used to batch delete certificates.

Go debug

Enabling or Disabling the Private Key Feature

hcloud ELB CreateCertificatePrivateKeyEcho/v3

This API is used to enable or disable **private_key_echo**. **private_key_echo** defines whether to include **private_key** and **enc_private_key** in the response to each certificate API. If **private_key_echo** is set to **true**, the private key is returned when APIs are called to create a certificate, update a certificate, query the certificate details, and query the certificate list. If **private_key_echo** is set to **false**, the private key is anonymized as ****** and returned. The **private_key_echo** setting applies to the whole tenant project. It is enabled by default.

Go debug

Querying Whether the Private Key Feature Is Enabled

hcloud ELB ShowCertificatePrivateKeyEcho/v3

This API is used to query whether **private_key_echo** is set to **true** or **false**. This parameter defines whether to include **private_key** and **enc_private_key** in the response to each certificate API. If **private_key_echo** is set to **true**, the private key is returned. If set to **false**, the private key is anonymized as ****** and returned. The **private_key_echo** setting applies to the whole tenant project. It is enabled by default.

Go debug

Creating an IP Address Group

hcloud ELB CreateIpGroup/v3

This API is used to create an IP address group. You can associate the IP address group with a listener to control access to this listener.

Go debug

Querying IP Address Groups

hcloud ELB ListIpGroups/v3

This API is used to query IP address groups.

Go debug

Querying the Details of an IP Address Group

hcloud ELB ShowIpGroup/v3

This API is used to view the details of an IP address group.

Go debug

Updating an IP Address Group

hcloud ELB UpdateIpGroup/v3

This API is used to update an IP address group. All IP entries in the IP address group will be overwritten, and those that are not included in the **ip_list** parameter in the request body will be removed.

Go debug

Deleting an IP Address Group

hcloud ELB DeleteIpGroup/v3

This API is used to delete an IP address group. An IP address group that has been associated with a listener cannot be deleted. You need to disassociate the IP address group first.

Go debug

Updating IP Addresses in an IP Address Group

hcloud ELB UpdateIpList/v3

This API is used to add IP addresses to an IP address group, or update the descriptions of existing IP addresses. This API cannot be used to delete IP addresses.

Go debug

Deleting IP Addresses from an IP Address Group

hcloud ELB BatchDeleteIpList/v3

This API is used to delete IP addresses from an IP address group.

Go debug

Querying the Listeners Associated with an IP Address Group

hcloud ELB ShowIpGroupRelatedListeners/v3

This API is used to query the listeners associated with an IP address group.

Go debug

Batch Deleting Listeners

hcloud ELB BatchDeleteListeners/v3

This API is used to batch delete listeners.

Go debug

Adding a Listener

hcloud ELB CreateListener/v3

This API is used to add a listener to a shared or dedicated load balancer.

Go debug

Querying Listeners

hcloud ELB ListListeners/v3

This API is used to query listeners.

Go debug

Viewing the Details of a Listener

hcloud ELB ShowListener/v3

This API is used to view the details of a listener.

Go debug

Updating a Listener

hcloud ELB UpdateListener/v3

This API is used to update a listener.

Go debug

Deleting a Listener

hcloud ELB DeleteListener/v3

This API is used to delete a listener.

Go debug

Deleting a Listener and Its Associated Resources

hcloud ELB DeleteListenerForce/v3

This API is used to delete a listener and its associated resources, including the forwarding policies and backend server groups.

Go debug

Copying a Listener

hcloud ELB CloneListener/v3

This API is used to copy a listener from a load balancer to another in the same VPC.

Go debug

Creating a Backend Server Group

hcloud ELB CreatePool/v3

This API is used to create a backend server group.

Go debug

Querying Backend Server Groups

hcloud ELB ListPools/v3

This API is used to query all backend server groups.

Go debug

Querying the Details of a Backend Server Group

hcloud ELB ShowPool/v3

This API is used to view the details of a backend server group.

Go debug

Updating a Backend Server Group

hcloud ELB UpdatePool/v3

This API is used to update a backend server group.

Go debug

Deleting a Backend Server Group

hcloud ELB DeletePool/v3

This API is used to delete a backend server group.

Go debug

Deleting a Backend Server Group and Associated Resources

hcloud ELB DeletePoolCascade/v3

This API is used to delete a backend server group and associated resources, including backend servers and health checks.

Go debug

Batch Deleting Backend Server Groups

hcloud ELB BatchDeletePools/v3

This API is used to batch delete backend server groups.

Go debug

Creating an Active/Standby Backend Server Group

hcloud ELB CreateMasterSlavePool/v3

This API is used to create an active/standby backend server group.

Go debug

Querying Active/Standby Backend Server Groups

hcloud ELB ListMasterSlavePools/v3

This API is used to query all active/standby backend server groups.

Go debug

Viewing the Details of an Active/Standby Backend Server Group

hcloud ELB ShowMasterSlavePool/v3

This API is used to view the details of an active/standby backend server group.

Go debug

Deleting an Active/Standby Backend Server Group

hcloud ELB DeleteMasterSlavePool/v3

This API is used to delete an active/standby backend server group.

Go debug

Adding a Backend Server

hcloud ELB CreateMember/v3

This API is used to add a backend server.

Go debug

Querying Backend Servers in a Backend Server Group

hcloud ELB ListMembers/v3

This API is used to query all backend servers in a given backend server group.

Go debug

Viewing the Details of a Backend Server

hcloud ELB ShowMember/v3

This API is used to view the details of a backend server.

Go debug

Updating a Backend Server

hcloud ELB UpdateMember/v3

This API is used to update a backend server.

Go debug

Removing a Backend Server

hcloud ELB DeleteMember/v3

This API is used to remove a backend server.

Go debug

Querying Backend Servers in a Project

hcloud ELB ListAllMembers/v3

This API is used to query the backend servers under the current project.

Go debug

Batch Adding Backend Servers

hcloud ELB BatchCreateMembers/v3

This API is used to add backend servers to the specified backend server group in batches. You can add up to 200 backend servers at a time to a backend server group.

Go debug

Batch Removing Backend Servers

hcloud ELB BatchDeleteMembers/v3

This API is used to remove backend servers from the specified backend server group in batches. You can remove up to 200 backend servers at a time from a backend server group.

Go debug

Batch Updating Backend Servers

hcloud ELB BatchUpdateMembers/v3

This API is used to update backend servers in a given backend server group in batches. You can update up to 200 backend servers at a time from a backend server group.

Go debug

Creating a Backend Server Check Task

hcloud ELB CreateMemberHealthCheckJob/v3

This API is used to create a task for checking the configurations, network ACL rules, and security group rules of a backend server.

Go debug

Querying the Results of a Backend Server Check Task

hcloud ELB ShowMemberHealthCheckJob/v3

This API is used to query the results of a backend server check task.

Go debug

Configuring a Health Check

hcloud ELB CreateHealthMonitor/v3

This API is used to configure a health check.

Go debug

Querying Health Checks

hcloud ELB ListHealthMonitors/v3

This API is used to query all health checks.

Go debug

Viewing the Details of a Health Check

hcloud ELB ShowHealthMonitor/v3

This API is used to view the details of a health check.

Go debug

Updating a Health Check

hcloud ELB UpdateHealthMonitor/v3

This API is used to update a health check.

Go debug

Deleting a Health Check

hcloud ELB DeleteHealthMonitor/v3

This API is used to delete a health check.

Go debug

Adding a Forwarding Policy

hcloud ELB CreateL7Policy/v3

This API is used to add a forwarding policy to a listener.

Go debug

Querying Forwarding Policies

hcloud ELB ListL7Policies/v3

This API is used to query all forwarding policies.

Go debug

Querying the Details of a Forwarding Policy

hcloud ELB ShowL7Policy/v3

This API is used to view the details of a forwarding policy.

Go debug

Modifying a Forwarding Policy

hcloud ELB UpdateL7Policy/v3

This API is used to update a forwarding policy.

Go debug

Deleting a Forwarding Policy

hcloud ELB DeleteL7Policy/v3

This API is used to delete a forwarding policy.

Go debug

Batch Modifying Forwarding Policy Priorities

hcloud ELB BatchUpdatePoliciesPriority/v3

This API is used to batch modify the priorities of forwarding policies.

Go debug

Adding a Forwarding Rule

hcloud ELB CreateL7Rule/v3

This API is used to add a forwarding rule.

Go debug

Querying Forwarding Rules

hcloud ELB ListL7Rules/v3

This API is used to query all forwarding rules.

Go debug

Viewing the Details of a Forwarding Rule

hcloud ELB ShowL7Rule/v3

This API is used to view the details of a forwarding rule.

Go debug

Updating a Forwarding Rule

hcloud ELB UpdateL7Rule/v3

This API is used to update a forwarding rule.

Go debug

Deleting a Forwarding Rule

hcloud ELB DeleteL7Rule/v3

This API is used to delete a forwarding rule.

Go debug

Querying Forwarding Rules Under a Project

hcloud ELB ListAllL7Rules/v3

This API is used to query the forwarding rules under a project.

Go debug

Creating a Log

hcloud ELB CreateLogtank/v3

This API is used to create a log.

Go debug

Querying Logs

hcloud ELB ListLogtanks/v3

This API is used to query logs.

Go debug

Viewing the Details of a Log

hcloud ELB ShowLogtank/v3

This API is used to view the details of a log.

Go debug

Updating a Log

hcloud ELB UpdateLogtank/v3

This API is used to update a log.

Go debug

Deleting a Log

hcloud ELB DeleteLogtank/v3

This API is used to delete a log.

Go debug

Querying the Asynchronous Tasks

hcloud ELB ListJobs/v3

This API is used to query the asynchronous tasks like copying or upgrading load balancers.

Go debug

Querying the Status of an Asynchronous Task

hcloud ELB ShowJob/v3

This API is used to query the status of an asynchronous task like copying or upgrading a load balancer.

Go debug

Querying the Feature Configurations of ELB

hcloud ELB ListFeatureConfigs/v3

This API is used to query the feature configurations of ELB of a tenant.

Go debug

Querying the Feature Configurations of a Load Balancer

hcloud ELB ListLoadbalancerFeature/v3

This API is used to query the feature configurations of a load balancer.

Go debug

Batch Adding or Deleting Load Balancer Tags

hcloud ELB ChangeLoadbalancerTags/v3

This API is used to batch add tags to or delete tags from a load balancer.

Go debug

Querying the Tags of All Load Balancers

hcloud ELB ListLoadbalancerTags/v3

This API is used to query the tags of all the load balancers in a specified project.

Go debug

Querying All Tags of a Load Balancer

hcloud ELB ShowLoadbalancerTags/v3

This API is used to query all the tags of a load balancer.

Go debug

Batch Adding or Deleting Listener Tags

hcloud ELB ChangeListenerTags/v3

This API is used to batch add or delete listener tags.

Go debug

Querying the Tags of All Listeners

hcloud ELB ListListenerTags/v3

This API is used to query the tags of all listeners in a project.

Go debug

Querying All Tags of a Listener

hcloud ELB ShowListenerTags/v3

This API is used to query all tags of a listener.

Go debug