文档首页/ 分布式缓存服务 DCS/ API参考 (联盟区域) / API V2（推荐）/ 网络安全/ 查询指定实例的IP白名单
更新时间：2025-12-29 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。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

enable_whitelist

Boolean

参数解释：

是否启用白名单。

取值范围：

true：启用白名单。

false：未启用白名单。

whitelist

Array of WhitelistResp objects

参数解释：

实例当前IP白名单列表。

whitelist_ip_limit_num

String

参数解释：

租户实例添加IP白名单的最大IP数量限制。

取值范围：

不涉及。
表3 WhitelistResp

参数

参数类型

描述

group_name

String

参数解释：

白名单分组名称。

取值范围：

不涉及。

ip_list

Array of strings

参数解释：

白名单分组下的IP列表。

取值范围：

不涉及。

请求示例

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" ]
  } ],
  "whitelist_ip_limit_num" : 20
}

状态码

状态码

描述

200

查询实例白名单成功。

错误码

请参见错误码。

父主题： 网络安全