You need to enable JavaScript to run this app.
导航
ModifyUserPassword - 修改用户名和密码
最近更新时间:2024.11.18 10:21:06首次发布时间:2023.05.19 15:47:10

调用 ModifyUserPassword 接口重置 RabbitMQ 实例 Web UI 的管理员账号密码。

使用说明

安全起见,消息队列 RabbitMQ 版建议您定期维护 Web UI 的管理员账号密码。如果您忘记了管理员用户名或密码,您可以通过此接口重置账号及密码。

注意事项

请求频率:该接口请求频率限制为 20 次/秒;单用户请求频率限制为 5 次/秒。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ModifyUserPassword

要执行的操作,取值:ModifyUserPassword。

Version
String

2022-01-01

API的版本,取值:2022-01-01。

InstanceId
String

rbtmq-2f707884****

实例 ID。

UserName
String

admin

需修改密码的管理员的账号名称。

Password
String

Admin****

账号密码。须满足以下要求:

  • 8~32 个字符。
  • 包含大写字母、小写字母、数字、特殊字符中的三种。
  • 特殊字符包括!@#$%^&\*()\_+-=

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=ModifyUserPassword&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rabbitmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rabbitmq/request, SignedHeaders=x-date, Signature=********

{
   "InstanceId": "rbtmq-2f707884****",
   "UserName": "testcase2312312",
   "Password":"Admin******"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230220215437B5837F4C4321FCD0AF2A",
        "Action": "ModifyUserPassword",
        "Version": "2022-01-01",
        "Service": "RabbitMQ",
        "Region": "cn-guangzhou"
    },
    "Result": null
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter
The specified parameter %s is not valid.

参数值%s无效。

403
OperationDenied.InvalidInstanceStatus
The operation is not valid for the current status of the instance.

当前实例状态不允许执行该操作。

403
OperationDenied.TaskIsRunning
An operation is currently in progress. Try again later.

后台任务正在运行中,请稍后再试。

404
InvalidInstanceId.NotFound
The specified Instance ID does not exist.

实例不存在。

500
InternalError
The request failed due to some unknown error, exception or failure.

内部错误,请稍后重试。