Simulate Host Power Off - PoweroffUHostInstance
Overview
Directly turn off the power of the UHost instance, no need to wait for the instance to shut down normally.
ℹ️ This operation may affect data integrity or cause file system damage.
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is PoweroffUHostInstance . | 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 Instance ID, see DescribeUHostInstance | Yes |
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 |
UHostId | string | Instance ID of UHost | No |
Example
Request Example
https://api.surfercloud.com/?Action=PoweroffUHostInstance
&Region=cn-bj2
&Zone=cn-bj2-04
&ProjectId=org-xxx
&UHostId=uhost-xxx
Response Example
{
"Action": "PoweroffUHostInstanceResponse",
"RetCode": 0,
"UHostId": "uhost-xxx"
}