tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CreateInstanceAccount

最后更新时间：2024-04-03 11:33:27

    1. API Description

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

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

    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 No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID.
    AccountName Yes String Custom the name of the database to access.
    - Contains only letters, digits, underscores, and hyphens.
    - The length cannot exceed 32 characters.
    AccountPassword Yes String Set a password for the customized account. The password complexity requirements are as follows:
    - Value range: [8, 32].
    - Contains at least two types of characters from the following categories: lowercase letters, uppercase letters, digits, and characters ()`~!@#$%^&*-+=_|{}[]:;<>,.? /.- Cannot start with "/".
    ReadonlyPolicy.N Yes Array of String The read requests for the designated account are routed to either the master node or replica nodes. If the Read-Only Replica is not enabled, the selection of replica nodes is not supported.
    - master: Master node.- replication: Replica node.
    Privilege Yes String The read/write permission of the account supports the selection of read-only and read/write permissions.
    - r: read-only
    - rw: Read/Write permission.
    Remark No String Sub-account description information, with a length of [0, 64] bytes, supports Chinese characters.

    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 Sample Request

    Input Example

    https://redis.tencentcloudapi.com/?Action=CreateInstanceAccount
&InstanceId=crs-evst****
&AccountName=redis_dev
&AccountPassword=c1evuh****
&ReadonlyPolicy.0=master
&Privilege=rw
&Remark="Development 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

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款