CLI Command Reference (V2)
VPC
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying VPCs | hcloud VPC ListVpcs/v2 | This API is used to query VPCs. | |
| Creating a VPC | hcloud VPC CreateVpc/v2 | This API is used to create a VPC. | |
| Querying VPC Details | hcloud VPC ShowVpc/v2 | This API is used to query details about a VPC. | |
| Updating VPC Information | hcloud VPC UpdateVpc/v2 | This API is used to update information about a VPC. | |
| Deleting a VPC | hcloud VPC DeleteVpc/v2 | This API is used to delete a VPC. |
Private IP Address
| API Name | Command | Description | Operation |
|---|---|---|---|
| Assigning a Private IP Address | hcloud VPC CreatePrivateip/v2 | This API is used to assign a private IP address. | |
| Querying a Private IP Address | hcloud VPC ShowPrivateip/v2 | This API is used to query a private IP address using a specified ID. | |
| Deleting a Private IP Address | hcloud VPC DeletePrivateip/v2 | This API is used to delete a private IP address. | |
| Querying Private IP Addresses | hcloud VPC ListPrivateips/v2 | This API is used to query private IP addresses. |
Quota
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Quotas | hcloud VPC ShowQuota/v2 | Query network resource quotas of a tenant. The network resources include VPCs, subnets, security groups, security group rules, EIPs, and VPNs. |
Subnet
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Subnets | hcloud VPC ListSubnets/v2 | This API is used to query subnets. | |
| Creating a Subnet | hcloud VPC CreateSubnet/v2 | This API is used to create a subnet. | |
| Querying Subnet Details | hcloud VPC ShowSubnet/v2 | This API is used to query details about a subnet. | |
| Updating a Subnet | hcloud VPC UpdateSubnet/v2 | This API is used to update a subnet. | |
| Deleting a Subnet | hcloud VPC DeleteSubnet/v2 | This API is used to delete a subnet. |
Port
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Ports | hcloud VPC ListPorts/v2 | This API can be used to query all ports accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query. | |
| Creating a Port | hcloud VPC CreatePort/v2 | This API is used to create a port. | |
| Querying Port Details | hcloud VPC ShowPort/v2 | This API is used to query details about a port. | |
| Updating a Port | hcloud VPC UpdatePort/v2 | This API is used to update a port. | |
| Deleting a Port | hcloud VPC DeletePort/v2 | This API is used to delete a port. |
Security Group
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Security Groups | hcloud VPC ListSecurityGroups/v2 | This API is used to query security groups. | |
| Creating a Security Group | hcloud VPC CreateSecurityGroup/v2 | This API is used to create a security group. | |
| Querying Security Group Details | hcloud VPC ShowSecurityGroup/v2 | This API is used to query details about a security group. | |
| Deleting a Security Group | hcloud VPC DeleteSecurityGroup/v2 | This API is used to delete a security group. | |
| Querying Security Group Rules | hcloud VPC ListSecurityGroupRules/v2 | This API is used to query security group rules. | |
| Creating a Security Group Rule | hcloud VPC CreateSecurityGroupRule/v2 | This API is used to create a security group rule. | |
| Querying Security Group Rule Details | hcloud VPC ShowSecurityGroupRule/v2 | This API is used to query details about a security group rule. | |
| Deleting a Security Group Rule | hcloud VPC DeleteSecurityGroupRule/v2 | This API is used to delete a security group rule. |
Querying IP Address Usage
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying IP Address Usage | hcloud VPC ShowNetworkIpAvailabilities/v2 | This API is used to query the IPv4 address usage on a specified network. |
VPC Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying VPCs by Tag | hcloud VPC ListVpcsByTags/v2 | This API is used to query VPCs by tag. | |
| Querying VPC Tags in a Specified Project | hcloud VPC ListVpcTags/v2 | This API is used to query all VPC tags of a tenant in a specified region. | |
| Querying VPC Tags | hcloud VPC ShowVpcTags/v2 | This API is used to query tags of a specified VPC. | |
| Creating a Tag for a VPC | hcloud VPC CreateVpcResourceTag/v2 | This API is used to create a tag for a VPC. | |
| Batch Creating Tags for a VPC | hcloud VPC BatchCreateVpcTags/v2 | This API is used to add multiple tags to a VPC at a time. | |
| Batch Deleting Tags for a VPC | hcloud VPC BatchDeleteVpcTags/v2 | This API is used to delete multiple tags from a VPC at a time. | |
| Deleting a VPC Tag | hcloud VPC DeleteVpcTag/v2 | This API is used to delete a VPC tag. |
Subnet Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Subnets by Tag | hcloud VPC ListSubnetsByTags/v2 | This API is used to query subnets by tag. | |
| Querying Subnet Tags in a Specified Project | hcloud VPC ListSubnetTags/v2 | This API is used to query all subnet tags of a tenant in a specified region. | |
| Querying Subnet Tags | hcloud VPC ShowSubnetTags/v2 | This API is used to query tags of a specified subnet. | |
| Creating a Tag for a Subnet | hcloud VPC CreateSubnetTag/v2 | This API is used to create a tag for a subnet. | |
| Batch Deleting Tags for a Subnet | hcloud VPC BatchDeleteSubnetTags/v2 | This API is used to delete multiple tags from a subnet at a time. | |
| Batch Creating Tags for a Subnet | hcloud VPC BatchCreateSubnetTags/v2 | This API is used to add multiple tags to a subnet at a time. | |
| Deleting a Subnet Tag | hcloud VPC DeleteSubnetTag/v2 | This API is used to delete a subnet tag. |
Security Group Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Security Groups by Tag | hcloud VPC ListSecurityGroupsByTags/v2 | This API is used to query security group by tag. | |
| Querying Security Group Tags in a Specified Project | hcloud VPC ListSecurityGroupTags/v2 | This API is used to query all security group tags of a tenant in a specified region. | |
| Querying SecurityGroup Tags | hcloud VPC ShowSecurityGroupTags/v2 | This API is used to query tags of a specified security group. | |
| Creating a Tag for a Security Group | hcloud VPC CreateSecurityGroupTag/v2 | This API is used to create a tag for a security group. | |
| Batch Deleting Tags for a Security Group | hcloud VPC BatchDeleteSecurityGroupTags/v2 | This API is used to delete multiple tags from a security group at a time. | |
| Batch Creating Tags for a Security Group | hcloud VPC BatchCreateSecurityGroupTags/v2 | This API is used to add multiple tags to a security group at a time. | |
| Deleting a Security Group Tag | hcloud VPC DeleteSecurityGroupTag/v2 | This API is used to delete a security group tag. |
Route Table
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Route Tables | hcloud VPC ListRouteTables/v2 | This API is used to query all route tables of the tenant submitting the request. The route tables are filtered based on the filtering condition. | |
| Creating a Route Table | hcloud VPC CreateRouteTable/v2 | This API is used to create a route table. | |
| Querying Route Table Details | hcloud VPC ShowRouteTable/v2 | This API is used to query details about a route table. | |
| Updating a Route Table | hcloud VPC UpdateRouteTable/v2 | This API is used to update a route table, including its name, description, and adding, updating, and deleting routes. | |
| Deleting a Route Table | hcloud VPC DeleteRouteTable/v2 | This API is used to delete a custom route table. | |
| Associating a Subnet with a Route Table | hcloud VPC AssociateRouteTable/v2 | This API is used to associate a subnet with a route table. If a subnet has already been associated with route table A, you can associate the subnet with route table B directly without disassociating it from route table A first. | |
| Disassociating a Subnet from a Route Table | hcloud VPC DisassociateRouteTable/v2 | This API is used to disassociate subnets from a route table. |
VPC Flow Log
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying VPC Flow Logs | hcloud VPC ListFlowLogs/v2 | This API is used to query all VPC flow logs of the tenant submitting the request. The VPC flow logs are filtered based on the filtering condition. | |
| Creating a VPC Flow Log | hcloud VPC CreateFlowLog/v2 | This API is used to create a flow log. | |
| Querying VPC Flow Log Details | hcloud VPC ShowFlowLog/v2 | This API is used to query details about a VPC flow log. | |
| Updating a VPC Flow Log | hcloud VPC UpdateFlowLog/v2 | This API is used to update a VPC flow log. | |
| Deleting a VPC Flow Log | hcloud VPC DeleteFlowLog/v2 | This API is used to delete a VPC flow log. |
OpenStack - API Version
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying All API Versions | hcloud VPC ListApiVersion/v2 | This API is used to query all available versions of a native OpenStack API. |
OpenStack - Router
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Routers | hcloud VPC NeutronListRouters/v2 | This API is used to query all routers accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query operation. If the number of records exceeds 2000, the pagination marker will be returned. | |
| Creating a Router | hcloud VPC NeutronCreateRouter/v2 | This API is used to create a router. | |
| Querying Router Details | hcloud VPC NeutronShowRouter/v2 | This API is used to query details about a router. | |
| Updating a Router | hcloud VPC NeutronUpdateRouter/v2 | This API is used to update a router. | |
| Deleting a Router | hcloud VPC NeutronDeleteRouter/v2 | This API is used to delete a router. | |
| Adding an Interface to a Router | hcloud VPC NeutronAddRouterInterface/v2 | This API is used to add an interface to a router. | |
| Removing an Interface from a Router | hcloud VPC NeutronRemoveRouterInterface/v2 | This API is used to remove an interface from a router. |
OpenStack - Security Group
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Security Groups | hcloud VPC NeutronListSecurityGroups/v2 | This API is used to query all security groups accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query operation. If the number of records exceeds 2000, the pagination marker will be returned. For details, see section Pagination. | |
| Creating a Security Group | hcloud VPC NeutronCreateSecurityGroup/v2 | This API is used to create a security group. | |
| Querying Security Group Details | hcloud VPC NeutronShowSecurityGroup/v2 | This API is used to query details about a security group. | |
| Updating a Security Group | hcloud VPC NeutronUpdateSecurityGroup/v2 | This API is used to update a security group. | |
| Deleting a Security Group | hcloud VPC NeutronDeleteSecurityGroup/v2 | This API is used to delete a security group. | |
| Querying Security Group Rules | hcloud VPC NeutronListSecurityGroupRules/v2 | This API is used to query all security group rules accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query. If the number of records exceeds 2000, the pagination marker will be returned. For details, see section Pagination. | |
| Creating a Security Group Rule | hcloud VPC NeutronCreateSecurityGroupRule/v2 | This API is used to create a security group rule. | |
| Querying Security Group Rule Details | hcloud VPC NeutronShowSecurityGroupRule/v2 | This API is used to query details about a security group rule. | |
| Deleting a Security Group Rule | hcloud VPC NeutronDeleteSecurityGroupRule/v2 | This API is used to delete a security group rule. |
VPC Route
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying VPC Routes | hcloud VPC ListVpcRoutes/v2 | This API is used to query all routes of the tenant submitting the request. The routes are filtered based on the filtering criteria. | |
| Creating a VPC Route | hcloud VPC CreateVpcRoute/v2 | This API is used to create a route. | |
| Querying VPC Route Details | hcloud VPC ShowVpcRoute/v2 | This API is used to query details about a route. | |
| Deleting a Route | hcloud VPC DeleteVpcRoute/v2 | This API is used to delete a route. |
VPC Peering Connection
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying VPC Peering Connections | hcloud VPC ListVpcPeerings/v2 | This API is used to query all VPC peering connections accessible to the tenant submitting the request. The connections are filtered based on the filtering criteria. | |
| Creating a VPC Peering Connection | hcloud VPC CreateVpcPeering/v2 | This API is used to create a VPC peering connection. | |
| Querying VPC Peering Connection Details | hcloud VPC ShowVpcPeering/v2 | This API is used to query details about a VPC peering connection. | |
| Updating a VPC peering connection | hcloud VPC UpdateVpcPeering/v2 | This API is used to update a VPC peering connection. | |
| Deleting a VPC Peering Connection | hcloud VPC DeleteVpcPeering/v2 | This API is used to delete a VPC peering connection. | |
| Accepting a VPC Peering Connection | hcloud VPC AcceptVpcPeering/v2 | After tenant A requests to create a VPC peering connection with a VPC of tenant B, the VPC peering connection takes effect only after tenant B accepts the request. This API is used by a tenant to accept a VPC peering connection request initiated by another tenant. | |
| Rejecting a VPC Peering Connection | hcloud VPC RejectVpcPeering/v2 | After tenant A requests to create a VPC peering connection with a VPC of tenant B, the VPC peering connection takes effect only after tenant B accepts the request. This API is used by a tenant to reject a VPC peering connection request initiated by another tenant. |
OpenStack-Port
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Ports | hcloud VPC NeutronListPorts/v2 | This API is used to query all ports accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query operation. If the number of records exceeds 2000, the pagination marker will be returned. For details, see section Pagination. | |
| Creating a Port | hcloud VPC NeutronCreatePort/v2 | This API is used to create a port. | |
| Querying Port Details | hcloud VPC NeutronShowPort/v2 | This API is used to query details about a port. | |
| Updating a Port | hcloud VPC NeutronUpdatePort/v2 | This API is used to update a port. | |
| Deleting a Port | hcloud VPC NeutronDeletePort/v2 | This API is used to delete a port. |
OpenStack-Network
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Networks | hcloud VPC NeutronListNetworks/v2 | This API is used to query all networks accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query operation. If the number of records exceeds 2000, the pagination marker will be returned. For details, see section Pagination. | |
| Creating a Network | hcloud VPC NeutronCreateNetwork/v2 | This API is used to create a network. | |
| Querying Network Details | hcloud VPC NeutronShowNetwork/v2 | This API is used to query details about a network. | |
| Updating a Network | hcloud VPC NeutronUpdateNetwork/v2 | This API is used to update a network. | |
| Deleting a Network | hcloud VPC NeutronDeleteNetwork/v2 | This API is used to delete a network. |
OpenStack-Subnet
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Subnets | hcloud VPC NeutronListSubnets/v2 | This API is used to query all subnets accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query operation. If the number of records exceeds 2000, the pagination marker will be returned. For details, see section Pagination. | |
| Creating a Subnet | hcloud VPC NeutronCreateSubnet/v2 | This API is used to create a subnet. | |
| Querying Subnet Details | hcloud VPC NeutronShowSubnet/v2 | This API is used to query details about a subnet. | |
| Updating a Subnet | hcloud VPC NeutronUpdateSubnet/v2 | This API is used to update a subnet. | |
| Deleting a Subnet | hcloud VPC NeutronDeleteSubnet/v2 | This API is used to delete a subnet. |
OpenStack-Network ACL
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Network ACLs | hcloud VPC NeutronListFirewallGroups/v2 | This API is used to query all network ACLs accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query. If the number of records exceeds 2000, the pagination marker will be returned. | |
| Creating a Network ACL | hcloud VPC NeutronCreateFirewallGroup/v2 | This API is used to create a network ACL. | |
| Removing a Network ACL Rule | hcloud VPC NeutronRemoveFirewallRule/v2 | This interface is used to remove a network ACL rule from a network ACL policy. | |
| Querying Network ACL Rules | hcloud VPC NeutronListFirewallRules/v2 | This API is used to query all network ACL rules accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query. If the number of records exceeds 2000, the pagination marker will be returned. | |
| Creating a Network ACL Rule | hcloud VPC NeutronCreateFirewallRule/v2 | This API is used to create a network ACL rule. | |
| Querying a Specific Network ACL Rule | hcloud VPC NeutronShowFirewallRule/v2 | This API is used to query a specific network ACL rule. | |
| Updating a Network ACL Rule | hcloud VPC NeutronUpdateFirewallRule/v2 | This API is used to update a network ACL rule. | |
| Deleting a Network ACL Rule | hcloud VPC NeutronDeleteFirewallRule/v2 | This API is used to delete a network ACL rule. | |
| Querying Details About a Specific Network ACL | hcloud VPC NeutronShowFirewallGroup/v2 | This API is used to query details about a specific network ACL. | |
| Updating a Network ACL | hcloud VPC NeutronUpdateFirewallGroup/v2 | This API is used to update a network ACL. | |
| Deleting a Network ACL | hcloud VPC NeutronDeleteFirewallGroup/v2 | This API is used to delete a network ACL. | |
| Querying Details About a Specific Network ACL Policy | hcloud VPC NeutronShowFirewallPolicy/v2 | This API is used to query details about a specific network ACL policy. | |
| Updating a Network ACL Policy | hcloud VPC NeutronUpdateFirewallPolicy/v2 | This API is used to update a network ACL policy. | |
| Deleting a Network ACL Policy | hcloud VPC NeutronDeleteFirewallPolicy/v2 | This API is used to delete a network ACL policy. | |
| Querying Network ACL Policies | hcloud VPC NeutronListFirewallPolicies/v2 | This API is used to query all network ACL policies accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query. If the number of records exceeds 2000, the pagination marker will be returned. | |
| Creating a Network ACL Policy | hcloud VPC NeutronCreateFirewallPolicy/v2 | This API is used to create a network ACL policy. | |
| Inserting a Network ACL Rule | hcloud VPC NeutronAddFirewallRule/v2 | This API is used to insert a network ACL rule to a network ACL policy. |
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
