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

查询IP地址组列表

功能介绍

查询IP地址组列表。

接口约束

  • 分页查询使用的参数为marker、limit、page_reverse。

  • marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/elb/ipgroups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

marker

否

String

参数解释：上一页最后一条记录的ID。

使用说明：

  • 必须与limit一起使用。

  • 不指定时表示查询第一页。

  • 该字段不允许为空或无效的ID。

limit

否

Integer

参数解释：每页返回的个数。

取值范围：0-2000

默认取值：2000

page_reverse

否

Boolean

参数解释：是否反向查询。

取值：

  • true：查询上一页。

  • false：查询下一页，默认。

使用说明：

  • 必须与limit一起使用。

  • 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。

id

否

Array of strings

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

name

否

Array of strings

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

description

否

Array of strings

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

ip_list

否

Array of strings

参数解释：IP地址，多个用逗号分隔。

enterprise_project_id

否

Array of strings

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

如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:ipgroups:list权限。

如果enterprise_project_id传值，鉴权按照企业项目权限鉴权，分为传入具体eps_id和all_granted_eps两种场景，前者查询指定eps_id的eps下的资源，后者查询的是所有有list权限的eps下的资源。

支持多值查询，查询条件格式：

enterprise_project_id=xxx&enterprise_project_id=xxx。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：IAM鉴权Token。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

ipgroups

Array of IpGroup objects

参数解释：IP地址组列表返回对象。

request_id

String

参数解释：请求ID。

注：自动生成 。

page_info

PageInfo object

参数解释：分页信息。
表5 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地址组的更新时间。
表6 IpInfo

参数

参数类型

描述

ip

String

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

description

String

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

参数

参数类型

描述

id

String

参数解释：监听器ID。
表8 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释：分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。

next_marker

String

参数解释：分页查询结果中最后一条记录的ID。通常用于查询下一页。

current_count

Integer

参数解释：当前的记录数。

请求示例

分页查询IP地址组列表

GET https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups?limit=1

响应示例

状态码：200

操作正常返回。

{
  "ipgroups" : [ {
    "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"
  } ],
  "page_info" : {
    "previous_marker" : "1d321f77-bc7b-45d3-9cfe-d7c0b65a3620",
    "current_count" : 1
  },
  "request_id" : "8d9f423c-8766-4b6a-9952-275a88ac1ce3"
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码。

父主题： IP地址组