CLI Command Reference (V2)

Querying Quotas

hcloud GES ListQuotas2/v2

This API is used to query the tenant quotas.

Go debug

Querying the Graph List

hcloud GES ListGraphs2/v2

This API is used to query all graphs of the current tenant.

Go debug

Creating a Graph

hcloud GES CreateGraph2/v2

This API is used to create a graph.

Go debug

Querying Graph Details

hcloud GES ShowGraph2/v2

This API is used to query graph details by graph ID.

Go debug

Deleting a Graph

hcloud GES DeleteGraph2/v2

This API is used to delete a graph.

Go debug

Closing a Graph

hcloud GES StopGraph2/v2

This API is used to close a graph. After the graph is created, you can disable it if it is not used temporarily.

Go debug

Starting a Graph

hcloud GES StartGraph2/v2

This API is used to start a graph. You can disable a graph if it is not used temporarily.

Go debug

Incrementally Importing Data to a Graph

hcloud GES ImportGraph2/v2

This API is used to import data to graphs incrementally.

Go debug

Exporting a Graph

hcloud GES ExportGraph2/v2

Exporting a Graph.

Go debug

Clearing a Graph

hcloud GES ClearGraph2/v2

This API is used to clear all data in a graph.

Go debug

Upgrading a Graph

hcloud GES UpgradeGraph2/v2

This API is used to upgrade a graph. The GES version is periodically upgraded. You can upgrade your graphs as required.

Go debug

Binding an EIP

hcloud GES AttachEip2/v2

This API enables you to access GES by binding an elastic IP (EIP).

Go debug

Unbinding an EIP

hcloud GES DetachEip2/v2

If you do not need to use the EIP, this API enabled you to unbind the EIP to release network resources.

Go debug

Resizing a Graph

hcloud GES ResizeGraph2/v2

This API is used to resize a graph instance.

Go debug

Forcibly Restarting a Graph

hcloud GES RestartGraph2/v2

This API is used to forcibly start a graph, especially for running graphs or those are being imported, exported, and cleared. If a graph is forcibly restarted, asynchronous tasks of the graph are failed state and the graph is stopped and started.

Go debug

Expanding a Graph

hcloud GES ExpandGraph2/v2

This API is used to expand multiple secondary nodes dynamically. The expanded secondary nodes can process read requests, improving read performance.

Go debug

Changing the Security Group

hcloud GES ChangeSecurityGroup/v2

This API is used to change the security group of a graph after the graph is created.

Go debug

Viewing the List of All Backups

hcloud GES ListBackups2/v2

This API is used to query a backup list according to search criteria.

Go debug

Viewing the Backup List of a Graph

hcloud GES ListGraphBackups2/v2

This API is used to query the backup list of a graph.

Go debug

Adding a Backup

hcloud GES CreateBackup2/v2

Add a backup. If data in the current graph is incorrect or faulty, you can start the backup graph to restore the data.

Go debug

Deleting a Backup

hcloud GES DeleteBackup2/v2

This API is used to delete a backup.

Go debug

Exporting a Backup

hcloud GES ExportBackup2/v2

This API is used to export a backup.

Go debug

Importing a Backup

hcloud GES ImportBackup2/v2

This API is used to import a backup.

Go debug

Obtaining a Download Link for Backup Files

hcloud GES ShowBackupDownloadLink/v2

This API is used to obtain a download link for backup files. Within the validity period of 3,600 seconds, you can directly download the backup file through the URL.

Go debug

Querying Metadata

hcloud GES ShowMetadata2/v2

This API is used to query the metadata of a graph.

Go debug

Deleting Metadata

hcloud GES DeleteMetadata2/v2

Delete a metadata file.

Go debug

Adding Metadata

hcloud GES CreateMetadata2/v2

Add a metadata file.

Go debug

Querying the Metadata List

hcloud GES ListMetadatas2/v2

Query the metadata list.

Go debug

Importing Metadata from OBS

hcloud GES UploadFromObs2/v2

This API is used to import metadata from OBS.

Go debug

Querying Job Status on the Management Plane

hcloud GES ShowJob2/v2

This API is used to query the execution status of a task, such as ECS creation, ECS deletion, ECS batch operation, and NIC operation. Asynchronous APIs that are used to create, stop, start, delete, and import graphs will return job IDs after commands are sent. You can query the job execution status according to the job IDs.

Go debug

Querying Job Details in the Job Center

hcloud GES ListJobs2/v2

This API is used to query asynchronous job details in the job center on the management plane. Asynchronous jobs include creating, closing, starting, deleting, adding, importing, exporting, and upgrading graphs, as well as adding backups.

Go debug

Querying Scene Analysis Plugin Information

hcloud GES ListScenes2/v2

This API is used to query the information about the application analysis capability in a scene, including information about the applications, parameters, and function details.

Go debug

Subscribing to a Scene Analysis Plugin

hcloud GES RegisterScenes2/v2

This API is used to subscribe to a scene analysis plugin so that you can use the function through the service plane APIs.

Go debug

Unsubscribing from a Scene Analysis Plugin

hcloud GES DeregisterScenes2/v2

This API is used to unsubscribe from a scene analysis plugin. After the subscription is canceled, you cannot use the function through application service plane APIs.

Go debug