功能介紹
查詢IP地址組列表。
調(diào)用方法
請參見如何調(diào)用API。
URI
GET /v1/ip-groups
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
分頁查詢每頁的資源個(gè)數(shù)。如果不設(shè)置,則默認(rèn)為500。 最小值:1 最大值:2000 缺省值:500 |
|
marker |
否 |
String |
分頁查詢的起始的資源ID,表示上一頁最后一條查詢資源記錄的ID。不指定時(shí)表示查詢第一頁。 必須與limit一起使用。 最小長度:1 最大長度:36 |
|
listener_id |
否 |
String |
監(jiān)聽器id,查詢監(jiān)聽器綁定的IP地址組時(shí)使用該條件,當(dāng)查詢條件帶listener_id時(shí),結(jié)果中的associated_listeners也只包含該listener的記錄 最小長度:0 最大長度:36 |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)。 |
響應(yīng)參數(shù)
狀態(tài)碼: 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
request_id |
String |
請求ID。 |
|
ip_groups |
IP地址組詳情。 |
|
|
page_info |
分頁查詢頁的信息。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
IP地址組ID。 |
|
name |
String |
IP地址組名稱。 最小長度:1 最大長度:64 |
|
description |
String |
IP地址組描述。 最小長度:0 最大長度:255 |
|
status |
String |
配置狀態(tài),取值:
枚舉值:
|
|
ip_list |
IP地址組中的IP網(wǎng)段列表。 |
|
|
associated_listeners |
監(jiān)聽器的訪問控制策略。 |
|
|
created_at |
String |
創(chuàng)建時(shí)間。 |
|
updated_at |
String |
更新時(shí)間。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
cidr |
String |
IP地址組中的IP網(wǎng)段,cidr格式。 最小長度:1 最大長度:50 |
|
description |
String |
IP地址組中的IP網(wǎng)段描述。 最小長度:0 最大長度:255 |
|
created_at |
String |
創(chuàng)建時(shí)間。 |
請求示例
查詢IP地址組列表
GET https://{ga_endpoint}/v1/ip-groups
響應(yīng)示例
狀態(tài)碼: 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
}
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
操作成功 |
錯(cuò)誤碼
請參見錯(cuò)誤碼。
