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 Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is TerminateUHostInstance . | 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, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
UHostId | string | UHost Resource Id see DescribeUHostInstance | Yes |
ReleaseEIP | boolean | Whether to release the bound EIP when deleting the host. The default is false. | No |
ReleaseUDisk | boolean | 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 |
InRecycle | string | Used to determine whether the host is moved to the recycle bin when deleted. Put into recycle bin: "Yes", completely delete: "No". | Yes |
UHostId | string | UHost Instance Id | No |
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"
}