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

更新负载均衡实例属性,如名称、修改保护等。

接口说明

UpdateLoadBalancerAttribute 接口属于异步接口,即系统返回一个请求 ID,但该应用型负载均衡实例属性尚未修改成功,系统后台的修改任务仍在进行。您可以调用 GetLoadBalancerAttribute 查询应用型负载均衡实例属性的修改状态:

  • 当应用型负载均衡实例属性处于 Configuring 状态时,表示应用型负载均衡实例属性正在修改中。

  • 当应用型负载均衡实例属性处于 Active 状态时,表示应用型负载均衡实例属性修改成功。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alb:UpdateLoadBalancerAttribute

update

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

请求参数

名称

类型

必填

描述

示例值

ClientToken

string

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

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

说明

若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。

5A2CFF0E-5718-45B5-9D4D-70B3FF3898

DryRun

boolean

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

  • true:发送检查请求,不会修改应用型负载均衡实例的属性。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回HTTP_2xx状态码并直接进行操作。

true

LoadBalancerId

string

应用型负载均衡实例 ID。

alb-o9ulmq5hgn68jk****

LoadBalancerName

string

应用型负载均衡实例的名称,长度为 2~128 个英文或中文字符,必须以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

alb-instance-test

ModificationProtectionConfig

object

修改保护配置。

Reason

string

开启修改保护配置的原因。

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

仅在 StatusConsoleProtection 时有效且合法。

Managed Instance

Status

string

应用型负载均衡实例的修改保护状态。取值:

  • NonProtection:不开启修改保护。如有配置 ReasonReason 会被强制置空。

  • ConsoleProtection:开启控制台修改保护。如有配置 ReasonReason 可生效。

说明

当取值为 ConsoleProtection,即开启修改保护后,用户不能通过负载均衡控制台修改实例配置,但可以通过调用 API 修改实例配置。

ConsoleProtection

返回参数

名称

类型

描述

示例值

object

更新负责均衡实例属性。

JobId

string

同步任务 ID。

72dcd26b-f12d-4c27-b3af-18f6aed5****

RequestId

string

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

示例

正常返回示例

JSON格式

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

错误码

HTTP status code

错误码

错误信息

描述

400 IncorrectStatus.LoadBalancer The status of %s [%s] is incorrect. 实例的当前状态不支持本次操作。
400 IncorrectBusinessStatus.LoadBalancer The business status of %s [%s]  is incorrect. 资源%s [%s]的业务状态无效。
403 Forbidden.LoadBalancer Authentication is failed for %s. 负载均衡操作鉴权失败。
404 ResourceNotFound.LoadBalancer The specified resource %s is not found. 资源%s不存在。

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

变更历史

更多信息,参考变更详情