You need to enable JavaScript to run this app.
缓存数据库 Redis 企业版

缓存数据库 Redis 企业版

请输入
  • 文档首页
    • 缓存数据库 Redis 企业版API 参考白名单管理DescribeAllowLists
复制全文
我的收藏
白名单管理
DescribeAllowLists
复制全文
我的收藏
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
Object[]
白名单信息列表。

示例

请求示例 

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": "202204151541400102120740810061****",
        "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"
                    }
                ]
            }
        ]
    }
}

错误码

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

最近更新时间：2025.08.14 15:34:22
这个页面对您有帮助吗？
有用
有用
无用
无用