docs
api
UHost(UHost)
TerminateUHostInstance

Delete UHost - TerminateUHostInstance

Overview

Delete the UHost instance in the specified data center.

ℹ️ Non-trial expired resources cannot be deleted; Deletion operation can only be performed in the shutdown state.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is TerminateUHostInstance.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
UHostIdstringUHost Resource Id see DescribeUHostInstanceYes
ReleaseEIPbooleanWhether to release the bound EIP when deleting the host. The default is false.No
ReleaseUDiskbooleanWhether to delete the mounted data disk when deleting the host. The default is false.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
InRecyclestringUsed to determine whether the host is moved to the recycle bin when deleted. Put into recycle bin: "Yes", completely delete: "No".Yes
UHostIdstringUHost Instance IdNo

Example

Request Example

https://api.surfercloud.com/?Action=TerminateUHostInstance
&Region=cn-bj2
&Zone=cn-bj2-04
&ProjectId=org-xxx
&UHostId=uhost-xxx
&ReleaseUDisk=true

Response Example

{
  "Action": "TerminateUHostInstanceResponse",
  "InRecycle": "No",
  "RetCode": 0,
  "UHostId": "uhost-xxx"
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.