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

缓存数据库 Redis 企业版

复制全文
白名单管理
DescribeAllowListDetail
复制全文
DescribeAllowListDetail

调用 DescribeAllowListDetail 接口查询目标白名单的详细信息,包括 IP 地址和绑定的实例详情。

请求类型

同步请求。

调试

请求参数

参数
类型
是否必选
示例值
描述
AllowListId
String
acl-cn022p4qmcz2p26****

白名单 ID。

说明

您可以调用 DescribeAllowLists 接口查询当前账号下在指定地域内的所有白名单列表信息,包括白名单 ID。

返回参数

参数
类型
示例值
描述
AllowListId
String
acl-cn022p4qmcz2p26****
白名单 ID。
AllowListCategory
String
Default

白名单的类型。取值范围如下:

  • Ordinary:普通白名单。
  • Default:默认白名单。
AllowListName
String
api_test
白名单名称。
AllowListDesc
String
test allowlist
白名单的备注。
AllowListType
String
DualStack
该字段已废弃不再使用,无需关注。
AllowList
String
10.1.***.***
白名单内的 IP 地址列表。
AssociatedInstances
Object[]
已绑定当前白名单的实例列表。
SecurityGroupBindInfos
Object[]

白名单关联的安全组的信息。

说明

仅当白名单中存在已关联的安全组时,才会返回该参数。

ProjectName
String
default
白名单所属的项目名称。
AssociatedInstanceNum
Integer
1
白名单已绑定的实例总数。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeAllowListDetail&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=****
{
    "AllowListId": "acl-cnlf3xgczbjldzy****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204151541400102120740810061****",
        "Action": "DescribeAllowListDetail",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowList": "10.0.***.***",
        "AllowListCategory": "Default",
        "AllowListDesc": "test allowlist",
        "AllowListId": "acl-cnlf3xgczbjldzy****",
        "AllowListName": "api_test",
        "AllowListType": "DualStack",
        "ProjectName": "default",
        "AssociatedInstances": [
            {
                "InstanceId": "redis-cn02j292it8lc****",
                "InstanceName": "test",
                "VPC": "vpc-1g0moeeypecjk8ibuxwu8****",
                "ProjectName": "default"
            }
        ],
        "SecurityGroupBindInfos": [
            {
                "BindMode": "AssociateEcsIp",
                "IpList": [
                    "100.64.***.***/10"
                ],
                "SecurityGroupId": "sg-rrzrivu0yc5cv0x588n****",
                "SecurityGroupName": "test-sg"
            }
        ],
        "AssociatedInstanceNum": 1
    }
}

错误码

更多详情,请参见错误码

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