You need to enable JavaScript to run this app.
导航
云搜索服务
  • 文档首页
    • /
  • 云搜索服务

ResetAdminPassword - 重置 admin 密码

最近更新时间：2024.04.09 15:04:01

首次发布时间：2023.11.30 14:19:27

我的收藏

调用 ResetAdminPassword 接口，重置实例管理员账号（admin）的密码。

注意事项

  • 重置 admin 密码将重启实例，可能会导致服务短暂不可用，建议在业务低峰期进行。
  • 如果重置密码的操作在执行期间发生任何异常导致了您的密码没有更新，那么实例将仍然沿用旧密码，您可以继续使用或者重新发起一次重置操作。

请求说明

  • 请求方式：POST
  • 请求地址：/?Action=ResetAdminPassword&Version=2023-01-01 HTTP/1.1

请求参数

Query

参数类型是否必选示例值描述
ActionString是ResetAdminPassword接口名称。当前 API 的名称为 ResetAdminPassword。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
UserNameString否admin需要重置密码的用户，仅支持重置admin用户的密码。
InstanceIdString是o-00k***o718需要重置密码的实例 ID。

NewPassword

String

是

Password****

自定义设置新密码。取值规范如下：

  • 密码至少包含大写字母、小写字母、数字和特殊字符中的三种，长度为 8～32 个字符。
  • 支持_#!@$%^&*()+=-特殊字符，不可以包含空格和中文。

返回参数

参数类型示例值描述
StatusStringSUCCESSFUL返回的操作状态。
MessageString-返回的提示信息。

请求示例

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": ""
    }
}