文档中心

缓存数据库 Redis 版

白名单管理

DescribeAllowLists

调用 DescribeAllowLists 接口查询当前账号下在指定地域的 IP 白名单列表。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID。说明您可以调用 DescribeRegions接口查询 Redis 实例支持的所有地域信息，包括地域 ID。
InstanceId	String	否	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。若该参数留空，表示不使用实例 ID 条件进行筛选。
QueryDefault	Boolean	否	false	根据白名单类型筛选是否仅查询默认白名单。取值范围如下： true：是，仅查询默认白名单。 false：否，仅查询普通白名单。说明若该参数留空，表示不使用白名单类型条件进行筛选，即会返回所有类型的白名单信息。
IPAddress	String	否	100.64..,192.168..	根据 IP 地址筛选出满足条件的白名单。使用 IPAddress 查询时，会精确匹配该 IP 地址以及包含该 IP 地址的 IP 地址段进行筛选。说明若该参数留空，表示不使用 IP 地址对查询结果进行筛选。支持同时传入多个 IP 地址，最多同时传入 50 个 IP 地址。多个 IP 地址间用英文逗号（,）分隔。
IPSegment	String	否	100.64../10,192.168../32	根据 IP 地址段筛选出满足条件的白名单。使用 IPSegment 查询时，会精确匹配该 IP 地址段进行筛选。说明若该参数留空，表示不使用 IP 地址段对查询结果进行筛选。支持同时传入多个 IP 地址段，最多同时传入 50 个 IP 地址段。多个 IP 地址段间用英文逗号（,）分隔。
ProjectName	String	否	default	白名单所属的项目名称。说明若该参数留空，表示不使用白名单的项目名称条件进行筛选。

返回参数

参数	类型	示例值	描述
AllowLists	Array of AllowListObject	请参见返回示例。	白名单信息列表。

AllowListObject

参数	类型	示例值	描述
AllowListId	String	acl-cn02zv7944lzokt****	白名单 ID。
AllowListDesc	String	test allowlist	白名单的备注。
AllowListName	String	api_test	白名单名称。
AllowListType	String	DualStack	该字段已废弃不再使用，无需关注。
AllowListIPNum	Integer	1	白名单内的 IP 地址（或地址段）总数。
AssociatedInstanceNum	Integer	1	已绑定到当前白名单的实例数量。
ProjectName	String	default	白名单所属的项目名称。
AllowListCategory	String	Default	白名单的类型。取值范围如下： Ordinary：普通白名单。 Default：默认白名单。
SecurityGroupBindInfos	Array of SecurityGroupBindInfo	请参见返回示例。	当前白名单已关联的安全组信息列表。说明仅当白名单中存在已关联的安全组时，才会返回该参数。

SecurityGroupBindInfo

参数	类型	示例值	描述
IpList	Array of String	["100.64../10"]	已关联安全组中的 IP 列表。
BindMode	String	AssociateEcsIp	安全组关联模式。取值范围如下： IngressDirectionIp：入方向 IP，即允许安全组入方向的源地址中 TCP 协议和 ALL 协议涉及的 IP 访问数据库，若源地址中配置为安全组将被忽略。 AssociateEcsIp：关联 ECS IP，即允许安全组内的云服务器访问数据库，当前仅支持主网卡的 IP 信息导入。说明关于安全组关联模式的更多详情，请参见创建白名单。
SecurityGroupId	String	sg-rrzrivu0yc5cv0x588n****	已关联的安全组 ID。
SecurityGroupName	String	test-sg	已关联的安全组名称。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeAllowLists&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=****​
{​
	"RegionId": "cn-beijing",​
	"InstanceId": "redis-cn0232ip1hewz****"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2022041515414001021207408100610061",​
        "Action": "DescribeAllowLists",​
        "Version": "2020-12-07",​
        "Service": "Redis",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "AllowLists": [​
            {​
                "AllowListCategory": "Default",​
                "AllowListDesc": "test allowlist",​
                "AllowListIPNum": 1,​
                "AllowListId": "acl-cnlf3xgczbjldzy****",​
                "AllowListName": "api_test",​
                "AllowListType": "DualStack",​
                "AssociatedInstanceNum": 1,​
                "ProjectName": "default",​
                "SecurityGroupBindInfos": [​
                    {​
                        "BindMode": "AssociateEcsIp",​
                        "IpList": [​
                            "100.64.***.***/10"​
                        ],​
                        "SecurityGroupId": "sg-rrzrivu0yc5cv0x588n****",​
                        "SecurityGroupName": "test-sg"​
                    }​
                ]​
            }​
        ]​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.09.21 14:23:31

这个页面对您有帮助吗？

有用

无用