ModifyInstanceAccount

Prev Next

search by keyword

Recent Pages

Documentation

Last updated: 2021-11-18 10:45:29

1. API Description

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

This API is used to modify an instance sub-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 parameter. The value used for this API: ModifyInstanceAccount.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID
AccountName	Yes	String	Sub-account name. If the root account is to be modified, enter `root`
AccountPassword	No	String	Sub-account password
Remark	No	String	Sub-account description information
ReadonlyPolicy.N	No	Array of String	Sub-account routing policy. Enter `master` to route to the primary node or `slave` to route to the secondary node
Privilege	No	String	Sub-account read/write policy. Enter `r` for read-only, `w` for write-only, or `rw` for read/write
NoAuth	No	Boolean	true: make the root account password-free. This is applicable to root accounts only; sub-accounts cannot be made password-free

3. Output Parameters

Parameter Name	Type	Description
TaskId	Integer	Task ID
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://redis.tencentcloudapi.com/?Action=ModifyInstanceAccount
&InstanceId=crs-5a4py64p
&AccountName=test
&<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.
InternalError.InternalError	Internal error.
ResourceUnavailable.GetSecurityError	Failed to get the security group information.
UnauthorizedOperation.NoCAMAuthed	No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList	The user is not in the allowlist.

Recent Pages