文档中心

云搜索服务

实例查询

DescribeIpAllowList - 查询 IP 白名单

调用 DescribeIpAllowList 接口，查询实例或可视化工具的访问白名单、白名单分组。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeIpAllowList

要执行的操作，取值：DescribeIpAllowList。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceId string 必选示例值：o-0080**iu98

实例 ID。

Type string[] 可选示例值：["PRIVATE_ES"]

需要查询的网络类型，可多选，缺省表示所有类型。

PRIVATE_ES：实例私网访问。

PRIVATE_KIBANA：可视化私网访问。

PUBLIC_ES：实例公网访问。

PUBLIC_KIBANA：可视化公网访问。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

IpAllowList object[] 示例值：[ { "Type": "PRIVATE_ES", "AllowList": "10.0.0.0/16,192.168.1.1", "Groups": [ { "Name": "group1", "AllowList": "10.0.0.0/16,192.168.1.1" } ] } ]

IP 白名单信息。

Type string 示例值：PRIVATE_ES

网络类型。

PRIVATE_ES: 实例私网访问。

PRIVATE_KIBANA: 可视化私网访问。

PUBLIC_ES: 实例公网访问。

PUBLIC_KIBANA: 可视化公网访问。

AllowList string 示例值：10.0.0.0/16,192.168.1.1

默认分组 IP 白名单列表，多个 IP 使用英文逗号（,）分隔。

Groups object[] 示例值：[ { "Name": "group1", "AllowList": "10.0.0.0/16,192.168.1.1" } ]

自定义分组 IP 白名单。

Name string 示例值：group1

自定义分组名称。

AllowList string 示例值：10.0.0.0/16,192.168.1.1

自定义分组 IP 白名单列表，不能为空，当需要配置多个 IP 时，使用英文逗号（,）分隔。

请求示例 1

返回示例 1

请求示例 2

返回示例 2

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	Unauthorized	unauthorized error	用户无权限调用接口。
200	IllegalParameter	illegal parameter	参数非法。原因可能是参数缺失或不符合接口要求。
200	InternalServerError	服务器内部异常	服务由于异常退出，无法完成接口请求操作。

最近更新时间：2026.04.01 10:05:52

这个页面对您有帮助吗？

有用

无用