Help Center/ Elastic IP/ CLI Reference/ CLI Command Reference (V2)
Updated on 2026-09-08 GMT+08:00

CLI Command Reference (V2)

Query the Job Status

API Name

Command

Description

Operation

Interface for Querying Job Status

hcloud EIP ShowResourcesJobDetail/v2

Interface for Querying Job Status

Go debug

Bandwidth

API Name

Command

Description

Operation

On-demand subcontracting interface

hcloud EIP ChangeBandwidthToPeriod/v2

Tenant On-demand subcontracting interface

Go debug

Querying a Bandwidth

hcloud EIP ShowBandwidth/v2

Query a bandwidth.

Go debug

Updating a Bandwidth

hcloud EIP UpdateBandwidth/v2

Update a bandwidth.

Go debug

Updating Bandwidths in Batches

hcloud EIP BatchModifyBandwidth/v2

This API is not applicable to batch bandwidth update, shared bandwidth update, and yearly/monthly bandwidth update.

Go debug

Querying Bandwidths

hcloud EIP ListBandwidths/v2

Query bandwidths.

Go debug

Assigning a Shared Bandwidth

hcloud EIP CreateSharedBandwidth/v2

Assign a shared bandwidth.

Go debug

Adding an EIP to a Shared Bandwidth

hcloud EIP AddPublicipsIntoSharedBandwidth/v2

Add an EIP to a shared bandwidth.

Go debug

Updating a Yearly/Monthly Bandwidth

hcloud EIP UpdatePrePaidBandwidth/v2

Update a bandwidth.

Go debug

Deleting a Shared Bandwidth

hcloud EIP DeleteSharedBandwidth/v2

Delete a shared bandwidth.

Go debug

Assigning Shared Bandwidths in Batches

hcloud EIP BatchCreateSharedBandwidths/v2

Assign shared bandwidths in batches.

Go debug

Removing an EIP from a Shared Bandwidth

hcloud EIP RemovePublicipsFromSharedBandwidth/v2

Remove an EIP from a shared bandwidth.

Go debug

EIP

API Name

Command

Description

Operation

On-demand subcontracting interface

hcloud EIP ChangePublicipToPeriod/v2

Tenant on-demand subcontracting API.

Go debug

Querying EIPs

hcloud EIP ListPublicips/v2

Query EIPs.

Go debug

Assigning an EIP

hcloud EIP CreatePublicip/v2

Assign an EIP. Both IPv4 and IPv6 addresses are supported.

Go debug

Querying an EIP

hcloud EIP ShowPublicip/v2

Query a specified EIP.

Go debug

Updating an EIP

hcloud EIP UpdatePublicip/v2

Update an EIP, for example, binding an EIP to a NIC, unbinding an EIP from a NIC, or converting the IP address version.

Go debug

Deleting an EIP

hcloud EIP DeletePublicip/v2

Delete an EIP. An EIP that is bound to a resource cannot be deleted.

Go debug

Assigning a Yearly/Monthly EIP

hcloud EIP CreatePrePaidPublicip/v2

Assign a yearly/monthly EIP.

Go debug

Bandwidth add-on package

API Name

Command

Description

Operation

Querying the Bandwidth Add-on Package List

hcloud EIP ListBandwidthPkg/v2

Queries the bandwidth add-on package list.

Go debug

EIP auxiliary interface

API Name

Command

Description

Operation

Querying the Number of Public IP Addresses

hcloud EIP CountPublicIp/v2

Querying the Number of Public IP Addresses

Go debug

Querying the PublicIp Type

hcloud EIP ShowPublicIpType/v2

Querying the PublicIp Type

Go debug

Querying the Number of PublicIp Instances

hcloud EIP CountPublicIpInstance/v2

Querying the Number of PublicIp Instances

Go debug

Batch Operation on EIPs

API Name

Command

Description

Operation

Creating EIPs in Batches

hcloud EIP BatchCreatePublicips/v2

Creating EIPs in Batches

Go debug

Deleting EIPs in Batches

hcloud EIP BatchDeletePublicIp/v2

Deleting EIPs in Batches

Go debug

Unbinding EIPs in Batches

hcloud EIP BatchDisassociatePublicips/v2

Unbinding EIPs in Batches

Go debug

EIP Tag Management

API Name

Command

Description

Operation

Deleting EIP Tags

hcloud EIP DeletePublicipTag/v2

Delete the tags of a specified EIP. project_id indicates the project ID. publicip_id indicates the EIP ID. key indicates the key of the tag to be deleted.

Go debug

Querying EIPs By Tags

hcloud EIP ListPublicipsByTags/v2

Query EIPs by tags.

Go debug

Querying EIP Tags

hcloud EIP ListPublicipTags/v2

Query all EIP tags of a resource type in a specified region.

Go debug

Querying EIP Tags

hcloud EIP ShowPublicipTags/v2

Query tags of a specified EIP.

Go debug

Creating an EIP Tag

hcloud EIP CreatePublicipTag/v2

Create a tag for an EIP.

Go debug

Creating EIP Tags in Batches

hcloud EIP BatchCreatePublicipTags/v2

Create tags for a specified EIP in batches.

Go debug

Deleting EIP Tags in Batches

hcloud EIP BatchDeletePublicipTags/v2

Delete tags for a specified EIP in batches.

Go debug

Quota

API Name

Command

Description

Operation

Querying Quotas

hcloud EIP ListQuotas/v2

Query quotas.

Go debug

OpenStack - Floating IP Address

API Name

Command

Description

Operation

Querying Floating IP Addresses

hcloud EIP NeutronListFloatingIps/v2

Query all floating IP addresses accessible to the tenant submitting the request.

Go debug

Assigning a Floating IP Address

hcloud EIP NeutronCreateFloatingIp/v2

Use GET /v2.0/networks?router:external=True or run the neutron net-external-list command to obtain the UUID of the external network required for assigning a floating IP address.

Go debug

Querying a Floating IP Address

hcloud EIP NeutronShowFloatingIp/v2

Query details about a specified floating IP address, including the floating IP address status, ID of the router to which the floating IP address belongs, and external network ID of the floating IP address.

Go debug

Updating a Floating IP Address

hcloud EIP NeutronUpdateFloatingIp/v2

Update a floating IP address. During the update, the ID of the floating IP address must be provided in the URL. If port_id is left blank, the floating IP address has been unbound from the port.

Go debug

Releasing a Floating IP Address

hcloud EIP NeutronDeleteFloatingIp/v2

Release a specified floating IP address.

Go debug