CLI Command Reference
Enterprise Routers
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Enterprise Routers | hcloud ER ListEnterpriseRouters | This API is used to query enterprise routers. | |
| Creating an Enterprise Router | hcloud ER CreateEnterpriseRouter | This API is used to create an enterprise router. If both Default Route Table Association and Default Route Table Propagation are enabled, the system will create a route table as both the default association route table and the default propagation route table. | |
| Querying Details About an Enterprise Router | hcloud ER ShowEnterpriseRouter | This API is used to query details about an enterprise router. | |
| Updating an Enterprise Router | hcloud ER UpdateEnterpriseRouter | This API is used to update basic information about the enterprise router. | |
| Deleting an Enterprise Router | hcloud ER DeleteEnterpriseRouter | This API is used to delete an enterprise router. | |
| Changing Enterprise Router AZs | hcloud ER ChangeAvailabilityZone | This API is used to change enterprise router AZs. The AZs can be changed only when the enterprise router is in the available state. |
VPC Attachments
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying VPC Attachments | hcloud ER ListVpcAttachments | This API is used to query the VPC attachments of the enterprise router. | |
| Creating a VPC Attachment | hcloud ER CreateVpcAttachment | This API is used to create a VPC attachment for an enterprise router. | |
| Querying Details About a VPC Attachment | hcloud ER ShowVpcAttachment | This API is used to query details about a VPC attachment. | |
| Updating a VPC Attachment | hcloud ER UpdateVpcAttachment | This API is used to update basic information about a VPC attachment. | |
| Deleting a VPC Attachment | hcloud ER DeleteVpcAttachment | This API is used to delete a VPC attachment. |
Attachments
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Details About an Attachment | hcloud ER ShowAttachment | This API is used to query details about an attachment. | |
| Updating an Attachment | hcloud ER UpdateAttachment | This API is used to update basic information about an attachment. | |
| Querying Attachments | hcloud ER ListAttachments | This API is used to query the attachments of the enterprise router. | |
| Accept creating shared attachment | hcloud ER AcceptAttachment | Accept creating shared attachment | |
| Reject creating shared attachment | hcloud ER RejectAttachment | Reject creating shared attachment |
Route Tables
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Route Tables | hcloud ER ListRouteTables | This API is used to query route tables. | |
| Creating a Route Table | hcloud ER CreateRouteTable | This API is used to create a route table. A route table is the basis for an enterprise router to send and receive packets. It contains attachment associations, propagations, and routes. | |
| Querying Details About a Route Table | hcloud ER ShowRouteTable | This API is used to query details about a route table. | |
| Updating Route Table Information | hcloud ER UpdateRouteTable | This API is used to update basic information about a route table, such as the name and description. | |
| Deleting a Route Table | hcloud ER DeleteRouteTable | This API is used to delete a route table. |
Associations
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Route Associations | hcloud ER ListAssociations | This API is used to query route associations. | |
| Creating a Route Association | hcloud ER AssociateRouteTable | This API is used to create a route association. Each attachment only can be associated with one route table of its enterprise router for packet forwarding. | |
| Deleting a Route Association | hcloud ER DisassociateRouteTable | This API is used to delete an association from the route table of an enterprise router for an attachment. | |
| Modifying the Route Policy of an Association | hcloud ER ChangeAssociationRoutePolicy | This API is used to modify the route policy of an association. |
Propagations
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Route Propagations | hcloud ER ListPropagations | This API is used to query route propagations. | |
| Creating a Route Propagation | hcloud ER EnablePropagation | This API is used to create a route propagation. A propagation can be created for each attachment to propagate routes to one or more route tables on an enterprise router. | |
| Deleting a Route Propagation | hcloud ER DisablePropagation | This API is used to delete a propagation from the route table of an enterprise router for an attachment. | |
| Modifying a Route Policy | hcloud ER UpdatePropagationRoutePolicy | This API is used to modify a route policy. |
Routes
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Details About a Static Route | hcloud ER ShowStaticRoute | This API is used to query details about a static route. | |
| Updating a Static Route | hcloud ER UpdateStaticRoute | This API is used to update a static route. | |
| Deleting a Static Route | hcloud ER DeleteStaticRoute | This API is used to delete a static route. | |
| Querying Static Routes | hcloud ER ListStaticRoutes | This API is used to query static routes. | |
| Creating a Static Route | hcloud ER CreateStaticRoute | This API is used to create a static route. | |
| Querying Valid Routes | hcloud ER ListEffectiveRoutes | This API is used to query valid routes. Pagination query is supported. |
Tags
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Project Tags | hcloud ER ListProjectTags | This API is used to query tags of resources of a specific type. | |
| Querying Resource Tags | hcloud ER ShowResourceTag | This API is used to query tags of resources of a specific type. | |
| Creating Resource Tags | hcloud ER CreateResourceTag | This API is used to create tags for resources of a specific type. | |
| Add and delete resource tags in batches | hcloud ER BatchCreateResourceTags | ||
| Deleting Resource Tags | hcloud ER DeleteResourceTag | This API is used to delete tags for resources of a specific type. |
Resource Quotas
| API Name | Command | Description | Operation |
|---|---|---|---|
| query quota | hcloud ER ShowQuotas | Query the usage of various resources of tenants, such as the usage of enterprise routers and the usage of VPC attachments. |
AZs
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying AZs | hcloud ER ListAvailabilityZone | This API is used to query AZs where enterprise routers can be created. An enterprise router can be created only when an AZ is in the available state. |
Flow Logs
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query the flow log list | hcloud ER ListFlowLogs | Query the flow log list under the enterprise router instance | |
| Create a flow log | hcloud ER CreateFlowLog | Create flow logs for ER instances. | |
| Querying Flow Log Details | hcloud ER ShowFlowLog | Querying Flow Log Details | |
| Update the basic information of the flow log | hcloud ER UpdateFlowLog | Update the basic information of the flow log | |
| Delete flow log | hcloud ER DeleteFlowLog | Delete flow log | |
| enable flow log | hcloud ER EnableFlowLog | enable flow log | |
| disable flow log | hcloud ER DisableFlowLog | disable flow log |
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