華為云計算 云知識 綁定IP地址組與監(jiān)聽器AssociateListener
綁定IP地址組與監(jiān)聽器AssociateListener

 

功能介紹

綁定IP地址組與監(jiān)聽器。 該接口屬于異步接口,接口返回后,后臺的綁定任務(wù)仍在執(zhí)行;可以使用查詢IP地址組詳情接口查詢狀態(tài),當(dāng)IP地址組狀態(tài)為ACTIVE時,表示綁定完成。

調(diào)用方法

請參見如何調(diào)用API。

URI

POST /v1/ip-groups/{ip_group_id}/associate-listener

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

ip_group_id

String

IP地址組ID。

最小長度:1

最大長度:36

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

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

表3 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

listener_id

String

監(jiān)聽器ID。

最小長度:0

最大長度:36

type

String

訪問控制策略類型,即黑名單還是白名單, 取值:

  • BLACK:黑名單

  • WHITE:白名單

枚舉值:

  • BLACK

  • WHITE

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

request_id

String

請求ID。

請求示例

綁定IP地址組與監(jiān)聽器,設(shè)置訪問控制策略類型為黑名單。

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

{
  "listener_id" : "e8996cd6-28cf-4ff2-951e-fa8ac895a6cd",
  "type" : "BLACK"
}

響應(yīng)示例

狀態(tài)碼: 200

操作成功

{
  "request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8"
}

狀態(tài)碼

狀態(tài)碼

描述

200

操作成功

錯誤碼

請參見錯誤碼。