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

DescribeAllowLists

最近更新时间：2024.04.12 13:02:06

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

我的收藏

调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息。

请求类型

同步请求。

请求参数

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

RegionId

String

是

cn-beijing

地域 ID。

说明

您可以调用 DescribeRegions 接口查询 Redis 实例支持的所有地域信息，包括地域 ID。

InstanceId

String

否

redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

返回数据

名称类型示例值描述
AllowListsArray of AllowListInfo请参见返回示例。白名单信息列表。关于 AllowLists 的详细说明，请参见数据结构。

请求示例

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": [
             {
                 "AllowListDesc": "api_test",
                 "AllowListIPNum": 1,
                 "AllowListId": "acl-cnlf3xgczbjldzy****",
                 "AllowListName": "api_test",
                 "AllowListType": "IPv4",
                 "AssociatedInstanceNum": 1
             }
         ]
     }
}

错误码

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