更新负载均衡监听的属性。
接口说明
UpdateListenerAttribute 接口属于异步接口,即系统返回一个请求 ID,但该监听的配置尚未更新成功,系统后台的更新任务仍在进行。您可以调用 GetListenerAttribute 查询监听的配置的更新状态:
- 当监听器处于 Configuring 状态时,表示监听的配置正在更新中。
- 当监听器处于 Running 状态时,表示监听的配置更新成功。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
gwlb:UpdateListenerAttribute | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ListenerId | string | 是 | 监听 ID。 | lsn-lxce8iqbof2vl0**** |
ListenerDescription | string | 否 | 自定义监听描述。 长度限制为 2~256 个字符,支持中文和英文字母,可包含数字、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。 | listener_description |
ServerGroupId | string | 否 | 服务器组 ID。 | sgp-sp8d2r6y7t0xtl**** |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。 | 123e4567-e89b-12d3-a456-42665544**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | 资源%s业务状态%s不支持当前操作 |
400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | 资源%s当前状态%s不支持操作 |
400 | IncorrectStatus.Listener | The status of %s [%s] is incorrect. | 资源%s当前状态%s不支持操作。 |
400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | 两个资源的VPC ID不匹配 |
400 | ResourceInUse.IP | The specified resource of IP is in use. | 指定的IP地址已被使用 |
400 | IncorrectStatus.ServerGroup | The status of %s [%s] is incorrect. | 资源%s当前状态%s不支持操作 |
404 | ResourceNotFound.LoadBalancer | The specified resource of %s is not found. | 指定的负载均衡资源不存在 |
404 | ResourceNotFound.Listener | The specified resource of %s is not found. | 指定的监听资源不存在 |
404 | ResourceNotFound.ServerGroup | The specified resource of %s is not found. | 指定的服务器组资源不存在。 |
访问错误中心查看更多错误码。