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 Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ResetUHostInstancePassword`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	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	Yes
Password	string	New UHost password (password format uses BASE64 encoding)	No
LoginMode	string	Host login mode. Password (default option): Password, KeyPair: KeyPair.	No
KeyPairId	string	KeypairId is the ID of the key pair, which is mandatory when LoginMode is KeyPair.	No
AutoStart	boolean	Whether 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 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	UHost Instance ID	No

Example

Request Example


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