修改弹性公网IP带宽--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

修改弹性公网IP带宽

最近更新时间：2024.08.05 11:41:58首次发布时间：2023.07.03 16:32:45

本接口用于修改弹性公网 IP 的带宽峰值。

使用说明

使用限制：

对于未绑定资源的弹性公网 IP：修改后的带宽峰值只有在弹性公网 IP 绑定资源后才会生效。此处的资源指的是任何可绑定弹性公网 IP 的资源。
对于已绑定资源的弹性公网 IP：修改后的带宽峰值会立即生效。此处的资源仅指边缘实例、四层负载均衡实例和七层负载均衡实例。如果弹性公网 IP 绑定了其他类型的资源，修改带宽峰值的操作不生效。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	SetEIPInstanceBandwidthPeak	公共参数。该参数表示接口名称。取值：SetEIPInstanceBandwidthPeak。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

参数	类型	是否必选	示例值	描述
eip_identity	String	是	eip-wqjgxf****	弹性公网 IP 的 ID。您可以通过 ListEIPInstances 接口查询弹性公网 IP 的 ID。
bandwidth_peak	Integer	是	200	带宽峰值。取值范围：20 ~ 5000。单位：Mbps。取值只能是 5 的倍数。

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action=SetEIPInstanceBandwidthPeak&Version=2021-04-30
&<其他公共参数>
{
  "eip_identity":"eip-wqjgxf****",
  "bandwidth_peak": 200,
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230621104139240AAA76E8AFE544****",
        "Action": "SetEIPInstanceBandwidthPeak",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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