華為云計算 云知識 更新監(jiān)聽器UpdateListenerga
更新監(jiān)聽器UpdateListenerga

 

功能介紹

更新監(jiān)聽器。

調(diào)用方法

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

URI

PUT /v1/listeners/{listener_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

listener_id

String

監(jiān)聽器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

UpdateListenerOption object

更新監(jiān)聽器的詳細(xì)信息。

表4 UpdateListenerOption

參數(shù)

是否必選

參數(shù)類型

描述

name

String

監(jiān)聽器名稱,取值范圍:1~64個字符之間,只能由數(shù)字、字母、中劃線和中文組成。

最小長度:1

最大長度:64

description

String

監(jiān)聽器的描述信息,取值范圍:0~255個字符之間,禁止輸入字符:<>。

最小長度:0

最大長度:255

port_ranges

Array of PortRange objects

監(jiān)聽端口范圍列表。

數(shù)組長度:1 - 10

client_affinity

String

客戶端親和性,取值:

  • SOURCE_IP:按源IP保持會話。

  • NONE:關(guān)閉。

枚舉值:

  • SOURCE_IP

  • NONE

表5 PortRange

參數(shù)

是否必選

參數(shù)類型

描述

from_port

Integer

起始端口。

最小值:1

最大值:65535

to_port

Integer

結(jié)束端口。

最小值:1

最大值:65535

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

listener

ListenerDetail object

監(jiān)聽器實(shí)例。

request_id

String

請求ID。

表7 ListenerDetail

參數(shù)

參數(shù)類型

描述

id

String

監(jiān)聽器ID。

name

String

監(jiān)聽器名稱,取值范圍:1~64個字符之間,只能由數(shù)字、字母、中劃線和中文組成。

最小長度:1

最大長度:64

description

String

監(jiān)聽器的描述信息,取值范圍:0~255個字符之間,禁止輸入字符:<>。

最小長度:0

最大長度:255

protocol

String

監(jiān)聽的網(wǎng)絡(luò)傳輸協(xié)議類型。

枚舉值:

  • TCP

  • UDP

status

String

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

  • ACTIVE:運(yùn)行中

  • PENDING:待定

  • ERROR:錯誤

  • DELETING:正在刪除

枚舉值:

  • ACTIVE

  • PENDING

  • ERROR

  • DELETING

port_ranges

Array of PortRange objects

監(jiān)聽端口范圍列表。

數(shù)組長度:1 - 10

client_affinity

String

客戶端親和性,取值:

  • SOURCE_IP:按源IP保持會話。

  • NONE:關(guān)閉。

枚舉值:

  • SOURCE_IP

  • NONE

accelerator_id

String

全球加速 實(shí)例ID。

created_at

String

創(chuàng)建時間。

updated_at

String

更新時間。

domain_id

String

租戶ID。

frozen_info

FrozenInfo object

云服務(wù)或資源實(shí)例凍結(jié)信息。

tags

Array of ResourceTag objects

標(biāo)簽列表。

表8 PortRange

參數(shù)

參數(shù)類型

描述

from_port

Integer

起始端口。

最小值:1

最大值:65535

to_port

Integer

結(jié)束端口。

最小值:1

最大值:65535

表9 FrozenInfo

參數(shù)

參數(shù)類型

描述

status

Integer

云服務(wù)或資源實(shí)例狀態(tài),取值:

  • 0:解凍/正常(云服務(wù)恢復(fù)正常)。

  • 1:凍結(jié)(資源和數(shù)據(jù)會保留,但租戶無法再正常使用云服務(wù))。

  • 2:刪除/終止(資源和數(shù)據(jù)將清除)。

最小值:0

最大值:2

effect

Integer

在凍結(jié)/解凍操作下,取值:

  • 1(默認(rèn)值):凍結(jié)可釋放。

  • 2:凍結(jié)不可釋放。

  • 3:凍結(jié)后不可續(xù)費(fèi)。

最小值:1

最大值:3

缺省值:1

scene

Array of strings

更新云服務(wù)狀態(tài)的業(yè)務(wù)場景列表,取值:

  • ARREAR(默認(rèn)值):欠費(fèi)場景。為正常的運(yùn)營業(yè)務(wù)場景,包括包周期資源到期、按需資源扣費(fèi)失敗。

  • POLICE:公安凍結(jié)場景。

  • ILLEGAL:違規(guī)凍結(jié)場景。

  • VERIFY:客戶未實(shí)名認(rèn)證凍結(jié)場景。

  • PARTNER:合作伙伴凍結(jié)(合作伙伴凍結(jié)子客戶資源)。

最大長度:16

表10 ResourceTag

參數(shù)

參數(shù)類型

描述

key

String

標(biāo)簽鍵,規(guī)則:

  • 1.key不能為空,長度1~128個字符(中文也可以輸入128個字符)。

  • 2.可用 UTF-8 格式表示的字母(包含中文)、數(shù)字和空格,以及以下字符_ . : = + - @。

  • 3._sys_開頭屬于系統(tǒng)標(biāo)簽,租戶不能輸入。

最小長度:1

最大長度:128

value

String

標(biāo)簽值,規(guī)則:

  • 1.長度0~255個字符(中文也可以輸入255個字符)。

  • 2.可用 UTF-8 格式表示的字母(包含中文)、數(shù)字和空格,以及以下字符_ . : / = + - @。

  • 3.資源標(biāo)簽值可以為空(empty or null)。

最小長度:0

最大長度:255

請求示例

更新監(jiān)聽器,修改起始端口為5000,結(jié)束端口為5200,按源IP保持會話,并更新名稱和描述信息。

PUT https://{ga_endpoint}/v1/listeners/1b11747a-b139-492f-9692-2df0b1c87193

{
  "listener" : {
    "name" : "listenerNameNew",
    "description" : "listener description new",
    "port_ranges" : [ {
      "from_port" : 5000,
      "to_port" : 5200
    } ],
    "client_affinity" : "SOURCE_IP"
  }
}

響應(yīng)示例

狀態(tài)碼: 200

操作成功

{
  "listener" : {
    "id" : "1b11747a-b139-492f-9692-2df0b1c87193",
    "name" : "listenerNameNew",
    "description" : "listener description new",
    "protocol" : "TCP",
    "status" : "ACTIVE",
    "port_ranges" : [ {
      "from_port" : 5000,
      "to_port" : 5200
    } ],
    "client_affinity" : "SOURCE_IP",
    "accelerator_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    },
    "tags" : [ {
      "key" : "tagKey",
      "value" : "tagValue"
    } ]
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

狀態(tài)碼

狀態(tài)碼

描述

200

操作成功

錯誤碼

請參見錯誤碼。