tencent cloud

APIs

DokumentasiAPIsTencent Cloud Distributed Cache (Redis OSS-Compatible)Instance APIsCreateInstanceAccount

CreateInstanceAccount

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-08-14 16:53:16

1. API Description

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

This API is used to customize the account for accessing instances.

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: CreateInstanceAccount.
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

Custom account name for accessing the database.

  • Consist of letters, digits, underscores, and hyphens only.
  • Length cannot be greater than 32.
AccountPassword Yes String

Set a password for the customized account. The password complexity requirements are as follows:

  • Character count: [8,64].
  • Contain at least two kinds of lowercase letters, uppercase letters, digits and characters ()`~!@#$%^&*-+=_|{}[]:;<>,.?/.
  • Cannot start with "/".
ReadonlyPolicy.N Yes Array of String

Read requests for the designated account are routed to the primary node or replica node. Read-only replica is not enabled, and selection of replica nodes is not supported.

  • master: primary node
  • replication: replica node
Privilege Yes String

Account read/write permission supports selecting read-only or read-write permission.

  • r: Read-only.
  • rw: Read-write.
Remark No String

Description information about account remarks, with a length of [0, 64] bytes.
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: CreateInstanceAccount
<Common request parameters>

{
    "InstanceId": "crs-n24q0sh7",
    "AccountName": "********test",
    "AccountPassword": "***********",
    "ReadonlyPolicy": [
        "master"
    ],
    "Privilege": "rw"
}

Output Example

{
    "Response": {
        "TaskId": 2031374330,
        "RequestId": "1b18b553-002f-4e71-95b8-2a7293286acf"
    }
}

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.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList The user is not in the allowlist.
Topik sebelumnya: CloseSSLTopik selanjutnya: CreateReplicationGroup

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan