Docs
api
UHost(UHost)
ResetUHostInstancePassword

Reset Host Password - ResetUHostInstancePassword

Overview

Reset the administrator password of the UHost instance.

ℹ️ This operation requires the UHost instance to be in the shutdown state.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ResetUHostInstancePassword.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
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 IDYes
PasswordstringNew UHost password (password format uses BASE64 encoding)No
LoginModestringHost login mode. Password (default option): Password, KeyPair: KeyPair.No
KeyPairIdstringKeypairId is the ID of the key pair, which is mandatory when LoginMode is KeyPair.No
AutoStartbooleanWhether to turn on the device immediately after changing the password. The default value is false. If set to true, uhost will turn on immediately after successfully changing the password; Spot and Postpaid chargeType uhost do not support the current feature;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
UHostIdstringUHost Instance IDNo

Example

Request Example

https://api.dezai.com/?Action=ResetUHostInstancePassword
&Region=cn-bj2
&Zone=cn-bj2-04
&ProjectId=org-xxx
&UHostId=uhost-xxx
&Password=xxx

&LoginMode=EDgIxjbH
&KeyPairId=hJOtYxkc
&AutoStart=true

Response Example

{
  "Action": "ResetUHostInstancePasswordResponse",
  "RetCode": 0,
  "UHostId": "uhost-xxx"
}