文档

CreateAccount - 创建账号

更新时间:
一键部署

可以在Redis实例中创建有特定权限的账号。

接口说明

说明
  • 该 API 仅支持 4.0 或以上版本的 Redis 实例;
  • 使用该 API 需要实例状态为运行中;
  • 一个实例下最多可创建 18 个账号。
  • 该 API 对应的控制台操作请参见账号管理

    调试

    您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    InstanceIdstring

    实例 ID。

    r-bp1zxszhcgatnx****
    AccountNamestring

    账号名,需满足以下条件:

    • 以英文字母开头,由小写英文字母、数字或下划线(_)组成。
    • 长度不超过 100 个字符。
    • 不能为 Redis 账号名保留字
    demoaccount
    AccountPrivilegestring

    账号权限,取值:

    • RoleReadOnly:只读权限。
    • RoleReadWrite:读写权限,默认值。
    RoleReadOnly
    AccountPasswordstring

    账号的密码。长度为 8~32 位,需包含大写字母、小写字母、特殊字符和数字中的至少三种,允许的特殊字符包括!@#$%^&*()_+-=

    uWonno21****
    AccountDescriptionstring

    账号描述。

    • 需以中文、英文字母开头,不能以http: //https: //开头。
    • 可以包含中文、英文字母、数字、下划线(_)和短划线(-)。
    • 长度为 2~256 个字符。
    testaccount
    AccountTypestring

    账号类型,取值固定为 Normal(普通账号)。

    Normal
    SourceBizstring

    本参数仅用于内部维护,无需传入。

    SDK

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    ABAF95F6-35C1-4177-AF3A-70969EBD****
    InstanceIdstring

    实例 ID。

    r-bp1zxszhcgatnx****
    AcountNamestring

    账号名称。

    demoaccount

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "ABAF95F6-35C1-4177-AF3A-70969EBD****",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "AcountName": "demoaccount"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidAccountName.DuplicateSpecified AccountName already exists in this instance.当前账户名已经存在于此实例,请选择新的 AccountName 参数
    400InvalidAccountName.FormatSpecified AccountName is not valid.-
    400InvalidEngineVersion.FormatCurrent EngineVersion does not support operations.当前实例引擎版本号不支持此操作
    400InvalidAccountDescription.FormatSpecified AccountDescription is not valid.-
    400InvalidAccountPassword.FormatSpecified AccountPassword is not valid.-
    400InvalidDBInstanceAccountMode.FormatCurrent DB instance AccountMode does not support this operation.-
    400InvalidAccountName.ForbidSpecified AccountName is a keyword.-
    400InvalidAccountPrivilege.MalformedSpecified account privilege is not valid.-
    403AccountLimitExceededExceeding the allowed amount of account.-

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-07-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情