修改负载均衡实例信息--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

修改负载均衡实例信息

最近更新时间：2024.07.18 11:03:32首次发布时间：2024.07.02 10:22:47

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

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=EditLB7&Version=2021-04-30

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`EditLB7`	接口名称。当前 API 的名称为 `EditLB7`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数类型是否必选示例值描述

lb7_identity String 是 veew-lb72131011027612112**** 负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。

参数	类型	是否必选	示例值	描述
lb7_identity	String	是	`veew-lb72131011027612112****`	负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。
name	String	是	`new-name`	负载均衡实例的名称。命名规则如下：允许 5~20 个字符。支持汉字、英文大小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
desc	String	否	`new desc`	负载均衡实例的描述。最多可输入 80 个字符。注意如果不指定该参数或参数值为空字符串，已有的描述被置为空。

name

String

是

new-name

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

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

desc

String

否

new desc

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

注意

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

返回参数

该接口无特有的返回参数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=EditLB7&Version=2021-04-30
{
    "lb7_identity": "veew-lb72131011027612112****",
    "name": "new-name",
    "desc": "new desc"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240617101834A2F4A31713545647****",
        "Action": "EditLB7",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

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