文档中心

云搜索服务

实例管理

ModifyIpAllowList - 配置 IP 白名单

调用 ModifyIpAllowList 接口配置实例或可视化工具的访问白名单。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：ModifyIpAllowList

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

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

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

Type string 必选示例值：public``

需要配置的是公网还是私网白名单。

public：公网。

private：私网。

IpList string 必选示例值：10.23..,10.43..``

IP 白名单列表，当需要配置多个 IP 时，使用英文逗号（,）分隔。

IpList设置为空字符串时，表示清空白名单。

Component string 必选示例值：es``

需要配置白名单的对象。

kibana

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

需要修改节点配置的实例 ID

返回参数

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

Status string 示例值：SUCCESSFUL

返回的操作状态。

Message string 示例值：-

返回的提示信息。

请求示例

POST /?Action=ModifyIpAllowList&Version=2023-01-01​
Content-Type: application/json​
X-Date: 20231003T104027Z​
Authorization: HMAC-SHA256 ​
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****​
{​
    "Component": "es",​
    "InstanceId": "o-0080**iu98",​
    "IpList": "10.23..,10.43..",​
    "Type": "public"​
}​

返回示例

{​
    "Result": {​
        "Status": "SUCCESSFUL",​
        "Message": ""​
    },​
    "ResponseMetadata": {​
        "Action": "ModifyIpAllowList",​
        "Region": "cn-beijing",​
        "RequestId": "202306041104200100100232280**",​
        "Service": "escloud",​
        "Version": "2023-01-01"​
    }​
}​

错误码

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

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

最近更新时间：2026.04.01 10:37:03

这个页面对您有帮助吗？

有用

无用