功能介绍
查询IP地址组列表。
调用方法
请参见如何调用API。
URI
GET /v1/ip-groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
分页查询每页的资源个数。如果不设置，则默认为500。 最小值：1 最大值：2000 缺省值：500 |
|
marker |
否 |
String |
分页查询的起始的资源ID，表示上一页最后一条查询资源记录的ID。不指定时表示查询第一页。 必须与limit一起使用。 最小长度：1 最大长度：36 |
|
listener_id |
否 |
String |
监听器id,查询监听器绑定的IP地址组时使用该条件,当查询条件带listener_id时，结果中的associated_listeners也只包含该listener的记录 最小长度：0 最大长度：36 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
请求ID。 |
|
ip_groups |
IP地址组详情。 |
|
|
page_info |
分页查询页的信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
IP地址组ID。 |
|
name |
String |
IP地址组名称。 最小长度：1 最大长度：64 |
|
description |
String |
IP地址组描述。 最小长度：0 最大长度：255 |
|
status |
String |
配置状态，取值：
枚举值：
|
|
ip_list |
IP地址组中的IP网段列表。 |
|
|
associated_listeners |
监听器的访问控制策略。 |
|
|
created_at |
String |
创建时间。 |
|
updated_at |
String |
更新时间。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cidr |
String |
IP地址组中的IP网段，cidr格式。 最小长度：1 最大长度：50 |
|
description |
String |
IP地址组中的IP网段描述。 最小长度：0 最大长度：255 |
|
created_at |
String |
创建时间。 |
请求示例
查询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
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
操作成功 |
错误码
请参见错误码。
