更新网络型负载均衡监听的配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
nlb:UpdateListenerAttribute | Write |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ListenerId | string | 是 |
监听实例ID。 |
lsn-bp1bpn0kn908w4nbw**** |
ListenerDescription | string | 否 |
自定义监听名称。 长度限制为2~256个字符,支持中文和英文字母,可包含数字、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。 |
tcpssl_443 |
ServerGroupId | string | 否 |
服务器组ID。 |
sgp-ppdpc14gdm3x4o**** |
SecurityPolicyId | string | 否 |
安全策略ID。 说明 | tls_cipher_policy_1_1 |
CertificateIds | array | 否 | 服务器证书列表信息。目前仅支持添加1个服务器证书。 说明 | |
string | 否 | 服务器证书列表信息。目前仅支持添加1个服务器证书。 说明 | 12315790212_166f8204689_1714763408_70998**** | |
CaCertificateIds | array | 否 | CA证书列表信息。目前仅支持添加1个CA证书。 说明 | |
string | 否 | CA证书列表信息。目前仅支持添加1个CA证书。 说明 | 139a00604ad-cn-east-hangzh**** | |
CaEnabled | boolean | 否 | 是否启动双向认证。取值:
|
false |
IdleTimeout | integer | 否 |
连接空闲超时时间。单位:秒。取值范围:1~900。 |
900 |
DryRun | boolean | 否 |
是否只预检此次请求。取值:
|
false |
ClientToken | string | 否 |
客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明 | 123e4567-e89b-12d3-a456-426655440000 |
RegionId | string | 否 | 网络型负载均衡实例所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 |
cn-hangzhou |
ProxyProtocolEnabled | boolean | 否 |
是否开启通过Proxy Protocol协议携带客户端源地址到后端服务器。取值:
|
false |
SecSensorEnabled | boolean | 否 |
是否开启秒级监控功能。取值:
|
false |
AlpnEnabled | boolean | 否 |
是否开启ALPN。取值:
|
false |
AlpnPolicy | string | 否 |
ALPN策略。取值:
说明 | HTTP1Only |
Cps | integer | 否 | 网络型负载均衡实例每秒新建连接限速值。取值范围:0~1000000。0表示不限速。 |
10000 |
Mss | integer | 否 |
TCP报文的最大段大小。单位:字节,取值范围:0~1500。0表示不修改用户TCP报文的MSS值。仅TCP、TCPSSL类型的监听支持该字段值。 |
344 |
ProxyProtocolV2Config | object | 否 |
通过Proxy Protocol协议携带VpcId、PrivateLinkEpId、PrivateLinkEpsId信息到后端服务器配置。 |
|
Ppv2VpcIdEnabled | boolean | 否 |
是否开启通过Proxy Protocol协议携带VpcId到后端服务器。取值:
|
false |
Ppv2PrivateLinkEpIdEnabled | boolean | 否 |
是否开启通过Proxy Protocol协议携带PrivateLinkEpId到后端服务器。取值:
|
false |
Ppv2PrivateLinkEpsIdEnabled | boolean | 否 |
是否开启通过Proxy Protocol协议携带PrivateLinkEpsId到后端服务器。取值:
|
false |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
更新监听配置。 |
||
RequestId | string |
请求ID。 |
CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |
JobId | string |
异步任务ID。 |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
示例
正常返回示例
JSON
格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Mismatch.VpcId | The VpcId is mismatched for %s and %s. | 资源%s和资源%s的VpcId不匹配。请检查两种资源是否在同一个VPC下。 |
400 | Conflict.Port | The Port [%s] is conflict. | 指定的资源当前存在锁冲突。 |
400 | ResourceNotFound.Certificate | The specified resource %s is not found. | 资源%s不存在。 |
403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因为账号没有权限,所以鉴权失败。 |
404 | ResourceNotFound.listener | The specified resource %s is not found. | 资源%s不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-11-27 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
2023-09-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
2023-09-05 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
2023-04-04 | API 内部配置变更,不影响调用 | 看变更集 | ||||||||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/168357.html