云数据库 Redis® 修改实例账号

1. 接口描述

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

本接口（ModifyInstanceAccount）用于修改实例账号。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyInstanceAccount。
Version	是	String	公共参数，本接口取值：2018-04-12。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID，请登录Redis控制台在实例列表复制实例 ID。示例值：crs-5a4py64p
AccountName	是	String	指定需修改的账号。 - root：指在创建 Redis 数据库实例时自动生成的账号。用户无法修改其读写权限，仅可修改其请求路由策略。 - 自定义的账号：用户在实例创建成功后手动创建的账号。用户可以随时修改其读写权限与请求路由策略。示例值：example_name
AccountPassword	否	String	指定所修改账号访问的密码。示例值：redis***
Remark	否	String	账号描述信息示例值：some account instruction
ReadonlyPolicy.N	否	Array of String	指定所修改账号读写请求路由的策略。 - master：表示读写请求路由至主节点。 - replication：表示读写请求路由至从节点。示例值：master
Privilege	否	String	指定所修改账号的读写权限。 - r：只读。 - w：只写。 - rw：读写。示例值：rw
NoAuth	否	Boolean	指定是否将默认账号（root）设置为免密账号。自定义账号不支持免密访问。 - true：默认账号（root）设置为免密账号。 - false：默认账号（root）不设置为免密账号。示例值：true
EncryptPassword	否	Boolean	指定所修改的账号是否加密密码示例值：false

3. 输出参数

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

4. 示例

示例1 请求示例

输入示例

https://redis.tencentcloudapi.com/?Action=ModifyInstanceAccount
&InstanceId=crs-********
&AccountName=test_account
&<公共请求参数>

输出示例

{
    "Response": {
        "TaskId": 123456,
        "RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.SystemError	内部系统错误，和业务无关。
FailedOperation.UnSupportError	实例不支持该接口。
InternalError.InternalError	内部错误。
InvalidParameter.PermissionDenied	接口没有cam权限。
ResourceUnavailable.GetSecurityError	获取安全组信息失败。
ResourceUnavailable.InstanceStatusError	实例状态异常，不能执行对应操作。
UnauthorizedOperation.NoCAMAuthed	无cam 权限。
UnauthorizedOperation.UserNotInWhiteList	用户不在白名单中。

修改实例账号

本页目录：