Delete Physical Machine - TerminatePHost
Overview
Delete Physical UHost
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is TerminatePHost . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
Zone | string | Availability Zone. See Availability Zone List | No |
ProjectId | string | Project 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 |
PHostId | string | PHost Resource ID | Yes |
ReleaseEIP | boolean | Whether to release the bound EIP. true: Unbind the EIP and release it; other values or not filled: Unbind the EIP. | No |
ReleaseUDisk | boolean | BareMetal machine parameters -> Whether to delete the mounted data disk when deleting the host. The default is false. | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
PHostId | string | Resource ID of PHost | No |
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
}