查询IP地址组列表 - ListIpGroups

功能介绍

查询IP地址组列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ga:ipgroup:list
List
ipgroup *
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ga:ipgroup:list	List	ipgroup *	-	-	-

URI

GET /v1/ip-groups

表1 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	分页查询每页的资源个数。如果不设置，则默认为500。
marker	否	String	分页查询的起始的资源ID，表示上一页最后一条查询资源记录的ID。不指定时表示查询第一页。必须与limit一起使用。
listener_id	否	String	监听器id,查询监听器绑定的IP地址组时使用该条件,当查询条件带listener_id时，结果中的associated_listeners也只包含该listener的记录

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
request_id	String	请求ID。
ip_groups	Array of IpGroupDetail objects	IP地址组详情。
page_info	PageInfo object	分页查询页的信息。

表4 IpGroupDetail
参数	参数类型	描述
id	String	IP地址组ID。
name	String	IP地址组名称。
description	String	IP地址组描述。
status	String	配置状态，取值： ACTIVE：运行中 PENDING：待定 ERROR：错误 DELETING：正在删除
ip_list	Array of IpInfo objects	IP地址组中的IP网段列表。
associated_listeners	Array of ListenerAccessControlPolicy objects	监听器的访问控制策略。
created_at	String	创建时间。
updated_at	String	更新时间。

表5 IpInfo
参数	参数类型	描述
cidr	String	IP地址组中的IP网段，cidr格式。
description	String	IP地址组中的IP网段描述。
created_at	String	创建时间。

表6 ListenerAccessControlPolicy
参数	参数类型	描述
listener_id	String	监听器ID。
type	String	访问控制策略类型,即黑名单还是白名单, 取值： BLACK：黑名单 WHITE：白名单

表7 PageInfo
参数	参数类型	描述
next_marker	String	下一页的marker，为空时表示最后一页。
current_count	Integer	当前列表中资源数量。

请求示例

查询IP地址组列表

GET https://{ga_endpoint}/v1/ip-groups

响应示例

状态码：200

操作成功

{
  "request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
  "ip_groups" : [ {
    "id" : "e8996cd6-28cf-4ff2-951e-fa8ac895a6cd",
    "name" : "ip-group-name",
    "description" : "ip-group description",
    "status" : "ACTIVE",
    "ip_list" : [ {
      "cidr" : "127.0.0.0/24",
      "description" : "cidr description",
      "created_at" : "2019-01-08T01:21:37.151Z"
    } ],
    "associated_listeners" : [ {
      "listener_id" : "1b11747a-b139-492f-9692-2df0b1c87193",
      "type" : "BLACK"
    } ],
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z"
  } ],
  "page_info" : {
    "next_marker" : "09e86f09-03fc-440e-8132-03f3e149e979",
    "current_count" : 10
  }
}