華為云計(jì)算 云知識(shí) 查詢IP地址組詳情ShowIpGroup
查詢IP地址組詳情ShowIpGroup

 

功能介紹

查詢IP地址組詳情。

調(diào)用方法

請(qǐng)參見(jiàn)如何調(diào)用API。

URI

GET /v1/ip-groups/{ip_group_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

ip_group_id

String

IP地址組ID。

最小長(zhǎng)度:1

最大長(zhǎng)度:36

請(qǐng)求參數(shù)

表2 請(qǐng)求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)。

響應(yīng)參數(shù)

狀態(tài)碼: 200

表3 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

request_id

String

請(qǐng)求ID。

ip_group

IpGroupDetail object

IP地址組詳情。

表4 IpGroupDetail

參數(shù)

參數(shù)類型

描述

id

String

IP地址組ID。

name

String

IP地址組名稱。

最小長(zhǎng)度:1

最大長(zhǎng)度:64

description

String

IP地址組描述。

最小長(zhǎng)度:0

最大長(zhǎng)度:255

status

String

配置狀態(tài),取值:

  • ACTIVE:運(yùn)行中

  • PENDING:待定

  • ERROR:錯(cuò)誤

  • DELETING:正在刪除

枚舉值:

  • ACTIVE

  • PENDING

  • ERROR

  • DELETING

ip_list

Array of IpInfo objects

IP地址組中的IP網(wǎng)段列表。

associated_listeners

Array of ListenerAccessControlPolicy objects

監(jiān)聽(tīng)器的訪問(wèn)控制策略。

created_at

String

創(chuàng)建時(shí)間。

updated_at

String

更新時(shí)間。

表5 IpInfo

參數(shù)

參數(shù)類型

描述

cidr

String

IP地址組中的IP網(wǎng)段,cidr格式。

最小長(zhǎng)度:1

最大長(zhǎng)度:50

description

String

IP地址組中的IP網(wǎng)段描述。

最小長(zhǎng)度:0

最大長(zhǎng)度:255

created_at

String

創(chuàng)建時(shí)間。

表6 ListenerAccessControlPolicy

參數(shù)

參數(shù)類型

描述

listener_id

String

監(jiān)聽(tīng)器ID。

type

String

訪問(wèn)控制策略類型,即黑名單還是白名單, 取值:

  • BLACK:黑名單

  • WHITE:白名單

枚舉值:

  • BLACK

  • WHITE

請(qǐng)求示例

查詢IP地址組詳情

GET https://{ga_endpoint}/v1/ip-groups/e8996cd6-28cf-4ff2-951e-fa8ac895a6cd

響應(yīng)示例

狀態(tài)碼: 200

操作成功

{
  "request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
  "ip_group" : {
    "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"
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

操作成功

錯(cuò)誤碼

請(qǐng)參見(jiàn)錯(cuò)誤碼