ModifyLoadBalancerAttributes--应用型负载均衡-火山引擎

文档中心

立即注册

导航

ModifyLoadBalancerAttributes

最近更新时间：2024.10.11 18:10:07首次发布时间：2022.05.20 21:30:28

请求说明

API 名称：ModifyLoadBalancerAttributes
API 域名：open.volcengineapi.com 。
API 描述：修改指定 ALB 实例。

使用限制

节流限制：每秒最多提交 10 个 API 请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称	类型	是否必选	格式	说明
Action	string	是	[a-zA-Z]+	API 名称，如 ModifyLoadBalancerAttributes 。
Version	string	是	YYYY-MM-DD	API 版本信息。该参数的取值是 2020-04-01 。
X-Expires	int	否	900	表示签名的有效时间，单位是秒，默认值是900。

请求参数

在使用该 API 提交请求时，请求参数中可以包含的参数如下。

参数	类型	是否必选	参数说明	示例
LoadBalancerId	String	是	ALB 实例ID。	alb-bp1b6c719dfa08ex****
LoadBalancerName	String	否	ALB 实例的名称。不能以http://或https://开头。必须以字母或中文开头，可包含数字、点号（.）、下划线（_）和短横线（-）。长度限制为1 ～ 128个字符。	alb-test1
Description	String	否	ALB 实例的描述。不能以http://或https://开头。必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为1 ～ 255个字符。	This is an ALB instance
DeleteProtection	String	否	ALB 删除保护功能。 off：关闭删除保护功能 on：开启删除保护功能。	off
WafProtectionEnabled	String	否	WAF 安全防护开关。 off：关闭 WAF 安全防护功能。 on：开启 WAF 安全防护功能。	off
WafInstanceId	String	否	ALB 实例绑定的 WAF 安全防护实例 ID。	waf-14ca6f67c33c09****
WafProtectedDomain	String	否	WAF 安全防护域名。当 WafProtectionEnabled 为 on 时，该参数可选，当 WafProtectionEnabled 为 off 时，该参数无效。支持精确域名和泛域名。	www.test.com
GlobalAccelerator.AcceleratorId	String	否	全球加速器的 ID。	accinstance-VYjG****
GlobalAccelerator.AcceleratorListenerId	String	否	全球加速器监听器的 ID。	listener-rrhN7WbeeYo****
GlobalAccelerator.EndpointGroupId	String	否	终端节点组的 ID。	endpointgroup-NoT****
GlobalAccelerator.Weight	Integer	否	终端节点的流量分配权重。取值范围为：1 - 100。	100

返回参数

参数	类型	参数说明	示例值
RequestId	String	请求ID。	20210811152539010225146063030****

示例

请求示例

GET /?Action=ModifyLoadBalancerAttributes&Version=2020-04-01&Description=test&LoadBalancerId=alb-bp1b6c719dfa08ex****&LoadBalancerName=lb1 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Action": "ModifyLoadBalancerAttributes",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210816110638****2514606306AF947C",
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code	错误码	错误信息	错误描述
400	InvalidLoadBalancerName.Malformed	The specified LoadBalancerName is malformed.	指定的 LoadBalancerName 参数格式不合法。
400	InvalidDescription.Malformed	The specified Description is malformed.	指定的 Description 参数格式不合法。
400	InvalidDeleteProtection.Malformed	The specified DeleteProtection is malformed.	指定的 DeleteProtection 参数格式不合法。
400	InvalidLoadBalancer.InvalidStatus	The specified LoadBalancer is not in the correct status for the request.	指定的 ALB 实例所处状态无法响应该请求。
404	InvalidLoadBalancer.NotFound	The specified LoadBalancer does not exist.	指定的 ALB 实例不存在。
400	InvalidWafProtectionEnabled.Malformed	The specified WafProtectionEnabled is malformed.	指定的 WafProtectionEnabled 参数格式不合法。
400	InvalidWafInstanceId.Malformed	The specified WafInstanceId is malformed.	指定的 WafInstanceId 参数格式不合法。
400	InvalidWafProtectedDomain.Malformed	The specified WafProtectedDomain is malformed.	指定的 WafProtectedDomain 参数格式不合法。
409	InvalidWafProtectedDomain.Conflict	The specified WafProtectedDomain already exists.	指定的 WAF 防护域名已存在。
400	LimitExceed.WafProtectedDomain	You've reached the limit on the number of domain you can associate with the waf instance.	已达到单个 WAF 实例可添加的防护域名数量上限。
400	OperationFailed.QueryWafService	The request on the specified resource failed due to the query on WAF Service failed.	因请求 WAF 服务失败，对于该资源的操作请求失败。