You need to enable JavaScript to run this app.
导航
缓存数据库 Redis 版
  • 文档首页
    • /
  • 缓存数据库 Redis 版

CreateDBAccount

最近更新时间：2024.03.07 19:25:41

首次发布时间：2021.11.15 16:07:16

我的收藏

调用 CreateDBAccount 接口为指定 Redis 实例创建账号。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

InstanceId

String

是

redis-cn0212gzmh2xs****

实例 ID。

说明

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

AccountName

String

是

test1

账号名称。名称需同时满足如下要求：

  • 以小写字母开头，由小写字母或者数字结尾。
  • 长度为 2~16 个字符。
  • 由小写字母、数字、下划线（_）组成。

RoleName

String

是

ReadWrite

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

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

说明

关于各角色对应 ACL 规则支持的具体命令详情，请参见 ACL 语法。

Password

String

是

Pwd@12****

账号密码。密码需同时满足如下要求：

  • 长度为 8~30 个字符。
  • 至少包含大写字母、小写字母、数字或特殊字符中的任意 2 种。
  • 支持如下特殊字符：
    ()`~!@#$%^&*-+=_|{}[];<>,.?
DescriptionString否The_test_account账号描述，长度不超过 128 个字符。
ClientTokenString否WbiAlPqJM6tMoSOYhT****用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回数据

null

请求示例

POST https://redis.volcengineapi.com/?Action=CreateDBAccount&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",
	"Password": "Pwd@12****",
	"Description": "The_test_account"
}

返回示例

正常返回示例

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

错误码

更多详情，请参见错误码。