You need to enable JavaScript to run this app.
导航
ModifyDBAccount
最近更新时间:2024.09.13 11:12:18首次发布时间:2021.11.15 16:07:17

调用 ModifyDBAccount 接口修改目标实例中指定账号的信息,包括账号所属角色、密码、描述等。

请求类型

同步请求。

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String

redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

AccountName
String

test1

账号名称。

说明

您可以调用 ListDBAccount 接口查询目标 Redis 实例中所有账号的信息,包括账号名称。

RoleName
String

ReadWrite

账号所属角色。支持如下默认角色:

  • Administrator:允许对所有 KEY 使用所有命令。
  • ReadWrite:允许对所有 KEY 使用除 admin 类之外的所有命令。
  • ReadOnly:允许对所有 KEY 使用 read 类中的所有命令。
  • NotDangerous:允许对所有 KEY 使用除 dangerous 类之外的所有命令。

说明

  • 若该参数留空,表示不修改账号所属角色。
  • default 账号的角色固定为 Administrator,不支持修改。
  • 关于各角色对应 ACL 规则支持的具体命令详情,请参见 ACL 语法
Password
String

Pwd@12****

修改后的账号密码。修改后的密码需同时满足如下要求:

  • 长度为 8~30 个字符。
  • 至少包含大写字母、小写字母、数字或特殊字符中的任意 2 种。
  • 支持如下特殊字符:
    ()`~!@#$%^&*-+=_|{}[];<>,.?
    

说明

若该参数为空,表示不修改账号密码。

Description
String

The_test_account

修改后的账号描述,长度不超过 256 个字符。

说明

若该参数为空,表示不修改账号描述。

ClientToken
String

WbiAlPqJM6tMoSOYhT****

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyDBAccount&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
	"InstanceId": "redis-cn0212gzmh2xs****",
	"AccountName": "test1",
	"RoleName": "ReadWrite",
	"Description": "The_test_account"
}

返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204152014380102120372300562****",
          "Action": "ModifyDBAccount",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": null
}

错误码

更多详情,请参见错误码