文档首页/ 分布式缓存服务 DCS/ API参考（巴黎区域）/ API V2（推荐）/ 网络安全/ 查询指定实例的IP白名单
更新时间：2023-12-13 GMT+08:00
查看PDF
分享

查询指定实例的IP白名单

功能介绍

查询指定实例的IP白名单。

URI

GET /v2/{project_id}/instance/{instance_id}/whitelist

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

instance_id

String

实例ID。

enable_whitelist

Boolean

是否启用白名单（true/false）。

枚举值：

  • true

  • false

whitelist

Array of Whitelist objects

IP白名单分组列表。
表3 Whitelist

参数

参数类型

描述

group_name

String

白名单分组名称，每个实例支持创建4个分组。

ip_list

Array of strings

白名单分组下的IP列表,每个实例最多可以添加20个IP地址/地址段。如果有多个，可以用逗号分隔。不支持的IP和地址段：0.0.0.0和0.0.0.0/0。

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist

响应示例

状态码： 200

查询实例白名单成功。

{
  "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
  "enable_whitelist" : true,
  "whitelist" : [ {
    "group_name" : "test001",
    "ip_list" : [ "10.10.10.1", "10.10.10.2" ]
  } ]
}

状态码

状态码

描述

200

查询实例白名单成功。

错误码

请参见错误码。

父主题： 网络安全