ModifyInstanceAccount

Last updated: 2025-10-28 22:21:53

ModifyInstanceAccount

Last updated: 2025-10-28 22:21:53

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 it in the instance list.
AccountName	Yes	String	Specifies the account that needs modification. - root: refers to the automatically generated account when a TencentDB for Redis® instance is created. Users cannot modify read-write permissions for the account, but can only modify its request routing policies. - Custom account: an account manually created by users after successful instance creation. Users can modify read-write permissions and request routing policies for the account at any time.
AccountPassword	No	String	Specifies the access password for the account to be modified.
Remark	No	String	Account description information.
ReadonlyPolicy.N	No	Array of String	Specifies the read-write request routing policies for the account to be modified. - master: read-write request routing to the primary node. - replication: read-write request routing to the secondary node.
Privilege	No	String	Specifies the read-write permissions for 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: set the default account (root) to a password-free account. - false: not set the default account (root) to a password-free account.
EncryptPassword	No	Boolean	Specifies whether to encrypt the password for the account to be modified.

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

https://redis.intl.tencentcloudapi.com/?Action=ModifyInstanceAccount
&InstanceId=crs-********
&AccountName=test_account
&<Common request parameters>

Output Example

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

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

Tencent Cloud CLI 3.0

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud