CLI Command Reference
Physical Server Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Batch Querying Co-located Servers | hcloud CloudDC ListServers | List imetal servers | |
| Querying the Co-located Server Information | hcloud CloudDC ShowServer | Get imetal server by id | |
| Querying the Server Hardware Details | hcloud CloudDC ShowServerHardwareAttributes | This API is used to obtain hardware details. | |
| Querying the Firmware Details | hcloud CloudDC ShowServerFirmwareAttributes | This API is used to obtain firmware details. | |
| Batch Modifying the Power Statuses of Managed Servers | hcloud CloudDC ChangeServerPowerState | This API is used to modify the power status of a co-located server. This API is asynchronous. The power status modification result can be obtained from the co-located server information. | |
| Exporting Server Logs | hcloud CloudDC ExportServerLogs | This API is used to create an asynchronous task for exporting server logs. The system queries the log export status using ShowLogsExportStatus. When the status is completed, DownloadServerLogs is called to download log files. | |
| This API is used to query the export status of logs. | hcloud CloudDC ShowLogsExportStatus | This API is used to query the log collection status and progress. | |
| Obtaining the Console Address | hcloud CloudDC ShowRemoteConsole | This API is used to obtain console information. | |
| Downloading a Log File | hcloud CloudDC DownloadServerLogs | This API is used to download server log files. |
Physical Server Diagnosis
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining Server Overview | hcloud CloudDC ShowServerStatus | This API is used to query the server overview, server startup status, and server operating status. | |
| Obtaining Server Alarm Overview | hcloud CloudDC ShowAlarmSummary | This API is used to query the server alarm overview. | |
| Obtaining Server Alarm Trend | hcloud CloudDC ShowAlarmTrend | This API is used to query the server overview, server startup status, and server operating status. | |
| Obtaining Server Alarm List | hcloud CloudDC ListAlarms | This API is used to query the server alarm list. | |
| Server event list is returned. | hcloud CloudDC ListEvents | This API is used to query the server event list. | |
| This API is used to query event definitions. | hcloud CloudDC ShowEvent | This API is used to query event definitions. |
iMetal Servers
| API Name | Command | Description | Operation |
|---|---|---|---|
| This API is used to query instances in batches. | hcloud CloudDC ListInstances | This API is used to query instances in batches. | |
| Creating an Instance | hcloud CloudDC CreateInstance | This API is used to create an instance with more custom parameters, such as an IP address. | |
| Deleting an Instance | hcloud CloudDC DeleteInstance | This API is used to delete instance from a specified managed server. This API is asynchronous. You can call the ShowInstanceStatus API to query the instance status. If the status of the instance changes from shutting-down to terminated, the instance has been deleted. | |
| Changing the IP Address of an Instance | hcloud CloudDC ModifyInstanceIp | This API is used to select a specified iMetal instance and change its IP address. | |
| Batch Changing Instance Passwords | hcloud CloudDC ChangeInstancePassword | This API is used to change the passwords of the management account (user root or Administrator ) for logging in to servers. | |
| Batch Reinstalling OSs | hcloud CloudDC ReinstallOs | This API is used to reinstall an OS using a new OS image. This API an asynchronous. You can query the instance status by calling the ShowInstanceStatus API. If the status changes to pending, the OS is being reinstalled. If the status changes to running, the OS reinstallation is complete. | |
| This API is used to query the instance status. | hcloud CloudDC ShowInstanceStatus | This API is used to query the instance status. | |
| Creating Instances in Batches | hcloud CloudDC RunInstances | This API is used to create instances in batches. The supported scheduling policies are as follows: | |
| Batch Deleting Instances | hcloud CloudDC DeleteInstances | This API is used to batch delete instances from a specified managed server. This API is asynchronous. You can call the ShowInstanceStatus API to query the instance status. If the status of an instance changes from shutting-down to terminated, the instance has been deleted. |
Tag Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| This API is used to create resource tags in batches. | hcloud CloudDC BatchCreateTags | This API is used to create resource tags in batches. | |
| This API is used to delete resource tags in batches. | hcloud CloudDC BatchDeleteTags | This API is used to delete resource tags in batches. | |
| Batch Creating Rack Tags | hcloud CloudDC BatchCreateIrackTags | This API is used to batch create resource tags. | |
| Batch Deleting Rack Tags | hcloud CloudDC BatchDeleteIrackTags | This API is used to batch delete resource tags. |
High-Frequency APIs
| API Name | Command | Description | Operation |
|---|---|---|---|
| Batch Querying Co-located Servers | hcloud CloudDC ListServers | List imetal servers | |
| This API is used to query instances in batches. | hcloud CloudDC ListInstances | This API is used to query instances in batches. | |
| Batch Reinstalling OSs | hcloud CloudDC ReinstallOs | This API is used to reinstall an OS using a new OS image. This API an asynchronous. You can query the instance status by calling the ShowInstanceStatus API. If the status changes to pending, the OS is being reinstalled. If the status changes to running, the OS reinstallation is complete. | |
| Creating Instances in Batches | hcloud CloudDC RunInstances | This API is used to create instances in batches. The supported scheduling policies are as follows: |
Hosted Rack Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Updating an Intelligent Rack | hcloud CloudDC UpdateIRack | This APi is used to update the iRack information. | |
| Querying Intelligent Rack List | hcloud CloudDC ListIRacks | After a user places an order, the user reports the intelligent rack list. This API is used to view the intelligent racks and the number of associated iMetal servers. |
Equipment Room Management
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
