DescribeAllowLists--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribeAllowLists

最近更新时间：2024.10.24 21:25:12首次发布时间：2022.05.18 12:01:49

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

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID。说明您可以调用 DescribeRegions 接口查询 Redis 实例支持的所有地域信息，包括地域 ID。
InstanceId	String	否	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。若该参数留空，表示不使用实例 ID 条件进行筛选。
QueryDefault	Boolean	否	false	根据白名单类型筛选是否仅查询默认白名单。取值范围如下： `true`：是，仅查询默认白名单。 `false`：否，仅查询普通白名单。说明若该参数留空，表示不使用白名单类型条件进行筛选，即会返回所有类型的白名单信息。

返回参数

参数	类型	示例值	描述
AllowLists	Object[]		白名单信息列表。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeAllowLists&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=****
{
	"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": "api_test",
                 "AllowListIPNum": 1,
                 "AllowListId": "acl-cnlf3xgczbjldzy****",
                 "AllowListName": "api_test",
                 "AllowListType": "IPv4",
                 "AssociatedInstanceNum": 1
             }
         ]
     }
}

错误码

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