You need to enable JavaScript to run this app.
导航
缓存数据库 Redis 版
  • 文档首页
    • /
  • 缓存数据库 Redis 版

DescribeAllowListDetail

最近更新时间：2023.07.28 15:54:47

首次发布时间：2022.05.18 12:01:49

我的收藏

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

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

AllowListId

String

是

acl-cn022p4qmcz2p26****

白名单 ID。

说明

您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。

返回数据

名称类型示例值描述
AllowListString10.1.***.***白名单内的 IP 地址列表。
AllowListDescStringapi_test白名单的备注。
AllowListIdStringacl-cnlf3xgczbjldzy****白名单 ID。
AllowListNameStringapi_test白名单名称。
AllowListTypeStringIPv4白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AssociatedInstancesArray of AssociatedInstanceInfo{
"InstanceId": "redis-cn02j292it8lc****",
"InstanceName": "test",
"VPC": "vpc-1g0moeeypecjk8ibuxwu8****"
}		已绑定当前白名单的实例信息。关于 AssociatedInstances 的更多信息，请参见数据结构。

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeAllowListDetail&Version=2020-12-07 HTTP/1.1
Host: redis.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.***.***",
         "AllowListDesc": "api_test",
         "AllowListId": "acl-cnlf3xgczbjldzy****",
         "AllowListName": "api_test",
         "AllowListType": "IPv4",
         "AssociatedInstances": [
             {
                 "InstanceId": "redis-cn02j292it8lc****",
                 "InstanceName": "test",
                 "VPC": "vpc-1g0moeeypecjk8ibuxwu8****"
             }
         ]
     }
}

错误码

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