设置弹性公网 IP 的共享带宽峰值--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

设置弹性公网 IP 的共享带宽峰值

最近更新时间：2024.07.08 16:21:04首次发布时间：2023.03.24 15:51:07

本接口用于设置弹性公网 IP 的共享带宽峰值。共享带宽峰值指的是绑定在边缘实例私网 IP 地址（含主私网 IP 地址和辅助私网 IP 地址）上的所有弹性公网 IP 的共享公网带宽限速值。

使用说明

注意事项：
将弹性公网 IP 绑定到边缘实例的私网 IP 地址并为其设置共享带宽峰值后，弹性公网 IP 本身的带宽峰值将不生效。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
instance_identity	String	是	veen1020125208252511****	边缘实例 ID。您可以通过 ListInstances 接口查询边缘实例 ID。
bound_eip_share_bandwidth_peak	String	是	200	弹性公网 IP 的共享带宽峰值。取值范围与弹性公网 IP 绑定的边缘实例的公网带宽峰值的范围一致。取值须是 5 的倍数。单位：Mbps。

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action=SetBoundEipShareBandwidthPeak&Version=2021-04-30
&<其他公共参数>
{
    "instance_identity": "veen2111270501017515****",
    "bound_eip_share_bandwidth_peak": "200"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230531174824752AED914E6749B1****",
        "Action": "SetBoundEipShareBandwidthPeak",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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