全部产品
Search
文档中心

负载均衡:UpdateLoadBalancerAttribute - 更新负载均衡实例属性

更新时间:Nov 11, 2024

更新负载均衡实例属性。

接口说明

  • UpdateLoadBalancerAttribute 属于异步接口,即系统返回一个请求 ID,但该实例属性尚未修改成功,系统后台的变更任务仍在进行。您可以调用 GetLoadBalancerAttribute 查询网关型负载均衡实例的更新状态:
    • 当网关型负载均衡实例处于 Configuring 状态时,表示网关型负载均衡实例正在更新中。
    • 当网关型负载均衡实例处于 Active 状态时,表示网关型负载均衡实例更新成功。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
LoadBalancerIdstring

网关型负载均衡实例的 ID。

gwlb-9njtjmqt7zfcqm****
LoadBalancerNamestring

网关型负载均衡实例名称。

长度为 2~128 个英文或中文字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

testGwlbName
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会更新实例属性。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring

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

由客户端生成该参数值,要保证在不同请求间唯一。ClientToken 只支持 ASCII 字符。

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B956C629-0E8C-5EFF-BAC1-B0E3A8C5CBDD

示例

正常返回示例

JSON格式

{
  "RequestId": "B956C629-0E8C-5EFF-BAC1-B0E3A8C5CBDD"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectBusinessStatus.LoadBalancerThe business status of %s [%s] is incorrect.资源%s业务状态%s不支持当前操作
400IncorrectStatus.LoadBalancerThe status of %s [%s] is incorrect.资源%s当前状态%s不支持操作
400ResourceNotFound.LoadBalancerThe specified resource of %s is not found.指定的负载均衡资源不存在

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