CLI Command Reference (V3)
VPC
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying VPCs | hcloud VPC ListVpcs/v3 | This API is used to query VPCs. | |
| Querying Details About a VPC | hcloud VPC ShowVpc/v3 | This API is used to query details about a VPC. | |
| Removing a Secondary CIDR Block from a VPC | hcloud VPC RemoveVpcExtendCidr/v3 | This API is used to remove a secondary CIDR block from a VPC. | |
| Adding a Secondary CIDR Block to a VPC | hcloud VPC AddVpcExtendCidr/v3 | This API is used to add a secondary CIDR block to a VPC. |
IP Address Group
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Details of an IP Address Group | hcloud VPC ShowAddressGroup/v3 | This API is used to query details of an IP address group. | |
| Updating an IP Address Group | hcloud VPC UpdateAddressGroup/v3 | This API is used to update an IP address group. | |
| Deleting an IP Address Group | hcloud VPC DeleteAddressGroup/v3 | This API is used to delete an IP address group. Before deleting an IP address group, ensure that no resource is using this group. | |
| Querying IP Address Groups | hcloud VPC ListAddressGroup/v3 | This API is used to query IP address groups based on filter criteria. | |
| Creating an IP Address Group | hcloud VPC CreateAddressGroup/v3 | This API is used to create an IP address group. | |
| Forcibly Deleting an IP Address Group | hcloud VPC DeleteIpAddressGroupForce/v3 | This API is used to forcibly delete an IP address group. If the IP address group to be deleted has associated security group rules, the IP address group and its associated rules will be deleted together. | |
| Querying Resources Associated with an IP Address Group | hcloud VPC ListAddressGroupsDependency/v3 | This API is used to query the IDs and names of the network ACLs or security groups associated with an IP address group. |
Security Group Rule
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Security Group Rules | hcloud VPC ListSecurityGroupRules/v3 | This API is used to query security group rules. | |
| Creating a Security Group Rule | hcloud VPC CreateSecurityGroupRule/v3 | This API is used to create a security group rule. | |
| Querying Security Group Rule Details | hcloud VPC ShowSecurityGroupRule/v3 | This API is used to query details about a security group rule. | |
| Deleting a Security Group Rule | hcloud VPC DeleteSecurityGroupRule/v3 | This API is used to delete a security group rule. | |
| Batch Creating Security Group Rules | hcloud VPC BatchCreateSecurityGroupRules/v3 | This API is used to batch create security group rules in a specified security group |
Supplementary Network Interface
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Supplementary Network Interfaces | hcloud VPC ListSubNetworkInterfaces/v3 | This API is used to query all supplementary network interfaces of a tenant. A maximum of 2000 records can be returned for each query. | |
| Creating a Supplementary Network Interface | hcloud VPC CreateSubNetworkInterface/v3 | This API is used to create a supplementary network interface. | |
| Batch Creating Supplementary Network Interfaces | hcloud VPC BatchCreateSubNetworkInterface/v3 | This API is used to batch create supplementary network interfaces. | |
| Querying Supplementary Network Interface Details | hcloud VPC ShowSubNetworkInterface/v3 | This API is used to query details about a supplementary network interface. | |
| Updating a Supplementary Network Interface | hcloud VPC UpdateSubNetworkInterface/v3 | This API is used to update a supplementary network interface. | |
| Deleting a Supplementary Network Interface | hcloud VPC DeleteSubNetworkInterface/v3 | This API is used to delete a supplementary network interface. | |
| Querying the Number of Supplementary Network Interfaces | hcloud VPC ShowSubNetworkInterfacesQuantity/v3 | This API is used to query the number of supplementary network interfaces. |
Port
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Ports | hcloud VPC ListPorts/v3 | This API is used to query information about all ports, including the port ID, IP address, and associated cloud service instance. | |
| Querying Details About a Port | hcloud VPC ShowPort/v3 | This API is used to query information about a port, including the port ID, IP address, and associated cloud service instance. | |
| Adding Security Groups to Port | hcloud VPC AddSecurityGroups/v3 | This API is used to add security groups to port | |
| Removing Security Groups from Port | hcloud VPC RemoveSecurityGroups/v3 | This API is used to remove security groups from port |
Security Group
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Security Groups | hcloud VPC ListSecurityGroups/v3 | This API is used to query all security groups of a tenant. | |
| Creating a Security Group | hcloud VPC CreateSecurityGroup/v3 | This API is used to create a security group. | |
| Querying Security Group Details | hcloud VPC ShowSecurityGroup/v3 | This API is used to query details about a security group. | |
| Updating a Security Group | hcloud VPC UpdateSecurityGroup/v3 | This API is used to update a security group. | |
| Deleting a Security Group | hcloud VPC DeleteSecurityGroup/v3 | This API is used to delete a security group. |
Network ACL
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Network ACLs | hcloud VPC ListFirewall/v3 | Querying Network ACLs | |
| Creating a Network ACL | hcloud VPC CreateFirewall/v3 | Creating a Network ACL | |
| Querying Details of a Network ACL | hcloud VPC ShowFirewall/v3 | Querying Details of a Network ACL | |
| Updating a Network ACL | hcloud VPC UpdateFirewall/v3 | Updating a Network ACL | |
| Deleting a Network ACL | hcloud VPC DeleteFirewall/v3 | Deleting a Network ACL | |
| Updating Rules of a Network ACL | hcloud VPC UpdateFirewallRules/v3 | Updating Rules of a Network ACL | |
| Adding Rules to a Network ACL | hcloud VPC AddFirewallRules/v3 | Adding Rules to a Network ACL | |
| Removing Rules from a Network ACL | hcloud VPC RemoveFirewallRules/v3 | Removing Rules from a Network ACL | |
| Associating Subnets to a Network ACL | hcloud VPC AssociateSubnetFirewall/v3 | Associating Subnets to a Network ACL | |
| Disassociating Subnets from a Network ACL | hcloud VPC DisassociateSubnetFirewall/v3 | Disassociating Subnets from a Network ACL |
Traffic Mirror Session
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Traffic Mirror Sessions | hcloud VPC ListTrafficMirrorSessions/v3 | This API is used to query traffic mirror sessions | |
| Creating a Traffic Mirror Session | hcloud VPC CreateTrafficMirrorSession/v3 | This API is used to create a traffic mirror session | |
| Querying Details About a Traffic Mirror Session | hcloud VPC ShowTrafficMirrorSession/v3 | This API is used to query details about a traffic mirror session | |
| Updating a Traffic Mirror Session | hcloud VPC UpdateTrafficMirrorSession/v3 | This API is used to update a traffic mirror session | |
| Deleting a Traffic Mirror Session | hcloud VPC DeleteTrafficMirrorSession/v3 | This API is used to delete a traffic mirror session | |
| Removing a Traffic Mirror Source from a Traffic Mirror Session | hcloud VPC RemoveSourcesFromTrafficMirrorSession/v3 | This API is used to remove a traffic mirror source from a traffic mirror session | |
| Adding a Traffic Mirror Source to a Traffic Mirror Session | hcloud VPC AddSourcesToTrafficMirrorSession/v3 | This API is used to add a traffic mirror source to a traffic mirror session |
Traffic Mirror Filter
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Traffic Mirror Filters | hcloud VPC ListTrafficMirrorFilters/v3 | This API is used to query traffic mirror filters | |
| Creating a Traffic Mirror Filter | hcloud VPC CreateTrafficMirrorFilter/v3 | This API is used to create a traffic mirror filter | |
| Querying Details About a Traffic Mirror Filter | hcloud VPC ShowTrafficMirrorFilter/v3 | This API is used to query details about a traffic mirror filter | |
| Updating a Traffic Mirror Filter | hcloud VPC UpdateTrafficMirrorFilter/v3 | This API is used to update a traffic mirror filter | |
| Deleting a Traffic Mirror Filter | hcloud VPC DeleteTrafficMirrorFilter/v3 | This API is used to delete a traffic mirror filter |
Traffic Mirror Filter Rule
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Traffic Mirror Filter Rules | hcloud VPC ListTrafficMirrorFilterRules/v3 | This API is used to query traffic mirror filter rules | |
| Creating a Traffic Mirror Filter Rule | hcloud VPC CreateTrafficMirrorFilterRule/v3 | This API is used to create a traffic mirror filter rule | |
| Querying Details About a Traffic Mirror Filter Rule | hcloud VPC ShowTrafficMirrorFilterRule/v3 | This API is used to querying details about a traffic mirror filter rule | |
| Updating a Traffic Mirror Filter Rule | hcloud VPC UpdateTrafficMirrorFilterRule/v3 | This API is used to update a traffic mirror filter rule | |
| Deleting a Traffic Mirror Filter Rule | hcloud VPC DeleteTrafficMirrorFilterRule/v3 | This API is used to delete a traffic mirror filter rule |
Port Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Number of Ports Using Tags | hcloud VPC CountPortsByTags/v3 | This API is used to query the number of ports using tags. | |
| Querying Ports Using Tags | hcloud VPC ListPortsByTags/v3 | This API is used to query ports using tags. | |
| Querying Tags of a Port | hcloud VPC ShowPortTags/v3 | This API is used to query tags of a port. | |
| Adding a Tag to a Port | hcloud VPC CreatePortTag/v3 | This API is used to add a tag to a specified port. This is an idempotent API. When you add tags, if there are duplicate keys in the request body, an error is reported. Duplicate keys are not allowed. If a key already exists, its value will be overwritten by the new value. | |
| Querying Tags of Ports in a Project | hcloud VPC ListPortTags/v3 | This API is used to query all tags of ports in a specific project. | |
| Adding Tags to a Port in Batches | hcloud VPC BatchCreatePortTags/v3 | This API is used to add tags to a specified port in batches. This is an idempotent API. When you add tags, if there are duplicate keys in the request body, an error is reported. Duplicate keys are not allowed. If a key already exists, its value will be overwritten by the new value. | |
| Deleting a Tag from a Port | hcloud VPC DeletePortTag/v3 | This API is used to delete a tag from a specified port. This is an idempotent API. The tag key cannot be left blank or be an empty string. If the key of the tag to be deleted does not exist, 404 will be returned. | |
| Deleting Tags from a Port in Batches | hcloud VPC BatchDeletePortTags/v3 | This API is used to delete tags from a specified port in batches. This is an idempotent API. If some tags to be deleted do not exist, the deletion is considered to be successful by default. The character set of the tags will not be checked. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string. |
Virtual Subnets
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Virtual Subnets | hcloud VPC ListVirsubnets/v3 | This API is used to query information about all subnets, including the subnet name and ID. | |
| Querying Details About a Virtual Subnet | hcloud VPC ShowVirsubnet/v3 | This API is used to query details about a subnet, including the subnet name, ID, and status. |
Quotas
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Quotas | hcloud VPC ShowQuota/v3 | This API is used to query the quotas of VPC resources, including security group quotas and security group rule quotas. |
Network ACL Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Number of Network ACLs Using Tags | hcloud VPC CountFirewallsByTags/v3 | This API is used to query the number of network ACLs using tags. | |
| Querying Network ACLs Using Tags | hcloud VPC ListFirewallsByTags/v3 | This API is used to query network ACLs using tags. | |
| Querying Tags of Network ACLs | hcloud VPC ShowFirewallTags/v3 | This API is used to query tags of a specific network ACL. | |
| Adding a Tag to a Network ACL | hcloud VPC CreateFirewallTag/v3 | This API is used to add a tag to a specific network ACL. This is an idempotent API. If the new tag has the same key as an existing tag, the tag will be created and overwrite the existing one. | |
| Querying Tags of Network ACLs in a Project | hcloud VPC ListFirewallTags/v3 | This API is used to query all tags of network ACLs in a specific project. | |
| Adding Tags to a Network ACL in Batches | hcloud VPC BatchCreateFirewallTags/v3 | This API is used to add tags to a specified network ACL in batches. This is an idempotent API. When you add tags, if there are duplicate keys in the request body, an error is reported. Duplicate keys are not allowed. If a key already exists, its value will be overwritten by the new value. | |
| Delete a Tag from a Network ACL | hcloud VPC DeleteFirewallTag/v3 | This API is used to delete a tag from a specified network ACL. This is an idempotent API. The tag key cannot be left blank or be an empty string. If the key of the tag to be deleted does not exist, 404 will be returned. | |
| Deleting Tags from a Network ACL in Batches | hcloud VPC BatchDeleteFirewallTags/v3 | This API is used to delete tags from a specified network ACL in batches. This is an idempotent API. If some tags to be deleted do not exist, the deletion is considered to be successful by default. The character set of the tags will not be checked. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string. |
Subnet CIDR Reservations
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List of Subnet CIDR Reservations | hcloud VPC ListVirsubnetCidrReservations/v3 | This API is used to query information about all subnet CIDR reservations, including the name and CIDR block. | |
| Creating a Subnet CIDR Reservation | hcloud VPC CreateVirsubnetCidrReservation/v3 | A subnet CIDR reservation is an IP address range that you set aside from a subnet CIDR block. IP addresses in the subnet CIDR reservation will not be used by instances in the subnet. You can create a subnet CIDR reservation to reserve an IP address range for special scenarios. | |
| Querying Details About a Subnet CIDR Reservation | hcloud VPC ShowVirsubnetCidrReservation/v3 | This API is used to query details about a subnet CIDR reservation, including the name and CIDR block. | |
| Updating a Subnet CIDR Reservation | hcloud VPC UpdateVirsubnetCidrReservation/v3 | This API is used to update basic information about a subnet CIDR reservation, including the name and description. | |
| Deleting a Subnet CIDR Reservation | hcloud VPC DeleteVirsubnetCidrReservation/v3 | This API is used to delete a subnet CIDR reservation that is no longer required. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
