Reset Instance Password - ResetPHostPassword
Overview
Reset the administrator password of the BareMetal instance
ℹ️ Must be BareMetal machine type
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is ResetPHostPassword. | 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 | Yes |
| ProjectId | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface. | No |
| PHostId | string | BareMetal Instance ID | Yes |
| Password | string | New PHost Password (Password format uses BASE64 encoding) | 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 |
| PHostId | string | BareMetal Instance ID | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=ResetPHostPassword
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=QmSMDuqd
&PHostId=DykmtHFP
&Password=kVNvOKdNResponse Example
{
"Action": "ResetPHostPasswordResponse",
"PHostId": "RCpQTdDW",
"RetCode": 0
}