ModifyWhiteIps
更新指定实例的访问白名单
服务地址：
华东1 金融云
输入参数
只看必填
InstanceId实例ID
clientToken用于保证请求的幂等性
body请求体参数
nodeType节点类型
networkType网络类型
modifyMode修改方式
whiteIpListIP地址白名单列表
0IP地址白名单列表
添加
whiteIpGroup以白名单组方式更新实例白名单配置
groupName白名单组的组名
ips白名单组中的IP地址列表
0白名单组中的IP地址列表
添加
whiteIpTypeIP白名单的类型
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

注意事项

  • 实例状态为生效中（activating）、失效（invalid）和冻结（inactive），无法更新信息。
  • 您可以通过两种方式更新白名单：IP 白名单列表和 IP 白名单组。两种方式不能同时使用，且除了 InstanceId 和 clientToken 外，两种方式支持配置的参数也不同，具体如下：
    • IP 白名单列表：whiteIpList、nodeType、networkType
    • IP 白名单组：modifyMode、whiteIpGroup
  • 公网访问白名单不支持配置私网 IP 地址，私网访问白名单不支持配置公网 IP 地址。

请求语法

PATCH /openapi/instances/{InstanceId}/actions/modify-white-ips HTTP/1.1
POST /openapi/instances/{InstanceId}/actions/modify-white-ips HTTP/1.1

路径参数

字段名称字段详情
InstanceIdstring

实例 ID。

示例值:es-cn-0pp1jxvcl000z****参考取值来源:
    ListInstance

请求参数

字段名称字段详情
clientTokenstring

用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ascii 字符。

示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodyobject

请求体参数。

请求说明

注意 白名单组的增加和删除是由 modifyMode 为 Cover 的调用来实现的，Delete 和 Append 无法实现白名单组粒度的增删，只能修改白名单组中的 IP 地址列表。具体说明如下：

  • modifyMode 为 Cover 时，如果 ips 为空，则删除该白名单组。如果 groupName 不在已有白名单组组名的列表中，则会新建一个白名单组。
  • modifyMode 为 Delete 时，删除后的 ips 至少需要保留一个 IP 地址。
  • modifyMode 为 Append 时，需要保证白名单组组名为已创建，否则会提示 NotFound 的错误。

返回参数

字段名称字段详情
Resultboolean

返回结果：展开详情

示例值:true
RequestIdstring

请求 ID。

示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG
变更历史
变更时间变更内容概要操作
2022-01-18
删除请求参数nodeType
删除请求参数networkType
删除请求参数modifyMode
删除请求参数whiteIpList
删除请求参数whiteIpGroup
新增请求参数body