華為云計算 云知識 更新IP地址組UpdateIpGroup
更新IP地址組UpdateIpGroup

 

功能介紹

更新IP地址組。

調用方法

請參見如何調用API。

URI

PUT /v1/ip-groups/{ip_group_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

ip_group_id

String

IP地址組ID。

最小長度:1

最大長度:36

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過調用 IAM 服務獲取用戶Token接口獲?。憫㈩^中X-Subject-Token的值)。

表3 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

ip_group

UpdateIpGroupOption object

更新IP地址組的詳細信息。

表4 UpdateIpGroupOption

參數(shù)

是否必選

參數(shù)類型

描述

name

String

IP地址組名稱,取值范圍:1~64個字符之間,只能由數(shù)字、字母、中劃線和中文組成。

最小長度:1

最大長度:64

description

String

IP地址組的描述信息,取值范圍:0~255個字符之間,禁止輸入字符:<>。

最小長度:0

最大長度:255

響應參數(shù)

狀態(tài)碼: 200

表5 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

request_id

String

請求ID。

ip_group

IpGroupDetail object

IP地址組詳情。

表6 IpGroupDetail

參數(shù)

參數(shù)類型

描述

id

String

IP地址組ID。

name

String

IP地址組名稱。

最小長度:1

最大長度:64

description

String

IP地址組描述。

最小長度:0

最大長度:255

status

String

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

  • ACTIVE:運行中

  • PENDING:待定

  • ERROR:錯誤

  • DELETING:正在刪除

枚舉值:

  • ACTIVE

  • PENDING

  • ERROR

  • DELETING

ip_list

Array of IpInfo objects

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

associated_listeners

Array of ListenerAccessControlPolicy objects

監(jiān)聽器的訪問控制策略。

created_at

String

創(chuàng)建時間。

updated_at

String

更新時間。

表7 IpInfo

參數(shù)

參數(shù)類型

描述

cidr

String

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

最小長度:1

最大長度:50

description

String

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

最小長度:0

最大長度:255

created_at

String

創(chuàng)建時間。

表8 ListenerAccessControlPolicy

參數(shù)

參數(shù)類型

描述

listener_id

String

監(jiān)聽器ID。

type

String

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

  • BLACK:黑名單

  • WHITE:白名單

枚舉值:

  • BLACK

  • WHITE

請求示例

更新IP地址組的名稱和描述信息

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

{
  "ip_group" : {
    "name" : "ip-group-name",
    "description" : "ip-group description"
  }
}

響應示例

狀態(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

操作成功

錯誤碼

請參見錯誤碼。