调用 ResetAdminPassword 接口,重置实例管理员账号(admin)的密码。
如果重置密码的操作在执行期间发生任何异常导致了您的密码没有更新,那么实例将仍然沿用旧密码,您可以继续使用或者重新发起一次重置操作。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ResetAdminPassword | 要执行的操作,取值:ResetAdminPassword。 |
Version | String | 是 | 2023-01-01 | API的版本,取值:2023-01-01。 |
InstanceId | String | 是 |
| 需要重置密码的实例 ID。 |
UserName | String | 否 |
| 需要重置密码的用户,仅支持重置 |
NewPassword | String | 是 |
| 自定义设置新密码。取值规范如下:
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Status | String |
| 返回的操作状态。 |
Message | String | 返回的提示信息。 |
POST https://open.volcengineapi.com/?Action=ResetAdminPassword&Version=2023-01-01 Content-Type: application/json X-Date: 20231003T104027Z Authorization: HMAC-SHA256 Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b**** { "InstanceId": "o-00k***o718", "NewPassword": "Password****", "Force": false, "UserName": "admin" }
{ "ResponseMetadata": { "Action": "ResetAdminPassword", "Region": "cn-beijing", "RequestId": "202306041104200100100***", "Service": "ESCloud", "Version": "2023-01-01" }, "Result": { "Status": "SUCCESSFUL", "Message": "" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
200 | Unauthorized | 用户无权限调用接口 |
200 | InternalServerError | 服务由于异常退出,无法完成接口请求操作 |
200 | IllegalParameter | 非法参数。可能是参数缺失,也可能是参数不符合接口要求 |