You need to enable JavaScript to run this app.
导航
修改负载均衡实例信息
最近更新时间:2024.06.21 11:21:58首次发布时间:2022.02.25 18:58:32

本接口用于修改负载均衡实例的名称或描述。

请求方法

POST

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

名称

类型

是否必选

示例值

描述

Action

String

EditLB

公共参数。该参数表示接口名称。取值:EditLB。

Version

String

2021-04-30

公共参数。该参数表示接口版本。取值:2021-04-30。

lb_identity

String

veew-lb2131011027612112****

负载均衡实例的 ID。您可以通过 ListLBs 接口查询负载均衡实例的 ID。

name

String

new-name

负载均衡实例的名称。命名规则如下:

  • 允许 5~20 个字符。
  • 支持中文、大写字母、小写字母、数字。
  • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
  • 不能包含双引号(")、反斜线( \)和 空格,且不能以正斜线(/)开头。

如果不指定该参数或参数值为空字符串,系统将保留原来的名称。

desc

String

new desc

负载均衡实例的描述。最多可输入 256 个字符。

注意

如果不指定该参数或参数值为空字符串,已有的描述被置为空。

返回数据


请求示例

POST https://veenedge.volcengineapi.com/?Action=EditLB&Version=2021-04-30
&<其他公共参数>
{
  "lb_identity": "veew-lb2131011027612112****",
  "name": "new-name"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230530185455B87D31D45F57F8E0****",
        "Action": "EditLB",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码