备案控制台
文档
产品文档
输入文档关键字查找
首页 全球加速 开发参考 API参考 API目录 监听 UpdateListener - 修改监听

UpdateListener - 修改监听

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

修改全球加速实例下指定监听的配置。

接口说明

本接口用于修改指定监听的协议、端口等信息，使监听配置满足您的业务需求。

在调用本接口时，请注意以下事项：

  • UpdateListener 接口属于异步接口，即系统会先返回一个请求 ID，但监听配置并未修改完成，系统后台的修改任务仍在进行。您可以调用 DescribeListener 查询监听的状态：
    • 当监听处于 updating 状态时，表示监听配置正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。
    • 当监听处于 active 状态时，表示监听配置修改完成。
  • UpdateListener 接口不支持在同一个全球加速实例内并发修改监听配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
ga:UpdateListenerWrite
  • Listener
    acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}
    无
无

请求参数

名称类型必填描述示例值
RegionIdstring否

全球加速实例所在的地域 ID，仅取值cn-hangzhou。

cn-hangzhou
ClientTokenstring否

客户端 Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-426655440000
Namestring否

监听的名称。

名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。

Listener
Descriptionstring否

监听的描述信息。 描述长度最大为 200 个字符。

Listener
ClientAffinitystring否

客户端亲和性。

  • 不传入值时，不保持客户端亲和性，即不能确保来自同一客户端的连接请求始终定向到同一终端节点。

  • 取值为SOURCE_IP时，保持客户端亲和性。即客户端访问有状态的应用程序时，可以将来自同一客户端的所有请求都定向到同一终端节点，而不考虑源端口和协议。

SOURCE_IP
Protocolstring否

监听的网络传输协议类型，取值：

  • tcp：TCP 协议。

  • udp：UDP 协议。

  • http：HTTP 协议。

  • https：HTTPS 协议。

tcp
ListenerIdstring是

监听实例 ID。

lsr-bp1bpn0kn908w4nbw****
ProxyProtocolstring否

是否开启保持客户端源 IP 功能。

  • true：开启保持客户端源 IP 功能。开启后，支持后端服务查看客户端的原始 IP 地址。

  • false（默认值）：不开启保持客户端源 IP 功能。

说明 该参数后续将不在监听 API 中配置，建议在终端节点组的相关 API 中进行配置。关于 ProxyProtocol，请参见 CreateEndpointGroup 和 UpdateEndpointGroup 。
false
PortRangesobject []否

用来接收请求并向终端节点进行转发的端口范围。

可配置的监听端口范围为 1~65499。

最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见监听端口。

FromPortinteger是

用来接收请求并向终端节点进行转发的起始监听端口。

可配置的监听端口范围为 1~65499，且需满足 FromPort≤ToPort。

最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见监听端口。

说明 对于 HTTP 或 HTTPS 协议的监听，只支持配置一个监听端口，即起始监听端口和结束监听端口需相同。
20
ToPortinteger是

用来接收请求并向终端节点进行转发的结束监听端口。

可配置的监听端口范围为 1~65499，且需满足 FromPort≤ToPort。

最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见监听端口。

说明 对于 HTTP 或 HTTPS 协议的监听，只支持配置一个监听端口，即起始监听端口和结束监听端口需相同。
21
Certificatesobject []否

SSL 证书。

Idstring否

SSL 证书 ID。

说明 仅 HTTPS 协议的监听需要配置该项。
449****-cn-hangzhou
BackendPortsobject []否

后端服务器接收请求的端口范围。

FromPortinteger否

后端服务器接收请求的起始端口。

说明 当您的监听协议为 HTTP 或 HTTPS，且监听的端口和后端服务器提供服务的端口不一致时才需填写该项。其中，后端服务器接收请求的起始端口和结束端口需相同。
80
ToPortinteger否

后端服务器接收请求的结束端口。

说明 当您的监听协议为 HTTP 或 HTTPS，且监听的端口和后端服务器提供服务的端口不一致时才需填写该项。其中，后端服务器接收请求的起始端口和结束端口需相同。
80
XForwardedForConfigobject否

XForward字段配置信息。

XForwardedForGaIdEnabledboolean否

是否通过GA-ID头字段获取全球加速实例 ID。取值：

  • true：是。

  • false（默认值）：否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
XForwardedForProtoEnabledboolean否

是否通过GA-X-Forward-Proto字段获取全球加速实例的监听协议。取值：

  • true：是。

  • false（默认值）：否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
XForwardedForPortEnabledboolean否

是否通过GA-X-Forward-Port字段获取全球加速实例的监听端口。取值：

  • true：是。

  • false（默认值）：否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
XRealIpEnabledboolean否

是否通过X-Real-IP字段获取真实的客户端 IP。取值：

  • true：是。

  • false（默认值）：否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
XForwardedForGaApEnabledboolean否

是否通过GA-AP字段获取加速地域信息。取值：

  • true：是。

  • false（默认值）：否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
SecurityPolicyIdstring否

安全策略实例 ID。取值：

  • tls_cipher_policy_1_0

    • 支持的 TLS 版本：TLSv1.0、TLSv1.1 和 TLSv1.2。

    • 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。

  • tls_cipher_policy_1_1

    • 支持的 TLS 版本： TLSv1.1 和 TLSv1.2。

    • 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。

  • tls_cipher_policy_1_2

    • 支持的 TLS 版本：TLSv1.2。

    • 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。

  • tls_cipher_policy_1_2_strict

    • 支持的 TLS 版本：TLSv1.2。

    • 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA 和 ECDHE-RSA-AES256-SHA。

  • tls_cipher_policy_1_2_strict_with_1_3

    • 支持的 TLS 版本：TLSv1.2 及 TLSv1.3。

    • 支持的加密算法套件：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。

说明 仅 HTTPS 监听支持此参数。
tls_cipher_policy_1_0
IdleTimeoutinteger否

连接空闲超时时间。单位：秒。

  • TCP：10-900s，默认 900s
  • UDP：10-20s ，默认 20s
  • HTTP/HTTPS：1-60 秒，默认 15s
900
RequestTimeoutinteger否

HTTP/HTTPS 的连接请求超时时间。单位：秒。

可选：1-180s，默认 60s。

说明 仅对 Protocol（网络传输协议类型）为 HTTP 或 HTTPS 的监听有效。如果在超时时间内后端服务器一直没有响应，全球加速将放弃等待，并给客户端返回 HTTP 504 错误码。
60
HttpVersionstring否

HTTP 协议的最大版本，取值：

  • http3：HTTP/3。
  • http2：HTTP/2。
  • http1.1：HTTP/1.1。
说明 仅 HTTPS 监听支持此参数。
http2

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

6FEA0CF3-D3B9-43E5-A304-D217037876A8

示例

正常返回示例

JSON格式

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

错误码

HTTP status code错误码错误信息描述
400NotActive.ListenerThe state of the listener is not active.监听器状态非稳态
400PortRangeIllegal.ListenerThe specified listener port range is invalid.监听端口范围配置非法
400PortConflict.ListenerThe listener port configuration is in conflict.监听端口配置冲突
400QuotaExceeded.ListenerPortThe maximum number of listener ports is exceeded.监听端口达到Quota限制
400NotExist.AcceleratorThe accelerated instance does not exist.加速实例不存在。
400StateError.AcceleratorThe state of the accelerated instance is invalid.加速实例状态非法。
400Exist.PortOverridePort override exists.端口映射已存在。
400RegionNotSupportHugePort.ListenerThe current ipSet or listener region does not support hugePort.-
400PortRanges.MustOneThe portRanges must be one for HTTPS and HTTP type listener.HTTPS/HTTP类型监听只支持一个端口
400SecurityPolicyIdIllegal.ListenerThe listener security policy ID %s is illegal.监听安全策略ID不合法。
400SecurityPolicyId.NotNeedNo security policy ID is required for the listener.当前监听不需要配置安全策略ID。
403Forbbiden.SubUserYou are not authorized to operate on the specified resource because your account was created by another user.该账号为其他账号的子账号，没有操作特定资源的权限。
403ForbiddenThe user is not authorized to operate on the specified resource.该账号没有操作特定资源的权限。
500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.处理请求时出现错误，请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
    删除错误码：403
    删除错误码：500
入参OpenAPI 入参发生变更。
    新增入参：HttpVersion
2023-11-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
    删除错误码：403
    删除错误码：500
入参OpenAPI 入参发生变更。
    新增入参：IdleTimeout
    新增入参：RequestTimeout
文档推荐
  • 本页导读 （1）
文档反馈