tencent cloud

APIs

文档APIsTencent Cloud Distributed Cache (Redis OSS-Compatible)Instance APIsModifyInstanceAccount

ModifyInstanceAccount

Download
聚焦模式
字号
最后更新时间： 2026-08-14 16:52:51

1. API Description

Domain name for API request: redis.intl.tencentcloudapi.com.

This API is used to modify an instance account.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyInstanceAccount.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String

Instance ID. Log in to the Redis console and copy the instance ID from the instance list.
AccountName Yes String

Specify the account that needs modification.

  • root: refers to the automatically generated account when a Redis Database Instance is created. Users cannot modify its read-write permissions, but can only modify its request routing strategy.
  • Custom account: an account manually created by users once an instance is created successfully. Users can modify its read and write permissions and request routing strategy at any time.
AccountPassword No String

Specifies the access password for the account to be modified.
Remark No String

Account description.
ReadonlyPolicy.N No Array of String

Specify the policy for request routing of read-write requests for the modified account.

  • master: means read-write requests are routed to the primary node.
  • replication: means read-write requests are routed to the secondary node.
Privilege No String

Specify the read/write permission of the account to be modified.

  • r: Read-only.
  • w: Write-only.
  • rw: Read-write.
NoAuth No Boolean

Specifies whether to set the default account (root) to a password-free account. Custom accounts do not support password-free access.

  • true: The default account (root) is set to a password-free account.
  • false: The default account (root) is not set to a password-free account.
EncryptPassword No Boolean

Whether to enable password encryption for transmission.

  • true: Encrypted.
  • false: Not encrypted (default value).

3. Output Parameters

Parameter Name Type Description
TaskId Integer

Task ID.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Request Example

Input Example

POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceAccount
<Common request parameters>

{
    "InstanceId": "crs-azaq****",
    "AccountName": "*e******test"
}

Output Example

{
    "Response": {
        "TaskId": 2031373742,
        "RequestId": "7575fa3d-bb9f-4cc0-a050-4e4e33ed5bb3"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
FailedOperation.UnSupportError The instance does not support this API.
InternalError.InternalError Internal error.
InvalidParameter.PermissionDenied The API has no CAM permissions.
ResourceUnavailable.GetSecurityError Failed to get the security group information.
ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList The user is not in the allowlist.
上一篇: ModifyInstance下一篇: ModifyInstanceReadOnly

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈