All Products
Search

This Product

    :CreateAccount

    Document Center

    :CreateAccount

    Last Updated:Oct 30, 2024

    Creates an account that has specific permissions for an ApsaraDB for Redis instance.

    Operation description

    Note

    • This operation is supported only for ApsaraDB for Redis instances that run Redis 4.0 or later.

    • The ApsaraDB for Redis instance for which you want to call this operation must be in the running state.

    • You can create up to 18 accounts for an ApsaraDB for Redis instance.

    You can also create an account in the ApsaraDB for Redis console. For more information, see Manage database accounts.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    kvstore:CreateAccountcreate
    • DBInstance
      acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance.

    		r-bp1zxszhcgatnx****
    AccountNamestringYes

    The name of the account. The name must meet the following requirements:

    • The name can contain lowercase letters, digits, and hyphens (-), and must start with a lowercase letter.
    • The name can be up to 100 characters in length.
    • The name cannot be one of the reserved words in the Reserved words for Redis account names section.
    		demoaccount
    AccountPrivilegestringNo

    The permissions of the account. Valid values:

    • RoleReadOnly: The account has read-only permissions.
    • RoleReadWrite: The account has read and write permissions.
    		RoleReadOnly
    AccountPasswordstringYes

    The password of the account. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and specific special characters. These special characters include ! @ # $ % ^ & * ( ) _ + - =

    		uWonno21****
    AccountDescriptionstringNo

    The description of the account.

    • The description must start with a letter, and cannot start with http:// or https://.
    • The description can contain letters, digits, underscores (_), and hyphens (-).
    • The description must be 2 to 256 characters in length.
    		testaccount
    AccountTypestringNo

    The type of the account. Set the value to Normal, which indicates that the account is a standard account.

    		Normal

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		ABAF95F6-35C1-4177-AF3A-70969EBD****
    InstanceIdstring

    The ID of the instance.

    		r-bp1zxszhcgatnx****
    AcountNamestring

    The name of the account.

    		demoaccount

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "ABAF95F6-35C1-4177-AF3A-70969EBD****",
  "InstanceId": "r-bp1zxszhcgatnx****",
  "AcountName": "demoaccount"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidAccountName.DuplicateSpecified AccountName already exists in this instance.The error message returned because the account already exists.
    400InvalidAccountName.FormatSpecified AccountName is not valid.-
    400InvalidEngineVersion.FormatCurrent EngineVersion does not support operations.The operation is not supported while the instance runs this engine version.
    400InvalidAccountDescription.FormatSpecified AccountDescription is not valid.-
    400InvalidAccountPassword.FormatSpecified AccountPassword is not valid.-
    400InvalidDBInstanceAccountMode.FormatCurrent DB instance AccountMode does not support this operation.-
    400InvalidAccountName.ForbidSpecified AccountName is a keyword.-
    400InvalidAccountPrivilege.MalformedSpecified account privilege is not valid.-
    403AccountLimitExceededExceeding the allowed amount of account.-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-07-11The Error code has changed. The request parameters of the API has changedView Change Details