UpdateListener_全球加速_API文档

2019-11-20

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ga:UpdateListener	Update	Listener acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}	无	无

请求参数

字段名称	字段详情
RegionIdstring	全球加速实例所在的地域 ID，仅取值cn-hangzhou。示例值:cn-hangzhou
ClientTokenstring	客户端 Token，用于保证请求的幂等性。展开详情示例值:123e4567-e89b-12d3-a456-426655440000
Namestring	监听的名称。展开详情示例值:Listener
Descriptionstring	监听的描述信息。展开详情示例值:Listener
ClientAffinitystring	客户端亲和性。取值：展开详情示例值:SOURCE_IP
Protocolstring	监听的网络传输协议类型，取值：展开详情示例值:tcp
ListenerIdstring	监听实例 ID。示例值:lsr-bp1bpn0kn908w4nbw****参考取值来源: ListListeners CreateListener AssociateAclsWithListener DissociateAclsFromListener
deprecatedProxyProtocolstring	是否开启保持客户端源 IP 功能。展开详情示例值:false
PortRangesarray<object>	用来接收请求并向终端节点进行转发的端口范围。展开详情子级条数 <= 100
Certificatesarray<object>	SSL 证书。子级条数 <= 10
BackendPortsarray<object>	后端服务器接收请求的端口范围。子级条数 <= 20
XForwardedForConfigobject	`XForward`字段配置信息。
SecurityPolicyIdstring	安全策略实例 ID。取值：展开详情示例值:tls_cipher_policy_1_0参考取值来源: ListSystemSecurityPolicies
IdleTimeoutinteger<int32>	连接空闲超时时间。单位：秒。展开详情示例值:900
RequestTimeoutinteger<int32>	HTTP/HTTPS 的连接请求超时时间。单位：秒。展开详情示例值:60
HttpVersionstring	HTTP 协议的最大版本，取值：展开详情示例值:http2

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:6FEA0CF3-D3B9-43E5-A304-D217037876A8

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	NotActive.Listener	The state of the listener is not active.	诊断
400	PortRangeIllegal.Listener	The specified listener port range is invalid.	诊断
400	PortConflict.Listener	The listener port configuration is in conflict.	诊断
400	QuotaExceeded.ListenerPort	The maximum number of listener ports is exceeded.	诊断
400	NotExist.Accelerator	The accelerated instance does not exist.	诊断
400	StateError.Accelerator	The state of the accelerated instance is invalid.	诊断
400	Exist.PortOverride	Port override exists.	诊断
400	RegionNotSupportHugePort.Listener	The current ipSet or listener region does not support hugePort.	诊断
400	PortRanges.MustOne	The portRanges must be one for HTTPS and HTTP type listener.	诊断
400	SecurityPolicyIdIllegal.Listener	The listener security policy ID %s is illegal.	诊断
400	SecurityPolicyId.NotNeed	No security policy ID is required for the listener.	诊断
403	Forbbiden.SubUser	You are not authorized to operate on the specified resource because your account was created by another user.	诊断
403	Forbidden	The user is not authorized to operate on the specified resource.	诊断
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-03-27	新增请求参数HttpVersion
	2023-11-06	新增请求参数IdleTimeout 新增请求参数RequestTimeout

相关示例

配置更新监听

配置更新监听

2022-12-26