调用CreateAccount创建实例账号-云数据库 Tair（兼容 Redis®）-阿里云-云数据库 Tair（兼容 Redis®）(Tair)-阿里云帮助中心

接口说明

该 API 仅支持兼容 Redis 4.0 及以上版本的实例；
使用该 API 需要实例状态为运行中；
一个实例下最多可创建 18 个账号。

说明

该 API 对应的控制台操作请参见账号管理。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

kvstore:CreateAccount

create

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	r-bp1zxszhcgatnx****
AccountName	string	是	账号名，需满足以下条件：以英文字母开头，由小写英文字母、数字或下划线（_）组成。长度不超过 100 个字符。不能为Redis 账号名保留字。	demoaccount
AccountPrivilege	string	否	账号权限，取值： RoleReadOnly：只读权限。 RoleReadWrite：读写权限，默认值。	RoleReadOnly
AccountPassword	string	是	账号的密码。长度为 8~32 位，需包含大写字母、小写字母、特殊字符和数字中的至少三种，允许的特殊字符包括`!@#$%^&*()_+-=`。	uWonno21****
AccountDescription	string	否	账号描述。需以中文、英文字母开头，不能以`http: //`或`https: //`开头。可以包含中文、英文字母、数字、下划线（_）和短划线（-）。长度为 2~256 个字符。	testaccount
AccountType	string	否	账号类型，取值固定为 Normal（普通账号）。	Normal
SourceBiz	string	否	本参数仅用于内部维护，无需传入。	SDK
Parameters	string	否	需修改的账号参数，格式为 JSON，修改后的值会覆盖原来的值。重要该参数目前仅支持 Tair Serverless KV 实例。	{"access-db-id":"1","cu-limit":"10"}

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	ABAF95F6-35C1-4177-AF3A-70969EBD****
InstanceId	string	实例 ID。	r-bp1zxszhcgatnx****
AcountName	string	本参数已废弃。	demoaccount
AccountName	string	账号名称。	demoaccount

示例

正常返回示例

JSON格式

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

异常返回示例

JSON格式

{
 "RequestId":"ABAF95F6-35C1-4177-AF3A-70969EBDF624",
 "AcountName":"test2"
}

错误码

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

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

变更历史

更多信息，参考变更详情。