更新监听器 - UpdateListener

功能介绍

更新监听器。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ga:listener:update
Write
listener *
g:ResourceTag/<tag-key>
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ga:listener:update	Write	listener *	g:ResourceTag/<tag-key>	-	-

URI

PUT /v1/listeners/{listener_id}

表1 路径参数
参数	是否必选	参数类型	描述
listener_id	是	String	监听器ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
listener	是	UpdateListenerOption object	更新监听器的详细信息。

表4 UpdateListenerOption
参数	是否必选	参数类型	描述
name	否	String	监听器名称，取值范围：1~64个字符之间，只能由数字、字母、中划线和中文组成。
description	否	String	监听器的描述信息，取值范围：0~255个字符之间，禁止输入字符：<>。
port_ranges	否	Array of PortRange objects	监听端口范围列表。
client_affinity	否	String	客户端亲和性，取值： SOURCE_IP：按源IP保持会话。 NONE：关闭。

表5 PortRange
参数	是否必选	参数类型	描述
from_port	是	Integer	起始端口。
to_port	是	Integer	结束端口。

响应参数

状态码：200

表6 响应Body参数
参数	参数类型	描述
listener	ListenerDetail object	监听器实例。
request_id	String	请求ID。

表7 ListenerDetail
参数	参数类型	描述
id	String	监听器ID。
name	String	监听器名称，取值范围：1~64个字符之间，只能由数字、字母、中划线和中文组成。
description	String	监听器的描述信息，取值范围：0~255个字符之间，禁止输入字符：<>。
protocol	String	监听的网络传输协议类型。取值范围：TCP、UDP
status	String	配置状态，取值： ACTIVE：运行中 PENDING：待定 ERROR：错误 DELETING：正在删除
port_ranges	Array of PortRange objects	监听端口范围列表。
client_affinity	String	客户端亲和性，取值： SOURCE_IP：按源IP保持会话。 NONE：关闭。
accelerator_id	String	全球加速实例ID。
created_at	String	创建时间。
updated_at	String	更新时间。
domain_id	String	租户ID。
frozen_info	FrozenInfo object	云服务或资源实例冻结信息。
tags	Array of ResourceTag objects	标签列表。

表8 PortRange
参数	参数类型	描述
from_port	Integer	起始端口。
to_port	Integer	结束端口。

表9 FrozenInfo
参数	参数类型	描述
status	Integer	云服务或资源实例状态，取值： 0：解冻/正常（云服务恢复正常）。 1：冻结（资源和数据会保留，但租户无法再正常使用云服务）。 2：删除/终止（资源和数据将清除）。
effect	Integer	在冻结/解冻操作下，取值： 1（默认值）：冻结可释放。 2：冻结不可释放。 3：冻结后不可续费。
scene	Array of strings	更新云服务状态的业务场景列表，取值： ARREAR（默认值）：欠费场景。为正常的运营业务场景，包括包周期资源到期、按需资源扣费失败。 POLICE：公安冻结场景。 ILLEGAL：违规冻结场景。 VERIFY：客户未实名认证冻结场景。 PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。

**表10** ResourceTag
参数	参数类型	描述
key	String	标签键，取值范围： key不能为空，长度1~128个字符（中文也可以输入128个字符）。可用 UTF-8 格式表示的字母（包含中文）、数字和空格，以及以下字符_ . : =+ - @。 _sys_开头属于系统标签，租户不能输入。
value	String	标签值，取值范围：长度0~255个字符（中文也可以输入255个字符）。可用 UTF-8 格式表示的字母（包含中文）、数字和空格，以及以下字符_ . : / =+ - @。资源标签值可以为空（empty or null）。

请求示例

更新监听器，修改起始端口为5000，结束端口为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"
  }
}

响应示例

状态码：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"
}