You need to enable JavaScript to run this app.
Cache for Redis

Cache for Redis

  • Documentation
    • Cache for RedisDevelopment reference (Control plane)API referenceAccount managementDeleteDBAccount
Copy page
Download PDF
Account management
DeleteDBAccount
Copy page
Download PDF
DeleteDBAccount

Call the DeleteDBAccount API to delete a specified account.

Request type

Asynchronous request.

Precautions

You cannot delete a default account.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
redis-cn0212gzmh2xs****

Instance ID.

tip

You can call DescribeDBInstances to query the basic information of all Redis instances in a target region, including instance IDs.

AccountName
String
Yes
test1

The name of the account to be deleted.

tip

  • Deleting the default account is not allowed.
  • Call the ListDBAccount API to query the information of all accounts in a target Redis instance.
ClientToken
String
No
WbiAlPqJM6tMoSOYhT****
To ensure the idempotence of requests and prevent duplicate submission of requests.The client generates the parameter values to ensure the uniqueness among different requests. Values are case-sensitive, no more than 127 ASCII characters.

Response parameters

The current API has no specified response parameters. For more information, see Response structure.

Sample request 

POST https://redis.cn-beijing.volcengineapi.com/?Action=DeleteDBAccount&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****",
    "AccountName": "test1"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "202204152016280102120352272265****",
        "Action": "DeleteDBAccount",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.08.14 10:45:22