Docs
api
UHost(UHost)
PoweroffUHostInstance

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 NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is PoweroffUHostInstance.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 Instance ID, see DescribeUHostInstanceYes

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
UHostIdstringInstance ID of UHostNo

Example

Request Example

https://api.ucloud-global.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"
}