创建实例子账号

最近更新时间:2024-03-12 01:45:17

我的收藏

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

该接口(CreateInstanceAccount)用于自定义访问实例的账号。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateInstanceAccount。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID。
示例值:crs-5a4py64p
AccountName String 自定义访问数据库的名称。
- 仅由字母、数字、下划线、中划线组成。
- 长度不能大于32位。
示例值:test
AccountPassword String 设置自定义账号的密码。密码复杂度要求如下:
- 字符个数为[8,32]。
- 至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的两种。
- 不能以"/"开头。

示例值:1234567aA
ReadonlyPolicy.N Array of String 指定账号的读请求路由分发至主节点或副本节点。未开启副本只读,不支持选择副本节点。
- master:主节点
- replication:副本节点
示例值:["master"]
Privilege String 账户读写权限,支持选择只读与读写权限。
- r:只读
- rw: 读写权限
示例值:rw
Remark String 子账号描述信息,长度[0,64] 字节,支持中文。
示例值:""

3. 输出参数

参数名称 类型 描述
TaskId Integer 任务ID
示例值:123456
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://redis.tencentcloudapi.com/?Action=CreateInstanceAccount
&InstanceId=crs-evst****
&AccountName=redis_dev
&AccountPassword=c1evuh****
&ReadonlyPolicy.0=master
&Privilege=rw
&Remark="开发账号"
&<公共请求参数>

输出示例

{
    "Response": {
        "TaskId": 114805324,
        "RequestId": "2cd067fd-71db-4d8f-b0ac-4e83********"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
FailedOperation.UnSupportError 实例不支持该接口。
InternalError.InternalError 内部错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
UnauthorizedOperation.UserNotInWhiteList 用户不在白名单中。