文档首页/弹性负载均衡 ELB/API参考（联盟区域）/API（V3）/IP地址组/创建IP地址组
更新时间：2026-01-16 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建IP地址组

功能介绍

创建IP地址组。IP地址组用于关联监听器，设置监听器访问控制，指定可以访问或者禁止访问监听器的IP地址。

支持IPv4和IPv6类型地址，可以设置单个IP地址、IP地址段和连续IP地址范围。IP地址范围的格式为ip-ip，例如10.12.3.1-10.12.3.10。

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

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/elb/ipgroups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：项目ID。获取方式请参见获取项目ID。

约束限制：不涉及

取值范围：长度为32个字符，由小写字母和数字组成。

默认取值：不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：IAM鉴权Token。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

ipgroup

是

CreateIpGroupOption object

参数解释：创建IP地址组的请求参数。

约束限制：不涉及

表4 CreateIpGroupOption

参数

是否必选

参数类型

描述

project_id

否

String

参数解释：项目ID。获取方式请参见获取项目ID。

约束限制：不涉及

取值范围：长度为32个字符，由小写字母和数字组成。

默认取值：不涉及

说明：
该字段实际无效，最终使用url中的project_id。

description

否

String

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

约束限制：不涉及

取值范围：长度为0-255个字符。

默认取值：不涉及

name

否

String

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

约束限制：不涉及

取值范围：长度为0-255个字符。

默认取值：不涉及

ip_list

是

Array of CreateIpGroupIpOption objects

参数解释：IP地址组中的IP列表，支持IPv4和IPv6类型地址。

约束限制：不涉及

enterprise_project_id

否

String

参数解释：资源所属的企业项目ID。创建时不传则资源属于default企业项目，返回enterprise_project_id="0"。

约束限制：不能传入空字符串""、"0"或不存在的企业项目ID。

取值范围：不涉及

默认取值："0"

表5 CreateIpGroupIpOption

参数

是否必选

参数类型

描述

ip

是

String

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

约束限制：不涉及

取值范围：支持IPv4和IPv6地址类型，格式为单个IP地址、IP地址段或联系IP地址范围，IP地址范围格式为ip-ip，例如192.168.1.2-192.168.2.253或者2001:0DB8:02de::0e12-2001:0DB8:02de::0e13，终止IP需要大于起始IP。

默认取值：不涉及

description

否

String

参数解释：备注信息。

约束限制：不涉及

取值范围：长度为0-255个字符。

默认取值：不涉及

响应参数

状态码：201

表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

参数解释：资源所属的企业项目ID。

取值范围：

  • "0"：表示资源属于default企业项目。

  • UUID格式的字符串，表示非默认企业项目。

created_at

String

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

取值范围：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

updated_at

String

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

取值范围：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

表8 IpInfo

参数

参数类型

描述

ip

String

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

取值范围：IP地址段格式为ip-ip，例如192.168.1.2-192.168.2.253或者2001:0DB8:02de::0e12-2001:0DB8:02de::0e13，终止IP需要大于起始IP。

description

String

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

取值范围：长度为0-255个字符。

表9 ListenerRef

参数

参数类型

描述

id

String

参数解释：监听器ID。

取值范围：不涉及

请求示例

创建一个IP地址组，并指定其中包含的IP地址

POST https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups

{
  "ipgroup" : {
    "name" : "test_ipg",
    "ip_list" : [ {
      "ip" : "192.168.1.123"
    }, {
      "ip" : "192.168.3.0/24",
      "description" : "test_ip"
    }, {
      "ip" : "2001:0DB8:02de:0000:0000:0000:0000:0e13"
    } ]
  }
}

响应示例

状态码：201

参数解释：POST操作正常返回。

{
  "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"
  }
}

状态码

状态码

描述

201

参数解释：POST操作正常返回。

错误码

请参见错误码。

父主题：IP地址组