文档首页/弹性负载均衡 ELB/API参考（安卡拉区域）/API（V3）/IP地址组/更新IP地址组
更新时间：2025-02-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新IP地址组

功能介绍

更新IP地址组，只支持全量更新IP。即IP地址组中的ip_list将被全量覆盖，不在请求参数中的IP地址将被移除。

输入的ip可为ip地址、CIDR子网或者ip地址段，格式为ip-ip，例如10.12.3.1-10.12.3.10，支持IPV4和IPV6。

需要注意0.0.0.0与0.0.0.0/32视为重复，0:0:0:0:0:0:0:1与::1与::1/128视为重复，只会保存其中一个。

调用方法

请参见如何调用API。

URI

PUT /v3/{project_id}/elb/ipgroups/{ipgroup_id}

表1 路径参数

参数

是否必选

参数类型

描述

ipgroup_id

是

String

参数解释：待更新的IP地址组的ID。

project_id

是

String

参数解释：项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：IAM鉴权Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

ipgroup

是

UpdateIpGroupOption object

参数解释：更新IP地址组请求体。

表4 UpdateIpGroupOption

参数

是否必选

参数类型

描述

description

否

String

参数解释：IP地址组的描述信息

name

否

String

参数解释：IP地址组的名称

ip_list

否

Array of UpadateIpGroupIpOption objects

参数解释：IP地址组中包含的IP列表。

表5 UpadateIpGroupIpOption

参数

是否必选

参数类型

描述

ip

是

String

参数解释：IP地址或者IP地址段。支持IPv4、IPv6。IP地址段格式为ip-ip，例如192.168.1.2-192.168.2.253或者2001:0DB8:02de::0e12-2001:0DB8:02de::0e13，终止IP需要大于起始IP。

若传入IP地址不存在，则新增；否则更新已有IP地址的描述信息。

description

否

String

参数解释：备注信息。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

ipgroup

IpGroup object

参数解释：更新IP地址组的响应体。

request_id

String

参数解释：请求ID。

注：自动生成 。

表7 IpGroup

参数

参数类型

描述

id

String

参数解释：IP地址组的ID。

name

String

参数解释：IP地址组的名称。

description

String

参数解释：IP地址组的描述信息。

ip_list

Array of IpInfo objects

参数解释：IP地址组中包含的IP或网段列表。[]表示任意IP。

listeners

Array of ListenerRef objects

参数解释：与IP地址组关联的监听器的ID列表。

project_id

String

参数解释：IP地址组的项目ID。

enterprise_project_id

String

参数解释：IP地址组所在的企业项目ID。

created_at

String

参数解释：IP地址组的创建时间。

updated_at

String

参数解释：IP地址组的更新时间。

表8 IpInfo

参数

参数类型

描述

ip

String

参数解释：IP地址组中的IP地址。

description

String

参数解释：IP地址组中ip的备注信息。

表9 ListenerRef

参数

参数类型

描述

id

String

参数解释：监听器ID。

请求示例

更新IP地址组中的所有IP地址

PUT https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups/8722e0e0-9cc9-4490-9660-8c9a5732fbb0

{
  "ipgroup" : {
    "name" : "test_ipg",
    "ip_list" : [ {
      "ip" : "192.168.1.123"
    }, {
      "ip" : "192.168.3.0/24",
      "description" : "test_ip"
    } ]
  }
}

响应示例

状态码：200

操作正常返回。

{
  "ipgroup" : {
    "description" : "",
    "id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
    "name" : "test_ipg",
    "project_id" : "45977fa2dbd7482098dd68d0d8970117",
    "ip_list" : [ {
      "ip" : "192.168.1.123",
      "description" : ""
    }, {
      "ip" : "192.168.3.0/24",
      "description" : "test_ip"
    } ],
    "listeners" : [ {
      "id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd"
    }, {
      "id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c"
    } ],
    "created_at" : "2018-01-16T03:19:16",
    "updated_at" : "2018-01-16T03:19:16"
  }
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码。

父主题：IP地址组