Docs

Cache for Redis

Allowlist management

AssociateAllowList

Call the AssociateAllowList API to associate the target instance to the specified IP address allowlist.

Request type

Asynchronous request.

Precautions

When using the allowlist in Cache for Redis, there are some constraints and limitations. For the details, please refer to Creating an allowlist.

For data security reasons, adding address 0.0.0.0/0 to the instance's allowlist is not allowed while enabling passwordless access. If you need to set address 0.0.0.0/0 in the allowlist, disable the instance's password-free access feature first. For more information on password-free access, refer to ModifyDBInstanceVpcAuthMode.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameters	Type	Required	Example	Description
InstanceIds	Array of String	Yes	["redis-cn0212gzmh2xs****"]	ID of the instance to associate with an allowlist. tip You can call the DescribeDBInstances API to query the basic information of all Redis instances in the target region, including the instance ID. You cannot pass multiple instance IDs and multiple allowlists at the same time. You can only associate multiple instances with one allowlist, or one instance with multiple allowlists.
AllowListIds	Array of String	Yes	["acl-cn02f66vyjw7aj9**","acl-cn02iaiectnt2ls**"]	The ID of the allowlist to associate with the instance. tip You can call the DescribeAllowLists API to query information about all allowlists in a specified region, including their allowlist IDs. You can pass multiple allowlist IDs, separated by commas (,). You cannot pass multiple instance IDs and multiple allowlists at the same time. You can only associate multiple instances with one allowlist, or one instance with multiple allowlists.
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.

Example

Request example

POST https://redis.cn-beijing.volcengineapi.com/?Action=AssociateAllowList&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=****​
{​
    "InstanceIds": [​
        "redis-cn0212gzmh2xs****"​
    ],​
    "AllowListIds": [​
        "acl-cn02f66vyjw7aj9****",​
        "acl-cn02iaiectnt2ls****"​
    ]​
}​

Response example

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

Error code

For more details, see Error code.

Last updated: 2026.09.21 15:01:12