docs
api
Physical Cloud Host(UPHost)
TerminatePHost

Delete Physical Machine - TerminatePHost

Overview

Delete Physical UHost

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is TerminatePHost.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, and the sub-account must be filled in. Please refer to the GetProjectList interface.Yes
PHostIdstringPHost Resource IDYes
ReleaseEIPbooleanWhether to release the bound EIP. true: Unbind the EIP and release it; other values or not filled: Unbind the EIP.No
ReleaseUDiskbooleanBareMetal machine parameters -> Whether 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
PHostIdstringResource ID of PHostNo

Example

Request Example

https://api.surfercloud.com/?Action=TerminatePHost
&Region=geMFFVTJ
&Zone=BAJaGwVv
&ProjectId=oSWbEAst
&PHostId=PoTZbUmp
&ReleaseEIP=false
&ReleaseUDisk=false

Response Example

{
  "Action": "TerminatePHostResponse",
  "PHostId": "BzNdSIyb",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved