CLI Command Reference (V3)
Cloud Connections
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Cloud Connection | hcloud CC CreateCloudConnection/v3 | This API is used to create a cloud connection. | |
| Querying the Cloud Connection List | hcloud CC ListCloudConnections/v3 | This API is used to query the cloud connection list. | |
| Querying a Cloud Connection | hcloud CC ShowCloudConnection/v3 | This API is used to query the details about a cloud connection. | |
| Updating a Cloud Connection | hcloud CC UpdateCloudConnection/v3 | This API is used to update a cloud connection. | |
| Deleting a Cloud Connection | hcloud CC DeleteCloudConnection/v3 | This API is used to delete a cloud connection. | |
| Adding a Tag to a Cloud Connection | hcloud CC TagCloudConnection/v3 | This API is used to add a tag to a cloud connection. | |
| Deleting a Tag from a Cloud Connection | hcloud CC UntagCloudConnection/v3 | This API is used to delete a tag from a cloud connection. | |
| Querying the Tags Added to a Cloud Connection | hcloud CC ListCloudConnectionTags/v3 | This API is used to query the tags added to a cloud connection. | |
| Querying Cloud Connections by Tag | hcloud CC ListCloudConnectionsByTags/v3 | This API is used to query cloud connections by tag. |
Network Instances
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Network Instance | hcloud CC CreateNetworkInstance/v3 | This API is used to create a network instance. | |
| Querying the Network Instance List | hcloud CC ListNetworkInstances/v3 | This API is used to query the network instance list. | |
| Querying a Network Instance | hcloud CC ShowNetworkInstance/v3 | This API is used to query the details about a network instance. | |
| Updating a Network Instance | hcloud CC UpdateNetworkInstance/v3 | This API is used to update a network instance. | |
| Removing a Network Instance | hcloud CC DeleteNetworkInstance/v3 | This API is used to remove a network instance. |
Bandwidth Packages
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Bandwidth Package | hcloud CC CreateBandwidthPackage/v3 | This API is used to create a bandwidth package. | |
| Querying the Bandwidth Package List | hcloud CC ListBandwidthPackages/v3 | This API is used to query the bandwidth package list. | |
| Querying a Bandwidth Package | hcloud CC ShowBandwidthPackage/v3 | This API is used to query the details about a bandwidth package. | |
| Updating a Bandwidth Package | hcloud CC UpdateBandwidthPackage/v3 | This API is used to update a bandwidth package. | |
| Deleting a Bandwidth Package | hcloud CC DeleteBandwidthPackage/v3 | This API is used to delete a bandwidth package. | |
| Adding a Tag to a Bandwidth Package | hcloud CC TagBandwidthPackage/v3 | This API is used to add a tag to a bandwidth package. | |
| Deleting a Tag from a Bandwidth Package | hcloud CC UntagBandwidthPackage/v3 | This API is used to delete a tag from a bandwidth package. | |
| Querying the Tags of a Bandwidth Package | hcloud CC ListBandwidthPackageTags/v3 | This API is used to query the tags of a bandwidth package. | |
| Querying Bandwidth Packages by Tag | hcloud CC ListBandwidthPackagesByTags/v3 | Querying Bandwidth Packages by Tag | |
| Binding a Bandwidth Package to a Cloud Connection | hcloud CC AssociateBandwidthPackage/v3 | This API is used to bind a bandwidth package to a cloud connection. | |
| Unbinding a Bandwidth Package from a Cloud Connection | hcloud CC DisassociateBandwidthPackage/v3 | This API is used to unbind a bandwidth package from a cloud connection. |
Inter-Region Bandwidths
| API Name | Command | Description | Operation |
|---|---|---|---|
| Assigning an Inter-Region Bandwidth | hcloud CC CreateInterRegionBandwidth/v3 | This API is used to assign an inter-region bandwidth. | |
| Querying the Inter-Region Bandwidth List | hcloud CC ListInterRegionBandwidths/v3 | This API is used to query the inter-region bandwidth list. | |
| Querying an Inter-Region Bandwidth | hcloud CC ShowInterRegionBandwidth/v3 | This API is used to query the details about an inter-region bandwidth. | |
| Changing the Capacity of an Inter-Region Bandwidth | hcloud CC UpdateInterRegionBandwidth/v3 | This API is used to change the capacity of an inter-region bandwidth. | |
| Deleting an Inter-Region Bandwidth | hcloud CC DeleteInterRegionBandwidth/v3 | This API is used to delete an inter-region bandwidth. |
Cloud Connection Routes
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List of Cloud Connection Routes | hcloud CC ListCloudConnectionRoutes/v3 | This API is used to query the list of cloud connection routes. | |
| Querying a Cloud Connection Route | hcloud CC ShowCloudConnectionRoutes/v3 | This API is used to query the details about a cloud connection route. |
Authorizations
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating an Authorization | hcloud CC CreateAuthorisation/v3 | This API is used to grant another account permissions to load your network instances to their cloud connection. | |
| Querying the Authorization List | hcloud CC ListAuthorisations/v3 | This API is used to query the list of authorizations that allow another account to use your network instances. | |
| Querying the Permission List | hcloud CC ListPermissions/v3 | This API is used to query the list of permissions to use network instances in another account. | |
| Updating an Authorization | hcloud CC UpdateAuthorisation/v3 | This API is used to update an authorization. | |
| Canceling an Authorization | hcloud CC DeleteAuthorisation/v3 | This API is used to cancel the authorization that allows other users to load your network instances to their cloud connection. |
Central Networks
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Central Network | hcloud CC CreateCentralNetwork/v3 | This API is used to create a central network. | |
| Querying the Central Network List | hcloud CC ListCentralNetworks/v3 | This API is used to query the central network list. | |
| Querying a Central Network | hcloud CC ShowCentralNetwork/v3 | This API is used to query the details about a central network. | |
| Updating a Central Network | hcloud CC UpdateCentralNetwork/v3 | This API is used to update a central network. | |
| Deleting a Central Network | hcloud CC DeleteCentralNetwork/v3 | This API is used to delete a central network. Remove the attachments before deleting the central network. | |
| Adding a Tag to a Central Network | hcloud CC TagCentralNetwork/v3 | This API is used to add a tag to a central network. | |
| Deleting a Tag from a Central Network | hcloud CC UntagCentralNetwork/v3 | This API is used to delete a tag from a central network. | |
| Querying the Tags Added to a Central Network | hcloud CC ListCentralNetworkTags/v3 | This API is used to query the tags added to a central network. | |
| Querying Central Networks by Tag | hcloud CC ListCentralNetworksByTags/v3 | This API is used to query central networks by tag. | |
| Adding a Central Network Policy | hcloud CC CreateCentralNetworkPolicy/v3 | This API is used to add a central network policy. A policy cannot be modified. If the policy cannot meet your requirements, you need to add a new policy. | |
| Querying the List of Central Network Policies | hcloud CC ListCentralNetworkPolicies/v3 | This API is used to query the list of central network policies. | |
| Applying a Central Network Policy | hcloud CC ApplyCentralNetworkPolicy/v3 | This API is used to apply a central network policy. | |
| Deleting a Central Network Policy | hcloud CC DeleteCentralNetworkPolicy/v3 | This API is used to delete a central network policy. An applied policy cannot be deleted. | |
| Querying the Changes Between the Current Policy and an Applied Policy | hcloud CC ListCentralNetworkPolicyChangeSet/v3 | This API is used query the changes between the current policy and an applied policy. |
Central Network Attachments
| API Name | Command | Description | Operation |
|---|---|---|---|
| Adding a Global DC Gateway to a Central Network | hcloud CC CreateCentralNetworkGdgwAttachment/v3 | This API is used to add a global DC gateway to a central network as an attachment. | |
| Querying the List of Global DC Gateways on a Central Network | hcloud CC ListCentralNetworkGdgwAttachments/v3 | This API is used to query the list of global DC gateways on a central network. | |
| Querying a Global DC Gateway on a Central Network | hcloud CC ShowCentralNetworkGdgwAttachment/v3 | This API is used to query the details about a global DC gateway on the central network. | |
| Updating a Global DC Gateway on a Central Network | hcloud CC UpdateCentralNetworkGdgwAttachment/v3 | This API is used to update a global DC gateway on a central network. | |
| Adding a Route Table of an Enterprise Router as an Attachment on a Central Network | hcloud CC CreateCentralNetworkErRouteTableAttachment/v3 | This API is used to add a route table of an enterprise router as an attachment on a central network. | |
| Querying the List of Enterprise Router Route Tables on a Central Network | hcloud CC ListCentralNetworkErRouteTableAttachments/v3 | This API is used to query the list of enterprise router route tables as attachments on a central network. | |
| Querying an Enterprise Router Route Table on a Central Network | hcloud CC ShowCentralNetworkErRouteTableAttachment/v3 | This API is used to query the details about an enterprise router route table on a central network. | |
| Updating an Enterprise Router Route Table on a Central Network | hcloud CC UpdateCentralNetworkErRouteTableAttachment/v3 | This API is used to update an enterprise router route table on a central network. | |
| Querying the List of Central Network Attachments | hcloud CC ListCentralNetworkAttachments/v3 | This API is used to query the list of central network attachments. | |
| Removing an Attachment from a Central Network | hcloud CC DeleteCentralNetworkAttachment/v3 | This API is used to remove an attachment from a central network. |
Central Network Connections
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List of Central Network Connections | hcloud CC ListCentralNetworkConnections/v3 | This API is used to query the list of central network connections. | |
| Modifying the Bandwidth of a Central Network Connection | hcloud CC UpdateCentralNetworkConnection/v3 | This API is used to update a central network connection. Only the bandwidth capacity can be modified. |
Site Network Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a P2P Site Network | hcloud CC CreateP2PSiteNetwork/v3 | This API is used to create a P2P site network. | |
| Querying the Site Network List | hcloud CC ListSiteNetworks/v3 | This API is used to query the site network list. | |
| Querying a Site Network | hcloud CC ShowSiteNetwork/v3 | This API is used to query the details about a site network. | |
| Updating a Site Network | hcloud CC UpdateSiteNetwork/v3 | This API is used to update a site network. | |
| Deleting a Site Network | hcloud CC DeleteSiteNetwork/v3 | This API is used to delete a site network. |
Site-to-Site Connection Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Unbinding a Global Connection Bandwidth from a Site-to-Site Connection | hcloud CC DisassociateSiteNetworkBandwidth/v3 | This API is used to unbind global connection bandwidth from a site-to-site connection. | |
| Binding a Global Connection Bandwidth to a Site-to-Site Connection | hcloud CC AssociateSiteNetworkBandwidth/v3 | This API is used to bind a global connection bandwidth to a site-to-site connection. | |
| Changing the Bandwidth Capacity for a Site-to-Site Connection | hcloud CC UpdateSiteNetworkBandwidthSize/v3 | This API is used to change the bandwidth capacity for a site-to-site connection. | |
| Changing the Global Connection Bandwidth of a Site-to-Site Connection | hcloud CC UpdateSiteNetworkBandwidth/v3 | This API is used to change the global connection bandwidth of a site-to-site connection. |
Cloud Connection Quotas
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Cloud Connection Resource Quotas | hcloud CC ListCloudConnectionQuotas/v3 | This API is used to query cloud connection resource quotas. |
Cloud Connection Capabilities
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Cloud Connect Capabilities | hcloud CC ListCloudConnectionCapabilities/v3 | This API is used to query Cloud Connect capabilities. |
Central Network Quotas
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Central Network Resource Quotas | hcloud CC ListCentralNetworkQuotas/v3 | This API is used to query the resource quotas. |
Central Network Capabilities
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Central Network Capabilities | hcloud CC ListCentralNetworkCapabilities/v3 | This API is used to query central network capabilities. |
Site Network Quotas
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Site Network Quotas | hcloud CC ListSiteNetworkQuotas/v3 | This API is used to query site network quotas. |
Site Network Capabilities
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List of Site Network Capabilities | hcloud CC ListSiteNetworkCapabilities/v3 | This API is used to query the list of site network capabilities. |
Specifications
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Supported Regions | hcloud CC ListRegions/v3 | This API is used to query supported regions. | |
| Querying Supported Geographic Regions | hcloud CC ListAreas/v3 | This API is used to query the supported geographic regions. | |
| Querying the Specifications of Bandwidth Packages for Cross-Region Communication | hcloud CC ListRegionBandwidthPackageSpecifications/v3 | This API is used to query the specifications of bandwidth packages for communications across regions. | |
| Querying the Specifications of Bandwidth Packages for Cross-Geographic-Region Communication | hcloud CC ListAreaBandwidthPackageSpecifications/v3 | This API is used to query the specifications of bandwidth packages for communications across geographic regions. | |
| Querying the Bandwidth Site List | hcloud CC ListBandwidthPackageSites/v3 | This API is used to query the bandwidth site list. | |
| Querying the Bandwidth Class List | hcloud CC ListBandwidthPackageLevels/v3 | This API is used to query the bandwidth class list. | |
| Querying the Bandwidth Line List | hcloud CC ListBandwidthPackageLines/v3 | This API is used to query the bandwidth line list. |
Global Connection Bandwidths
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Global Connection Bandwidth List | hcloud CC ListGlobalConnectionBandwidths/v3 | This API is used to query the global connection bandwidth list. | |
| Creating a Global Connection Bandwidth | hcloud CC CreateGlobalConnectionBandwidth/v3 | This API is used to create a global connection bandwidth. | |
| Querying a Global Connection Bandwidth | hcloud CC ShowGlobalConnectionBandwidth/v3 | This API is used to query the details about a global connection bandwidth. | |
| Updating a Global Connection Bandwidth | hcloud CC UpdateGlobalConnectionBandwidth/v3 | This API is used to update a global connection bandwidth. | |
| Deleting a Global Connection Bandwidth | hcloud CC DeleteGlobalConnectionBandwidth/v3 | This API is used to delete a global connection bandwidth. | |
| Binding a Global Connection Bandwidth to an Instance | hcloud CC AssociateGlobalConnectionBandwidthInstance/v3 | This API is used to bind a global connection bandwidth to an instance. | |
| Unbinding a Global Connection Bandwidth from an Instance | hcloud CC DisassociateGlobalConnectionBandwidthInstance/v3 | This API is used to unbind a global connection bandwidth from an instance. | |
| Querying the List of Global Connection Bandwidths That Meet the Binding Conditions | hcloud CC ListSupportBindingConnectionBandwidths/v3 | This API is used to query the list of global connection bandwidths that meet the binding conditions. | |
| Querying the Tenant Configuration of a Global Connection Bandwidth | hcloud CC ListGlobalConnectionBandwidthConfigs/v3 | This API is used to query the tenant configuration of a global connection bandwidth. | |
| Querying the Line Specification List | hcloud CC ListGlobalConnectionBandwidthSpecCodes/v3 | This API is used to query the line specification list. Fields in the response body of this API are controlled using a whitelist. They are left blank by default. | |
| Querying the Site List | hcloud CC ListGlobalConnectionBandwidthSites/v3 | This API is used to query the site list. | |
| Querying the Line Grade List | hcloud CC ListGlobalConnectionBandwidthLineLevels/v3 | This API is used to query the line grade list. |
Global Connection Bandwidth Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying a Global Connection Bandwidth Tag in an Account | hcloud CC ListGcbResourceTags/v3 | This API is used to query a global connection bandwidth tag in an account. | |
| Adding a Tag to a Global Connection Bandwidth | hcloud CC CreateGcbResourceTag/v3 | This API is used to add a tag to a global connection bandwidth. | |
| Deleting a Tag from a Global Connection Bandwidth | hcloud CC DeleteGcbResourceTag/v3 | This API is used to delete a tag from a global connection bandwidth. | |
| Adding Tags to a Global Connection Bandwidth | hcloud CC BatchCreateGcbResourceTags/v3 | This API is used to add tags to a global connection bandwidth. | |
| Deleting Tags from a Global Connection Bandwidth | hcloud CC BatchDeleteGcbResourceTags/v3 | This API is used to delete tags from a global connection bandwidth. | |
| Querying the Number of Global Connection Bandwidth Tags in an Account | hcloud CC CountGcbResourceByTag/v3 | This API is used to query the number of global connection bandwidth tags in an account. | |
| Querying the List of Global Connection Bandwidths in an Account | hcloud CC ListGcbResourceByTag/v3 | This API is used to query the list of global connection bandwidths in an account. | |
| Querying All Global Connection Bandwidth Tags in an Account | hcloud CC ListGcbTenantTags/v3 | This API is used to query all global connection bandwidth tags in an account. |
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