You need to enable JavaScript to run this app.
导航

ModifyLoadBalancerAttributes

最近更新时间2024.02.29 14:48:16

首次发布时间2022.05.20 21:30:28

API 说明

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

使用限制

节流限制:每秒最多提交 40 个 API 请求。

快速调试

URI 参数

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

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

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

请求正文

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

参数类型是否必选参数说明示例
LoadBalancerIdString
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

响应正文

参数类型参数说明示例值
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

错误码

错误信息

错误描述

400InvalidLoadBalancerName.MalformedThe specified LoadBalancerName is malformed.指定的 LoadBalancerName 参数格式不合法。
400InvalidDescription.MalformedThe 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 实例不存在。